Class DocumentVariable
java.lang.Object
ru.bitel.bgbilling.plugins.documents.common.bean.DocumentVariable
- All Implemented Interfaces:
Cloneable
Класс-модель переменной в плагине Documents. Представляет собой идентификатор,
содержащийся в шаблоне документа, на место которого подставляется опреденное значение
в зависимости от типа переменной.
содержащийся в шаблоне документа, на место которого подставляется опреденное значение
в зависимости от типа переменной.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionclone()
Создание копии объекта.boolean
Переопределенный для переменных шаблона метод сравнения.Получение поля, в котором хранится дополнительная информация, актуальная для данной переменной: формат даты, код параметра договора и т.д.getTitle()
Получение названия переменной.getType()
Получение типа переменной.getValue()
Получение значения переменной.void
setAdditionalParam
(String additionalParam) Установка поля, в котором хранится дополнительная информация, актуальная для данной переменной: формат даты, код параметра договора и т.д.void
Установка названия переменной.void
setType
(DocumentVariableType type) Установка типа переменной.void
Установка значения переменной.
-
Constructor Details
-
DocumentVariable
public DocumentVariable() -
DocumentVariable
-
-
Method Details
-
getTitle
Получение названия переменной. Это название встречается в файле шаблона в виде {title}.- Returns:
- название переменной.
-
setTitle
Установка названия переменной. Это название встречается в файле шаблона в виде {title}.- Parameters:
title
- название переменной.
-
getType
Получение типа переменной. Возможные значения:
DocumentVariableType.CONST
- переменная содержит некоторое константное значение, которое подставится в шаблон как есть. Есть поддержка макросов. Подробее см. документацию плагина Documents.DocumentVariableType.DATE
- значение переменной содержит дату в определенном формате, который задается в полеadditionalParam
DocumentVariableType.CONTRACT_PARAM
- значение переменной содержит значение параметра договораDocumentVariableType.SQL
- значение переменной содержит sql-запрос, при выполнении которого будет получено некоторое значениеDocumentVariableType.URL
- значение переменной содержит значение, полученное при получении по определенному url
- Returns:
- тип переменной.
-
setType
Установка типа переменной. Возможные значения:
DocumentVariableType.CONST
- переменная содержит некоторое константное значение, которое подставится в шаблон как есть. Есть поддержка макросов. Подробее см. документацию плагина Documents.DocumentVariableType.DATE
- значение переменной содержит дату в определенном формате, который задается в полеadditionalParam
DocumentVariableType.CONTRACT_PARAM
- значение переменной содержит значение параметра договораDocumentVariableType.SQL
- значение переменной содержит sql-запрос, при выполнении которого будет получено некоторое значениеDocumentVariableType.URL
- значение переменной содержит значение, полученное при получении по определенному url
- Parameters:
type
- тип переменной.
-
getValue
Получение значения переменной.- Returns:
- значение переменной.
-
setValue
Установка значения переменной.- Parameters:
value
- значение переменной.
-
getAdditionalParam
Получение поля, в котором хранится дополнительная информация, актуальная для данной переменной: формат даты, код параметра договора и т.д.- Returns:
- дополнительная информация для переменной.
-
setAdditionalParam
Установка поля, в котором хранится дополнительная информация, актуальная для данной переменной: формат даты, код параметра договора и т.д.- Parameters:
additionalParam
- дополнительная информация для переменной.s
-
equals
Переопределенный для переменных шаблона метод сравнения. Переопределение необходимо, т.к. сравнение объектов происходит не по id, а по title+type+additionalParam+value -
clone
Создание копии объекта.
-