Interface RegisterLoadTemplate
- All Known Implementing Classes:
StandardRegisterLoadTemplate
public interface RegisterLoadTemplate
Шаблон (рецепт) загрузки реестра платежей или расходов из файла.
Каждый шаблон в справочнике (загрузка платежей / загрузка расходов) ссылается на класс,
реализующий данный интерфейс. В ядре поставляется стандартный параметрический шаблон
StandardRegisterLoadTemplate; пользовательские шаблоны могут быть реализованы
любым классом (в т.ч. динамическим кодом), реализующим этот интерфейс.
Классы должны иметь публичный конструктор без аргументов.
-
Method Summary
Modifier and TypeMethodDescriptiondefault List<RegisterLoadTemplateParameterInfo> Список настраиваемых параметров шаблона, отображаемых в редакторе справочника "Загрузка платежей/расходов - шаблоны".voidinit(String title, ParameterMap params, int registerType) Инициализация шаблона.loadRegister(Connection con, RegisterLoadData data) Загрузка реестра из файла.
-
Method Details
-
init
void init(String title, ParameterMap params, int registerType) throws ru.bitel.bgbilling.common.BGException Инициализация шаблона.- Parameters:
title- название шаблона (из справочника)params- параметры шаблона (из справочника), для стандартного шаблона это набор параметров разбора файла (см.StandardRegisterLoadTemplate)registerType- тип реестра (Register.PAYMENT_REGISTER / Register.CHARGE_REGISTER)- Throws:
ru.bitel.bgbilling.common.BGException- при ошибке разбора параметров
-
getParameters
Список настраиваемых параметров шаблона, отображаемых в редакторе справочника "Загрузка платежей/расходов - шаблоны". Имена параметров - ключи, по которым значения читаются из настроек шаблона. Описание параметра выводится в редакторе как подсказка по выбранному параметру.Реализациям из динамического кода рекомендуется переопределить этот метод.
- Returns:
- список доступных параметров с описаниями
-
loadRegister
Register loadRegister(Connection con, RegisterLoadData data) throws ru.bitel.bgbilling.common.BGException, SQLException Загрузка реестра из файла.- Parameters:
con- соединение с БДdata- данные загрузки (файл, дата, название, лог и статистика)- Returns:
- загруженный реестр
- Throws:
ru.bitel.bgbilling.common.BGException- при ошибкеSQLException
-