Функции, относящиеся к контексту

Функция

Описание

Тип результата

Серверная поддержка

Фронтенд-поддержка

available(String context [, String schema])

Возвращает true, если контекст с путем контекст существует и доступен вызывающему.

Boolean

Да

Да

callFunction(String context, String function, Object parameter1, Object parameter2, ...)

Вызывает функцию под названием функция контекста с путем контекст и возвращает ее выход. Ввод функции таблица данных строится из массива параметров (parameter1, parameter2, ...). Правила, используемые для заполнения таблицы данными, описаны здесь.

DataTable

Да

Да

callFunctionEx(String context, String function, DataTable parameters)

Аналогичный callFunction(...) вызывает функцию под названием функция контекстас путем контекст и возвращает ее результат. Параметры функции представлены таблицей данных.

DataTable

Да

Да

dc([String schema])

Возвращает путь контекста по умолчанию, определенный во время оценки выражения.

String

Да

Да

Другой способ получения пути контекста по умолчанию - это использование ссылки {.:}.

dr()

Возвращает строку по умолчанию, определенную во время оценки выражения.

Integer

Да

Да

dt()

Возвращает таблицу по умолчанию, определенную во время оценки выражения.

DataTable

Да

Да

Другой способ получения пути контекста по умолчанию - это использование ссылки {}.

eventAvailable(String context, String event [, String schema])

Возвращает true, если контекст с путем, определенный аргументом контекст, имеет переменную, определенную аргументом событие, и это событие доступно вызывающему.

Boolean

Да

Да

eventFormat(String context, String event [, String schema [, Boolean asTable]])

Возвращает строковое представление формата события или ноль, если контекст/событие недоступен или формат события динамический.

По умолчанию используется режим кодирования невидимых разграничителей для кодирования таблицы в виде строки. Чтобы вернуть результат в виде таблицы данных, задайте для asTable значение true.

Обратите внимание, что при вычесление выражений в редакторе выражений веб-интерфейса функция eventFormat должна вычисляться на сервере при использовании параметра asTable.

String

Да

Да

eventGroup(String context, String event [, String schema])

Возвращает имя группы, к которой принадлежит событие, или значение null, если оно не принадлежит ни одной группе.

String

Да

Нет

fireEvent(String context, String event, Integer level, Object parameter1, Object parameter2, ...)

Запускает событие под названием событие в контексте. Использует определенный уровень или уровень события по умолчанию, если параметр уровня - NULL. Коды уровня события описаны здесь.

Если предоставляется лишь один параметр типа Data Table, эта таблица будет использоваться в качестве таблицы данных. В ином случае Таблица данных, представляющая данные события, строится из массива параметров (parameter1, parameter2, ...). Правила, используемые для заполнения таблицы данными, описаны здесь.

Эта функция возвращает идентификатор сгенерированного события или ноль, если генерация событий блокируется системой.

Long

Да

Да

Функция fireEvent() сработает лишь в выражении, которое оценивается в AggreGate Server. Выражения, которые оцениваются в AggreGate Client или Agent, не вызовут генерирование событий сервера.

fullDescription(String context [, String delimiter])

Возвращает полное описание определенного контекста, т.e. описания всех родительских контекстов, разделенных        строкой-разделителем. Строка-разделитель по умолчанию "-".

String

Да

Да

functionAvailable(String context, String function [, String schema])

Возвращает true, если контекст с путем, указанным аргументом контекст, имеет функцию, определенную аргументом функция, и эта функция доступна для вызывающего.

Boolean

Да

Да

functionGroup(String context, String function[, String schema])

Возвращает имя группы, которой принадлежит функция, или значение null, если она не принадлежит ни одной группе.

String

Да

Нет

functionInputFormat(String context, String function [, String schema [, Boolean asTable]])

Возвращает строковое представление формата ввода функции или ноль, если контекст/функция недоступны или формат ввода функции динамический.

По умолчанию используется режим кодирования невидимых разграничителей для кодирования таблицы в виде строки. Чтобы вернуть результат в виде таблицы данных, задайте для asTable значение true.

Обратите внимание, что при вычесление выражений в редакторе выражений веб-интерфейса функция eventFormat должна вычисляться на сервере при использовании параметра asTable.

String

Да

Да

functionOutputFormat(String context, String function [, String schema [, Boolean asTable]])

Возвращает строковое представление формата вывода функции или ноль, если контекст/функция недоступны или формат вывода функции динамический.

По умолчанию используется режим кодирования невидимых разграничителей для кодирования таблицы в виде строки. Чтобы вернуть результат в виде таблицы данных, задайте для asTable значение true.

Обратите внимание, что при вычесление выражений в редакторе выражений веб-интерфейса функция eventFormat должна вычисляться на сервере при использовании параметра asTable.

String

Да

Да

getVariable(String context, String variable)

Получает переменную под названием переменная из контекста с путем контекст и возвращает ее значение.

DataTable

Да

Да

setVariable(String context, String variable, Object parameter1, Object parameter2, ...)

Устанавливает переменную под названием переменная контекста с путем контекста. Если обеспечивается лишь один параметр типа Data Table, эта таблица будет использоваться в качестве нового значения переменной. В ином случае Таблица данных, представляющая новое значение переменной, строится из массива параметров (parameter1, parameter2, ...). Правила, используемые для заполнения таблицы данными, описаны здесь.

Null

Да

Да

setVariableEx(String context, String variable, DataTable value)

Аналогичный setVariable(...) Устанавливает переменную под названием переменная контекста с путем контекста. Параметры функции представлены таблицей данных.

Null

Да

Да

setVariableField(String context, String variable, String field, Integer record, Object value)

Устанавливает значение ячейки указанной переменной контекста. Ячейка задается параметрами поле и запись.

Null

Да

Да

setVariableRecord(String context, String variable, Integer record, Object parameter1, Object parameter2, ...)

Изменяет значения определенного ряда переменной контекста. Номер ряда задается параметром запись. Другие параметры используются для изменения значений этого ряда.

Null

Да

Да

variableAvailable(String context, String variable [, String schema])

Возвращает true, если контекст с путем, определенный аргументом контекст, имеет переменную, определенную аргументом переменная, и эта переменная доступна вызывающему.

Boolean

Да

Да

variableFormat(String context, String variable [, String schema [, Boolean asTable]])

Возвращает строковое представление формата переменной или ноль, если контекст/переменная недоступны или формат переменной динамический.

По умолчанию используется режим кодирования невидимых разграничителей для кодирования таблицы в виде строки. Чтобы вернуть результат в виде таблицы данных, задайте для asTable значение true.

Обратите внимание, что при вычесление выражений в редакторе выражений веб-интерфейса функция eventFormat должна вычисляться на сервере при использовании параметра asTable.

String

Да

Да

variableGroup(String context, String variable[, String schema])

Возвращает имя группы, которой принадлежит переменная, или значение null, если она не принадлежит ни одной группе.

String

Да

Нет

variableReadable(String context, String variable [, String schema])

Возвращает true, если контекст с путем, определенный аргументом контекст, имеет переменную, определенную аргументом переменная, и эта переменная читается вызывающим.

Boolean

Да

Да

variableWritable(String context, String variable [, String schema])

Возвращает true, если контекст с путем, определенный аргументом контекст, имеет переменную, определенную аргументом переменная, и эта переменная записывается вызывающим.

Boolean

Да

Да