Объекты ARTA Synergy
~~~~~~~~~~~~~~~~~~~~

Встроенный в java интерпретатор позволяет передавать Java
объекты JavaScript-у, поэтому в скрипте интерпретатора доступны следующие
объекты:

.. js:data:: platform

    Предоставляет доступ к некоторым функциям платформы.
    Список функций см. ниже.

    .. js:function:: getFormsManager()

        Получить объект доступа к данным формы

        :returns: :js:class:`FormsManager`

    .. js:function:: getCardsManager()

        Получить объект доступа к личным карточкам пользователей

        :returns: :js:class:`CardsManager`

.. js:data:: dataUUID

    Идентификатор данных формы, по которым запущен процесс

.. js:data:: documentID

    Идентификатор документа, по которому запущен процесс

.. js:data:: executionID

    Идентификатор данного процесса

.. js:data:: api_event

    Название блок.процесса

.. js:data:: login

    Логин пользователя, от имени которого выполняется данный скрипт
    (указывается в настройках скрипта)

.. js:data:: password

    Пароль пользователя, от имени которого выполняется данный скрипт
    (указывается в настройках скрипта)

.. js:data:: key

    Ключ пользователя, от имени которого выполняется данный скрипт
    (указывается в настройках скрипта)

.. js:data:: console

    Объект класса org.slf4j.Logger со всеми публичными методами.
    Название у логгера interpreter.${название скрипта}

.. js:data:: message

    Переменная, содержащая параметры события Synergy

.. hint:: Типовое начало скрипта выглядит так:

          .. code-block:: js

              var form = platform.getFormsManager().getFormData(dataUUID);
              form.load();

          Загружаем данные формы путем обращения к объектам
          :js:data:`platform` и :js:data:`dataUUID`


.. js:class:: FormsManager

    Объект доступа к данным формы

    .. js:function:: getFormData(dataUUID)

        Получить данные формы

        :param String dataUUID: идентификатор данных формы
        :returns:               :js:class:`FormData`

.. js:class:: CardsManager

    Объект доступа к личным карточкам пользователей

    .. js:function:: getUserCard(formID, userID)

        Получить личную карточку пользователя

        :param String formID:   идентификатор формы
        :param String userID:   идентификатор пользователя
        :returns:               :js:class:`FormData`

.. js:class:: FormData

    Объект данных формы

    .. js:function:: getValue(component_id)

        Получить значение компонента

        :param String component_id:   идентификатор компонента
        :returns:                     ``String``

    .. js:function:: getValue(table_id, component_id, row_number)

        Получить значение компонента

        :param String table_id:       идентификатор дин. таблицы
        :param String component_id:   идентификатор компонента
        :param String row_number:     номер строки дин. таблицы (начинается с нуля)
        :returns:                     ``String``

    .. js:function:: getNumericValue(component_id)

        Получить числовое значение компонента

        :param String component_id:   идентификатор компонента
        :returns:                     ``Number`` если значение компонента не
                                      приводится к числу - возвращает NaN

    .. js:function:: getNumericValue(table_id, component_id, row_number)

        Получить числовое значение компонента

        :param String table_id:       идентификатор дин. таблицы
        :param String component_id:   идентификатор компонента
        :param String row_number:     номер строки дин. таблицы (начинается с нуля)
        :returns:                     ``Number`` если значение компонента не
                                      приводится к числу - возвращает NaN

    .. js:function:: getRowsCount(table_id)

        Получить количество строк в динамической таблице

        :param String table_id:       идентификатор дин. таблицы
        :returns:                     ``Number``

    .. js:function:: load()

        Получить данные формы

    .. js:function:: save()

        Сохранить данные формы

    .. js:function:: setValue(component_id, value)

        Задать значение компонента

        :param String component_id:   идентификатор компонента
        :param String value:          значение компонента

    .. js:function:: setValue(table_id, component_id, row_number, value)

        Задать значение компонента в динамической таблице

        :param String table_id:       идентификатор дин. таблицы
        :param String component_id:   идентификатор компонента
        :param String row_number:     номер строки дин. таблицы (начинается с нуля)
        :param String value:          значение компонента