Package ru.bitel.bgbilling.plugins.documents.common.bean

# Class DocumentVariable

java.lang.Object
ru.bitel.bgbilling.plugins.documents.common.bean.DocumentVariable

All Implemented Interfaces:
  `Cloneable`

public class DocumentVariable extends Object implements Cloneable
Класс-модель переменной в плагине Documents. Представляет собой идентификатор,
содержащийся в шаблоне документа, на место которого подставляется опреденное значение
в зависимости от типа переменной.

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `DocumentVariable()`
  `DocumentVariable(String title)`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `DocumentVariable`
  `clone()`
  Создание копии объекта.
  `boolean`
  `equals(Object obj)`
  Переопределенный для переменных шаблона метод сравнения.
  `String`
  `getAdditionalParam()`
  Получение поля, в котором хранится дополнительная информация, актуальная для данной переменной: формат даты, код параметра договора и т.д.
  `String`
  `getTitle()`
  Получение названия переменной.
  `DocumentVariableType`
  `getType()`
  Получение типа переменной.
  `String`
  `getValue()`
  Получение значения переменной.
  `DocumentVariable`
  `setAdditionalParam(String additionalParam)`
  Установка поля, в котором хранится дополнительная информация, актуальная для данной переменной: формат даты, код параметра договора и т.д.
  `DocumentVariable`
  `setTitle(String title)`
  Установка названия переменной.
  `DocumentVariable`
  `setType(DocumentVariableType type)`
  Установка типа переменной.
  `DocumentVariable`
  `setValue(String value)`
  Установка значения переменной.

  ### Methods inherited from class java.lang.Object

  `finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- ## Constructor Details

  - ### DocumentVariable

    public DocumentVariable()

  - ### DocumentVariable

    public DocumentVariable(String title)

- ## Method Details

  - ### getTitle

    public String getTitle()
    Получение названия переменной. Это название встречается в файле шаблона в виде {title}.
    Returns:
      название переменной.

  - ### setTitle

    public DocumentVariable setTitle(String title)
    Установка названия переменной. Это название встречается в файле шаблона в виде {title}.
    Parameters:
      `title` - название переменной.

  - ### getType

    public DocumentVariableType getType()
    Получение типа переменной. Возможные значения:
    - `DocumentVariableType.CONST` - переменная содержит некоторое константное значение, которое подставится в шаблон как есть. Есть поддержка макросов. Подробее см. документацию плагина Documents.
    - `DocumentVariableType.DATE` - значение переменной содержит дату в определенном формате, который задается в поле `additionalParam`
    - `DocumentVariableType.CONTRACT_PARAM` - значение переменной содержит значение параметра договора
    - `DocumentVariableType.SQL` - значение переменной содержит sql-запрос, при выполнении которого будет получено некоторое значение
    - `DocumentVariableType.URL` - значение переменной содержит значение, полученное при получении по определенному url
    Returns:
      тип переменной.

  - ### setType

    public DocumentVariable setType(DocumentVariableType type)
    Установка типа переменной. Возможные значения:
    - `DocumentVariableType.CONST` - переменная содержит некоторое константное значение, которое подставится в шаблон как есть. Есть поддержка макросов. Подробее см. документацию плагина Documents.
    - `DocumentVariableType.DATE` - значение переменной содержит дату в определенном формате, который задается в поле `additionalParam`
    - `DocumentVariableType.CONTRACT_PARAM` - значение переменной содержит значение параметра договора
    - `DocumentVariableType.SQL` - значение переменной содержит sql-запрос, при выполнении которого будет получено некоторое значение
    - `DocumentVariableType.URL` - значение переменной содержит значение, полученное при получении по определенному url
    Parameters:
      `type` - тип переменной.

  - ### getValue

    public String getValue()
    Получение значения переменной.
    Returns:
      значение переменной.

  - ### setValue

    public DocumentVariable setValue(String value)
    Установка значения переменной.
    Parameters:
      `value` - значение переменной.

  - ### getAdditionalParam

    public String getAdditionalParam()
    Получение поля, в котором хранится дополнительная информация, актуальная для данной переменной: формат даты, код параметра договора и т.д.
    Returns:
      дополнительная информация для переменной.

  - ### setAdditionalParam

    public DocumentVariable setAdditionalParam(String additionalParam)
    Установка поля, в котором хранится дополнительная информация, актуальная для данной переменной: формат даты, код параметра договора и т.д.
    Parameters:
      `additionalParam` - дополнительная информация для переменной.s

  - ### equals

    public boolean equals(Object obj)
    Переопределенный для переменных шаблона метод сравнения. Переопределение необходимо, т.к. сравнение объектов происходит не по id, а по title+type+additionalParam+value
    Overrides:
      `equals` in class `Object`

  - ### clone

    public DocumentVariable clone()
    Создание копии объекта.
    Overrides:
      `clone` in class `Object`
    Since:
      7.0