.. java:import:: ru.bitec.gs.automation.client.ui AbstractForm.OpenType

Jexl
====

.. java:package:: ru.bitec.gs.automation.environment
   :noindex:

.. java:type:: public @interface Jexl

   .. versionadded:: 1.1.1

   Аннотация декларирует jexl-скрипт.

   .. seealso::

      | :java:ref:`AnnotatedTestEnvironment <ru.bitec.gs.automation.environment.AnnotatedTestEnvironment>`

Methods
-------

active
^^^^^^

.. java:method:: boolean active()
   :outertype: Jexl

   Признак выполнения скрипта. Если равен true -- то скрипт будет выполнен. Если false -- не будет.

   Значение по умолчанию: true

   :return: признак выполнения скрипта

file
^^^^

.. java:method:: String file()
   :outertype: Jexl

   Имя файла скрипта. Файл будет прочитан и его содержимое будет передано на сервер для выполнения.

   Если указано имя файла, то тело скрипта :java:ref:`script() <ru.bitec.gs.automation.environment.Jexl.script()>` должно быть пустым.

   :return: имя файла скрипта

form
^^^^

.. java:method:: String form()
   :outertype: Jexl

   Форма, в контексте которой нужно выполнить скрипт.

   Если имя не указано, то будет использоваться главная форма

   :return: имя формы

id
^^

.. java:method:: String id()
   :outertype: Jexl

   Вспомогательный атрибут аннотации. Позволяет задать уникальный идентификатор скрипта для внутренних нужд.

   Атрибут не обязательный. По умолчанию: пустая строка.

   :return: id скрипта

openType
^^^^^^^^

.. java:method:: AbstractForm.OpenType openType()
   :outertype: Jexl

   Тип открытия формы. По умолчанию тип открытия: :java:ref:`AbstractForm.OpenType.MDI <ru.bitec.gs.automation.client.ui.AbstractForm.OpenType.MDI>`

   :return: тип открытия формы

   .. seealso::

      | :java:ref:`AbstractForm.OpenType <ru.bitec.gs.automation.client.ui.AbstractForm.OpenType>`

order
^^^^^

.. java:method:: int order()
   :outertype: Jexl

   Порядок выполнения. Скрипты выполняются в порядке от меньшего значения к большему.

   Значение по умолчанию: 100

   :return: порядковый номер

script
^^^^^^

.. java:method:: String script()
   :outertype: Jexl

   Тело скрипта. Тело будет передано на сервер для выполнения.

   Если указано тело скрипта, то имя файла :java:ref:`file() <ru.bitec.gs.automation.environment.Jexl.file()>` должно быть пустым.

   :return: тело скрипта

selection
^^^^^^^^^

.. java:method:: String selection()
   :outertype: Jexl

   Название выборки, в контексте которой будет выполнен скрипт.

   Если имя не указано, то будет использоваться главная выборка формы.

   :return: имя выборки