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

# Class Document

java.lang.Object
ru.bitel.common.model.Id
ru.bitel.common.model.IdTitle
ru.bitel.bgbilling.plugins.documents.common.bean.Document

All Implemented Interfaces:
  `Serializable`, `GuiTitlable`, `Idable`, `ListItem`

public class Document extends IdTitle
Класс-модель документа в плагине Documents. Документ привязывается к определенному договору и может содержать произвольное число файлов. Документ может быть сгенерирован по шаблону.

See Also:
  - Serialized Form

- ## Field Summary

  ### Fields inherited from class ru.bitel.common.model.IdTitle

  `NO_SELECT`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `Document()`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `String`
  `getComment()`
  Получение комментария документа.
  `int`
  `getContractId()`
  Получение кода договора, к которому привязывается документ.
  `Date`
  `getCreateDate()`
  Получение даты создания документа.
  `String`
  `getFileSecret()`
  `int`
  `getJournalId()`
  Получение кода журнала.
  `Date`
  `getLastModifyDate()`
  Получение даты последней модификации документа.
  `int`
  `getPatternId()`
  Получение кода шаблона, по которому был сгенерирован документ.
  `int`
  `getStatusId()`
  Получение статуса документа.
  `int`
  `getTypeId()`
  Получение типа документа.
  `int`
  `getUserId()`
  Получение кода пользователя, который создал документ.
  `boolean`
  `isShowInLK()`
  `Document`
  `setComment(String comment)`
  Установка комментария документа.
  `Document`
  `setContractId(int contractId)`
  Установка кода договора, к которому привязывается документ.
  `Document`
  `setCreateDate(Date createDate)`
  Установка даты создания документа.
  `Document`
  `setFileSecret(String fileSecret)`
  `Document`
  `setId(int id)`
  Устанавливает id объекта
  `Document`
  `setJournalId(int journal)`
  Установка кода журнала.
  `Document`
  `setLastModifyDate(Date lastModifyDate)`
  Установка даты последней модификации документа.
  `Document`
  `setPatternId(int patternId)`
  Установка кода шаблона, по которому был сгенерирован документ.
  `Document`
  `setShowInLK(boolean showInLK)`
  `Document`
  `setStatusId(int status)`
  Установка статуса документа.
  `Document`
  `setTitle(String title)`
  Устанавливает название (описание) объекта
  `Document`
  `setTypeId(int type)`
  Установка типа документа.
  `Document`
  `setUserId(int user)`
  Установка кода пользователя.

  ### Methods inherited from class ru.bitel.common.model.IdTitle

  `copyTo, getGuiTitle, getTitle, setAsNoSelect, to, toIdTitle, toString`

  ### Methods inherited from class ru.bitel.common.model.Id

  `copyTo, equals, getId, hashCode, newIdList, newIdSet, newIdSet, newIdSet, newIdSet, newMap`

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

  `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

  ### Methods inherited from interface ru.bitel.common.model.ListItem

  `getId`

- ## Constructor Details

  - ### Document

    public Document()

- ## Method Details

  - ### getComment

    public String getComment()
    Получение комментария документа.
    Returns:
      комментарий документа

  - ### getContractId

    public int getContractId()
    Получение кода договора, к которому привязывается документ.
    Returns:
      код документа.

  - ### getCreateDate

    public Date getCreateDate()
    Получение даты создания документа.
    Returns:
      дата создания документа.
    Since:
      6.2

  - ### getFileSecret

    public String getFileSecret()

  - ### getJournalId

    public int getJournalId()
    Получение кода журнала.
    Returns:
      код журнала.

  - ### getLastModifyDate

    public Date getLastModifyDate()
    Получение даты последней модификации документа.
    Returns:
      дата последней модификации документа.

  - ### getPatternId

    public int getPatternId()
    Получение кода шаблона, по которому был сгенерирован документ. Если документ был создан вручную, что данное поле имеет значение -1.
    Returns:
      код шаблона.

  - ### getStatusId

    public int getStatusId()
    Получение статуса документа.
    Returns:
      статус документа.

  - ### getTypeId

    public int getTypeId()
    Получение типа документа.
    Returns:
      тип документа.

  - ### getUserId

    public int getUserId()
    Получение кода пользователя, который создал документ. В случае, если документ был сгенерирован по шаблону, то вернется код пользователя,определенный константой `User.USER_SERVER`.
    Returns:
      код пользователя.

  - ### isShowInLK

    public boolean isShowInLK()

  - ### setComment

    public Document setComment(String comment)
    Установка комментария документа.
    Parameters:
      `comment` - комментарий документа.

  - ### setContractId

    public Document setContractId(int contractId)
    Установка кода договора, к которому привязывается документ.
    Parameters:
      `contractId` - код документа.

  - ### setCreateDate

    public Document setCreateDate(Date createDate)
    Установка даты создания документа.
    Parameters:
      `createDate` - дата создания документа.
    Since:
      6.2

  - ### setFileSecret

    public Document setFileSecret(String fileSecret)

  - ### setId

    public Document setId(int id)
    Description copied from class: `Id`
    Устанавливает id объекта
    Overrides:
      `setId` in class `IdTitle`

  - ### setJournalId

    public Document setJournalId(int journal)
    Установка кода журнала.
    Parameters:
      `journal` - код журнала.

  - ### setLastModifyDate

    public Document setLastModifyDate(Date lastModifyDate)
    Установка даты последней модификации документа.
    Parameters:
      `lastModifyDate` - дата последней модификации документа.

  - ### setPatternId

    public Document setPatternId(int patternId)
    Установка кода шаблона, по которому был сгенерирован документ. Код шаблона устанавливается в момент генерации документа по шаблону, иначе - код шаблона -1.
    Parameters:
      `patternId` - код шаблона

  - ### setShowInLK

    public Document setShowInLK(boolean showInLK)

  - ### setStatusId

    public Document setStatusId(int status)
    Установка статуса документа.
    Parameters:
      `status` - статус документа.

  - ### setTitle

    public Document setTitle(String title)
    Description copied from class: `IdTitle`
    Устанавливает название (описание) объекта
    Overrides:
      `setTitle` in class `IdTitle`

  - ### setTypeId

    public Document setTypeId(int type)
    Установка типа документа.
    Parameters:
      `type` - тип документа.

  - ### setUserId

    public Document setUserId(int user)
    Установка кода пользователя. В случае, если документ был сгенерирован по шаблону, то в качестве кода пользователя устанавливается константа `User.USER_SERVER`.
    Parameters:
      `user` -