Class DocumentPattern
java.lang.Object
ru.bitel.common.model.Id
ru.bitel.common.model.IdTitle
ru.bitel.bgbilling.plugins.documents.common.bean.DocumentPattern
- All Implemented Interfaces:
Serializable,Cloneable,GuiTitlable,Idable,ListItem
Класс-модель шаблона документа.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class ru.bitel.common.model.IdTitle
IdTitle.Builder, IdTitle.IdTitleBuilder -
Field Summary
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddDomain(int domainId) Добавление одного домена к списку доменов шаблона.voidaddTable(DocumentTable table) Добавление одной таблицы к списку таблиц шаблона.voidДобавление одной переменной к списку переменных шаблона.clone()Создание копии объекта.Получение комментария шаблона.Получение даты и времени создания шаблона документа.Получение динамического класса, которыйПолучение комментария для генерируемого документаПолучение имени сгенерированного документа.Получение списка доменов, фильтр по которым будет работать при отображении списка шаблонов в договореПолучение комментария для сгенерированного файла.Получение имени генерируемого файла.Получение даты и времени последней модификации шаблона документа.Deprecated.intgetPos()Получение списка таблиц шаблона.intПолучение кода пользователя, создавшего/отредактировавшего шаблон документа.Получение списка переменных шаблона.booleanDeprecated.booleanВиден ли данный шаблон в списке шаблонов для генерации документов на договоре.voidsetComment(String comment) Установка комментария шаблона.voidsetCreatePatternDate(Date createPatternDate) Установка даты и времени создания шаблона документа.voidsetDataExtractorClass(String dataExtractorClass) voidsetDocumentComment(String documentComment) Установка комментария для генерируемого документаvoidsetDocumentName(String documentName) Установка имени сгенерированного документа.voidsetDomainList(List<Integer> domainList) Установка списка доменов, фильтр по которым будет работать при отображении списка шаблонов в договореvoidsetFileComment(String fileComment) Установка комментария для сгенерированного файла.voidsetGeneratedFileNamePattern(String generatedFileNamePattern) Установка имени генерируемого файла.voidsetLastModifyPatternDate(Date lastModifyPatternDate) Установка даты и времени последней модификации шаблона документа.voidsetOutputDocumentName(String documentName) Deprecated.voidsetPos(int pos) voidsetTableList(List<DocumentTable> tableList) Установка списка таблиц шаблона.voidsetUseInPlugin(boolean isUseInPlugin) Deprecated.voidsetUserId(int userId) Установка кода пользователя, создавшего/отредактировавшего шаблон документа.voidsetVariableList(List<DocumentVariable> variableList) Установка списка переменных шаблона.voidsetVisibleInPlugin(boolean visibleInPlugin) Установка видимости шаблона в списке шаблонов для генерации на договоре.Methods inherited from class ru.bitel.common.model.IdTitle
copyTo, getGuiTitle, getTitle, setTitle, toIdTitle, toStringMethods inherited from class ru.bitel.common.model.Id
copyTo, equals, getId, hashCode, newIdList, newIdSet, newIdSet, newIdSet, newIdSet, newMap, setId
-
Constructor Details
-
DocumentPattern
public DocumentPattern()
-
-
Method Details
-
getPos
public int getPos() -
setPos
public void setPos(int pos) -
getDocumentName
Получение имени сгенерированного документа.- Returns:
- имя сгенерированного документа.
-
setDocumentName
Установка имени сгенерированного документа.- Parameters:
documentName- имя сгенерированного документа.
-
getOutputDocumentName
Deprecated. -
setOutputDocumentName
Deprecated. -
getDocumentComment
Получение комментария для генерируемого документа- Returns:
- комментарий для генерируемого документа
-
setDocumentComment
Установка комментария для генерируемого документа- Parameters:
documentComment- комментарий для генерируемого документа
-
getGeneratedFileNamePattern
Получение имени генерируемого файла.- Returns:
- имя генерируемого файла.
-
setGeneratedFileNamePattern
Установка имени генерируемого файла.- Parameters:
generatedFileNamePattern- имя генерируемого файла.
-
isUseInPlugin
Deprecated.ИспользоватьisVisibleInPlugin() -
setUseInPlugin
Deprecated.ИспользоватьsetVisibleInPlugin(boolean) -
isVisibleInPlugin
public boolean isVisibleInPlugin()Виден ли данный шаблон в списке шаблонов для генерации документов на договоре.- Returns:
- true - виден, false - не виден.
-
setVisibleInPlugin
public void setVisibleInPlugin(boolean visibleInPlugin) Установка видимости шаблона в списке шаблонов для генерации на договоре.- Parameters:
visibleInPlugin- true - виден, false - не виден.
-
getVariableList
Получение списка переменных шаблона.- Returns:
- список переменных шаблона.
-
setVariableList
Установка списка переменных шаблона.- Parameters:
variableList- список переменных шаблона.
-
addVariable
Добавление одной переменной к списку переменных шаблона.- Parameters:
var- переменная.
-
addDomain
public void addDomain(int domainId) Добавление одного домена к списку доменов шаблона.- Parameters:
domainId- код домена.
-
getTableList
Получение списка таблиц шаблона.- Returns:
- список таблиц.
-
setTableList
Установка списка таблиц шаблона.- Parameters:
tableList- список таблиц
-
addTable
Добавление одной таблицы к списку таблиц шаблона.- Parameters:
table- таблица.
-
getComment
Получение комментария шаблона.- Returns:
- комментарий шаблона.
-
setComment
Установка комментария шаблона.- Parameters:
comment- комментарий.
-
getDataExtractorClass
Получение динамического класса, который- Returns:
-
setDataExtractorClass
-
getUserId
public int getUserId()Получение кода пользователя, создавшего/отредактировавшего шаблон документа.- Returns:
- код пользователя. По умолчанию -2
-
setUserId
public void setUserId(int userId) Установка кода пользователя, создавшего/отредактировавшего шаблон документа.- Parameters:
userId- код пользователя.
-
getCreatePatternDate
Получение даты и времени создания шаблона документа.- Returns:
- дата и время создания шаблона.
-
setCreatePatternDate
Установка даты и времени создания шаблона документа.- Parameters:
createPatternDate- дата и время создания шаблона.
-
getLastModifyPatternDate
Получение даты и времени последней модификации шаблона документа.- Returns:
- дата и время последней модификации шаблона документа.
-
setLastModifyPatternDate
Установка даты и времени последней модификации шаблона документа.- Parameters:
lastModifyPatternDate- дата и время последней модификации шаблона документа.
-
clone
Создание копии объекта. -
getDomainList
Получение списка доменов, фильтр по которым будет работать при отображении списка шаблонов в договоре- Returns:
- список доменов
-
setDomainList
Установка списка доменов, фильтр по которым будет работать при отображении списка шаблонов в договоре- Parameters:
domainList- список доменов
-
getFileComment
Получение комментария для сгенерированного файла.- Returns:
- комментарий файла
-
setFileComment
Установка комментария для сгенерированного файла.- Parameters:
fileComment- комментарий файла.
-