Package ru.bitel.bgbilling.kernel.script.common.service

# Interface GlobalScriptService

public interface GlobalScriptService
Веб-сервис для работы с привязкой глобальных скриптов.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `deleteGlobalScriptLink(int id)`
  Удаляет привязку глобального скрипта по его коду.
  `String`
  `executeGlobalScript(int id)`
  Выполняет глобальный скрипт с указанным кодом привязки.
  `String`
  `executeGlobalScriptParams(int id, ParameterMap params)`
  Выполняет глобальный скрипт с указанным кодом привязки и параметрами, которые передаются в скрипт (можно получить в классе через getParams).
  `GlobalScriptLink`
  `getGlobalScriptLink(int id)`
  Возвращает привязку глобального скрипта по его коду.
  `List<GlobalScriptLink>`
  `getGlobalScriptLinkList()`
  Возвращает список всех привязок глобального скрипта.
  `List<GlobalScriptLog>`
  `getGlobalScriptLogList(Period period, String title, jakarta.xml.ws.Holder<Page> pageHolder)`
  Возвращает список логов глобальных скриптов за определенный период
  `String`
  `getInterfaceName()`
  Возвращает имя интерфейса, который должен имплементировать динамический класс глобального скрипта.
  `List<String>`
  `getScriptLogTitleList(Period period)`
  `String`
  `getSuperclassName()`
  Возвращает имя суперкласса, который может имплементировать динамический класс глобального скрипта.
  `void`
  `updateGlobalScriptLink(GlobalScriptLink link)`
  Изменяет привязку глобального скрипта.

- ## Method Details

  - ### updateGlobalScriptLink

    void updateGlobalScriptLink(GlobalScriptLink link) throws Exception
    Изменяет привязку глобального скрипта.
    Parameters:
      `link` - привязка глобального скрипта
    Throws:
      `BGException`
      `Exception`

  - ### getGlobalScriptLink

    GlobalScriptLink getGlobalScriptLink(int id) throws Exception
    Возвращает привязку глобального скрипта по его коду.
    Parameters:
      `id` - код привязки глобального скрипта
    Returns:
      привязка
    Throws:
      `BGException`
      `Exception`

  - ### getGlobalScriptLinkList

    List<GlobalScriptLink> getGlobalScriptLinkList() throws Exception
    Возвращает список всех привязок глобального скрипта.
    Returns:
    Throws:
      `BGException`
      `Exception`

  - ### deleteGlobalScriptLink

    void deleteGlobalScriptLink(int id) throws Exception
    Удаляет привязку глобального скрипта по его коду.
    Parameters:
      `id` - код привязки
    Throws:
      `BGException`
      `Exception`

  - ### executeGlobalScript

    String executeGlobalScript(int id) throws Exception
    Выполняет глобальный скрипт с указанным кодом привязки.
    Parameters:
      `id` - код привязки
    Returns:
      "вывод", полученный в результате работы глобального скрипта
    Throws:
      `BGException`
      `Exception`

  - ### executeGlobalScriptParams

    String executeGlobalScriptParams(int id, ParameterMap params) throws Exception
    Выполняет глобальный скрипт с указанным кодом привязки и параметрами, которые передаются в скрипт (можно получить в классе через getParams).
    Parameters:
      `id` - код привязки
      `params` - параметры
    Returns:
      "вывод", полученный в результате работы глобального скрипта
    Throws:
      `BGException`
      `Exception`

  - ### getInterfaceName

    String getInterfaceName()
    Возвращает имя интерфейса, который должен имплементировать динамический класс глобального скрипта.
    Returns:

  - ### getSuperclassName

    String getSuperclassName()
    Возвращает имя суперкласса, который может имплементировать динамический класс глобального скрипта.
    Returns:

  - ### getScriptLogTitleList

    List<String> getScriptLogTitleList(Period period) throws Exception
    Parameters:
      `period` - - период.
    Returns:
      - не повторяющийся список названий выполнившихся скриптов.
    Throws:
      `Exception`

  - ### getGlobalScriptLogList

    List<GlobalScriptLog> getGlobalScriptLogList(Period period, String title, jakarta.xml.ws.Holder<Page> pageHolder) throws Exception
    Возвращает список логов глобальных скриптов за определенный период
    Parameters:
      `period` - - за какой период.
      `title` - - если не равен null, то вернет логи с данным title.
      `pageHolder` - - передать null, если нужны все записи за данный период.
    Throws:
      `Exception`