Interface DocumentsPatternService
@MTOM
public interface DocumentsPatternService
Веб-сервис, предназначенный для манипуляции с шаблонами документов:
создание/редактирование/удаление, работа с таблицами и переменными в шаблонах
создание/редактирование/удаление, работа с таблицами и переменными в шаблонах
-
Method Summary
Modifier and TypeMethodDescriptionvoid
clonePattern
(int patternId) Полное клонирование шаблона документа, в т.ч. файла шаблона на диске.void
deletePattern
(int patternId) Удаление конкретного шаблона документа по его коду.void
deletePatternFile
(int patternId) Удаляет файл из шаблона документа физически и из БД.downloadPatternFile
(int patternId, jakarta.xml.ws.Holder<jakarta.activation.DataHandler> fileData) Метод скачивает выбранный файл с сервераvoid
getEmbeddedFilename
(int patternId, jakarta.xml.ws.Holder<String> fileName) Получение имени файла, прикрепленного к шаблону документаgetFilePath
(int patternId) Получение ссылки на файл шаблона из общедоступной для сервера и клиента директории.getPattern
(int patternId) Получение одного шаблона по его коду.Получение имени интерфейса, который нужно реализовывать классам-имплементорам, чтобы получать данные для параметров в текстеgetPatternList
(int contractId) Возвращает список всех шаблонов документовПолучение имени интерфейса, который нужно реализовывать классам-имплементорам, чтобы получать данные для таблиц.int
updatePattern
(DocumentPattern documentPattern) Обновление одного конкретного шаблонаvoid
boolean
uploadPatternFile
(BGServerFile serverFile, jakarta.xml.ws.Holder<jakarta.activation.DataHandler> fileData) Метод закачивает выбранный файл на сервер и привязывает его к шаблону документа
-
Method Details
-
getPatternList
List<DocumentPattern> getPatternList(int contractId) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException Возвращает список всех шаблонов документов- Parameters:
contractId
- код договора. Передается в случае, если грузим список шаблонов в карточке договора. В некоторых случаях (при использовании доменов) список может отличаться от списка шаблонов в редакторе шаблонов плагина- Returns:
- список шаблонов
- Throws:
ru.bitel.bgbilling.common.BGException
ru.bitel.bgbilling.common.BGMessageException
-
getPattern
DocumentPattern getPattern(int patternId) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException Получение одного шаблона по его коду. Используется в случае, когда сервис создается в других модулях.- Parameters:
patternId
- код шаблона- Returns:
- шаблон документа
- Throws:
ru.bitel.bgbilling.common.BGException
ru.bitel.bgbilling.common.BGMessageException
-
getEmbeddedFilename
void getEmbeddedFilename(int patternId, jakarta.xml.ws.Holder<String> fileName) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException Получение имени файла, прикрепленного к шаблону документа- Parameters:
patternId
- код шаблона документаfileName
- имя файла- Throws:
ru.bitel.bgbilling.common.BGException
ru.bitel.bgbilling.common.BGMessageException
-
updatePattern
int updatePattern(DocumentPattern documentPattern) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException Обновление одного конкретного шаблона- Parameters:
documentPattern
- шаблон документа- Returns:
- код шаблона документа, который был добавлен/обновлен. Это нужно, чтобы можно было привязывать файл к шаблону, еще не сохраненному в БД.
- Throws:
ru.bitel.bgbilling.common.BGException
ru.bitel.bgbilling.common.BGMessageException
-
deletePattern
void deletePattern(int patternId) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException Удаление конкретного шаблона документа по его коду. Также вместе с шаблоном удаляется привязанный файл шаблона, а также все привязанные к шаблону динамические классы.- Parameters:
patternId
- код шаблона- Throws:
ru.bitel.bgbilling.common.BGException
ru.bitel.bgbilling.common.BGMessageException
-
clonePattern
void clonePattern(int patternId) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException Полное клонирование шаблона документа, в т.ч. файла шаблона на диске.- Parameters:
patternId
- код шаблона, который нужно клонировать- Throws:
ru.bitel.bgbilling.common.BGException
ru.bitel.bgbilling.common.BGMessageException
-
getTableExtractorIfaceClassName
String getTableExtractorIfaceClassName() throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageExceptionПолучение имени интерфейса, который нужно реализовывать классам-имплементорам, чтобы получать данные для таблиц.- Returns:
- полное имя интерфейса
- Throws:
ru.bitel.bgbilling.common.BGException
ru.bitel.bgbilling.common.BGMessageException
-
getPatternExtractorIfaceClassName
String getPatternExtractorIfaceClassName() throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageExceptionПолучение имени интерфейса, который нужно реализовывать классам-имплементорам, чтобы получать данные для параметров в тексте- Returns:
- Throws:
ru.bitel.bgbilling.common.BGException
ru.bitel.bgbilling.common.BGMessageException
-
uploadPatternFile
boolean uploadPatternFile(BGServerFile serverFile, jakarta.xml.ws.Holder<jakarta.activation.DataHandler> fileData) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException Метод закачивает выбранный файл на сервер и привязывает его к шаблону документа- Parameters:
serverFile
- представление файла на сервере, содержит в себе мета-информацию о файле: размер, код родительской сущности, название, пользователь, добавивший файл и т.д.fileData
- содержимое файла в виде FileDataSource- Returns:
- true в случае успеха закачки файла на сервер
- Throws:
ru.bitel.bgbilling.common.BGException
ru.bitel.bgbilling.common.BGMessageException
-
downloadPatternFile
BGServerFile downloadPatternFile(int patternId, jakarta.xml.ws.Holder<jakarta.activation.DataHandler> fileData) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException Метод скачивает выбранный файл с сервера- Parameters:
patternId
- код шаблона, к которому привязан файлfileData
- содержимое файла в виде FileDataSource- Returns:
- сущность, содержащая информацию о файле в системе BG
- Throws:
ru.bitel.bgbilling.common.BGException
ru.bitel.bgbilling.common.BGMessageException
-
deletePatternFile
void deletePatternFile(int patternId) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException Удаляет файл из шаблона документа физически и из БД.- Parameters:
patternId
- код шаблона- Throws:
ru.bitel.bgbilling.common.BGException
ru.bitel.bgbilling.common.BGMessageException
-
getFilePath
String getFilePath(int patternId) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException Получение ссылки на файл шаблона из общедоступной для сервера и клиента директории. Фактически - открытие файла напрямую с диска. Используется для оперативной правки файла шаблона- Parameters:
patternId
- код шаблона, для которого нужно получить ссылку.- Returns:
- ссылка на файл шаблона.
- Throws:
ru.bitel.bgbilling.common.BGException
ru.bitel.bgbilling.common.BGMessageException
- Since:
- 6.2
-
updatePos
void updatePos(List<int[]> idPosList) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException - Throws:
ru.bitel.bgbilling.common.BGException
ru.bitel.bgbilling.common.BGMessageException
-