CoreReportBuilder.TemplateContext¶

public interface TemplateContext¶

New in version 1.23.0-rc11.

Контекст шаблона печатной формы (отчёта).

Предоставляет доступ к свойствам шаблона, для которого вызывается событие строителя.

Methods¶

getDate¶

Date getDate()¶

Возвращает дату, на которую был запрошен отчёт.

Значение, переданное в метод CoreReports.createReport(String, Date, ActionEnum) или параметре http-запроса, при построении отчёта из REST-сервиса.

Returns:: дата или null.

getId¶

Long getId()¶

Возвращает идентификатор шаблона.

Если шаблон получен из базы данных, это будет идентификатор записи таблицы Rpt_ReportVersion.

Returns:: идентификатор или null.

getReportName¶

String getReportName()¶

Возвращает системное имя отчёта.

При получении шаблон из БД, это будет значение из поля таблицы Rpt_Report.sSystemName.

Returns:: имя отчёта.

getType¶

String getType()¶

Возвращает тип шаблона отчёта.

Returns:: Строковое имя значения из перечисления CoreReportBuilder.TemplateTypeEnum.

getUserData¶

Object getUserData()¶

Метод возвращает установленное ранее в обработчике события значение.

Свойство может быть использовано для хранения произвольного значения в течении построения печатной формы. Значение будет доступно во всех методах объекта CoreReportBuilder.EventHandler.

Returns:: значение установленное ранее методом setUserData(Object) значение или null.

getVersion¶

Long getVersion()¶

Метод возвращает версию шаблона отчёта.

Если шаблон получен из базы данных, это будет версия записи таблицы Rpt_ReportVersion.

Returns:: версия или null.

setUserData¶

void setUserData(Object value)¶

Метод устанавливает значение свойства getUserData().

Parameters:

value – новое значение