Interface DispatchService


@MTOM public interface DispatchService
  • Method Details

    • getDispatchList

      List<Dispatch> getDispatchList() throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException
      Возвращает список всех рассылок.
      Returns:
      пустой список, если рассылки еще не были заведены
      Throws:
      ru.bitel.bgbilling.common.BGException
      ru.bitel.bgbilling.common.BGMessageException
    • getMessageList

      List<DispatchMessage> getMessageList(int dispatchId, boolean onlyNotSent) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException
      Возвращает список сообщения для рассылки
      Parameters:
      did - код рассылки
      onlyNotSent - выбрать только неотправленные
      Returns:
      пустой список, если сообщений в рассылке еще нет
      Throws:
      ru.bitel.bgbilling.common.BGException
      ru.bitel.bgbilling.common.BGMessageException
    • updateDispatch

      void updateDispatch(Dispatch dispatch) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException
      Изменяет\создает рассылку
      Parameters:
      dispatch - рассылка (id <= 0 для создания новой)
      Throws:
      ru.bitel.bgbilling.common.BGException
      ru.bitel.bgbilling.common.BGMessageException - если у существующей рассылки изменяется тип контактов
    • updateMessage

      void updateMessage(DispatchMessage dispatchMessage) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException
      Изменяет\создает сообщение
      Parameters:
      dispatchMessage - сообщение (id <= 0 для создания нового)
      Throws:
      ru.bitel.bgbilling.common.BGException
      ru.bitel.bgbilling.common.BGMessageException
    • getMessageInclusions

      List<BGServerFile> getMessageInclusions(DispatchMessage dispatchMessage) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException
      Возвращает список вложений в сообщение
      Parameters:
      dispatchMessage - сообщение
      Returns:
      Throws:
      ru.bitel.bgbilling.common.BGException
      ru.bitel.bgbilling.common.BGMessageException
    • addMessageInclusion

      void addMessageInclusion(DispatchMessage dispatchMessage, jakarta.xml.ws.Holder<jakarta.activation.DataHandler> inclusion, String fileName) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException
      Добавляет вложение в сообщение. Нельзя добавлять вложения в отправленные сообщения.
      Parameters:
      dm - сообщение
      inclusion - данные для вложения
      fileName - имя вложения
      Throws:
      ru.bitel.bgbilling.common.BGException
      ru.bitel.bgbilling.common.BGMessageException
    • deleteMessageInclusion

      void deleteMessageInclusion(DispatchMessage dispatchMessage, BGServerFile inclusion) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException
      Удаляет вложение из сообщения. Нельзя удалить вложение из отправленного сообщения.
      Parameters:
      dm - сообщение
      inclusion - вложение
      Throws:
      ru.bitel.bgbilling.common.BGException
      ru.bitel.bgbilling.common.BGMessageException
    • deleteDispatch

      void deleteDispatch(Dispatch dispatch) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException
      Удаляет рассылку. Удаление рассылки приводит к удалению всех шаблонов рассылки, всех сообщений рассылки и всех подписок на эту рассылку.
      Parameters:
      dispatch - рассылка
      Throws:
      ru.bitel.bgbilling.common.BGException
      ru.bitel.bgbilling.common.BGMessageException
    • deleteMessage

      void deleteMessage(DispatchMessage dispatchMessage) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException
      Удаление сообщения из рассылки. Невозможно удалить отправленное сообщение, только если не установлен флаг allow.delete.sent.messages=1 в конфигурации плагина.
      Parameters:
      dm - сообщение
      Throws:
      ru.bitel.bgbilling.common.BGException
      ru.bitel.bgbilling.common.BGMessageException
    • updateContactType

      void updateContactType(ContactType current) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException
      Изменяет\создает тип контакта
      Parameters:
      current - (id <= 0 для создания нового типа контакта)
      Throws:
      ru.bitel.bgbilling.common.BGException
      ru.bitel.bgbilling.common.BGMessageException
    • deleteContactType

      void deleteContactType(int contactTypeId) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException
      Удаляет тип контакта. Тип контакта может быть удален ТОЛЬКО если отсутствуют рассылки с таким типом.
      Parameters:
      contactTypeId - код типа контакта
      Throws:
      ru.bitel.bgbilling.common.BGException
      ru.bitel.bgbilling.common.BGMessageException
    • getContactTypes

      List<ContactType> getContactTypes() throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException
      Возвращает список типов контактов
      Returns:
      пустой список, если типов контактов еще нет
      Throws:
      ru.bitel.bgbilling.common.BGException
      ru.bitel.bgbilling.common.BGMessageException
    • getContacts

      @RequestWrapper(className="ru.bitel.bgbilling.plugins.dispatch.common.jaxws.GetContactsOldRequest") @ResponseWrapper(className="ru.bitel.bgbilling.plugins.dispatch.common.jaxws.GetContactsOldResponse") @Deprecated List<Contact> getContacts(int contractId) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException
      Deprecated.
      Throws:
      ru.bitel.bgbilling.common.BGException
      ru.bitel.bgbilling.common.BGMessageException
    • getContacts

      List<Contact> getContacts(int contractId, Dispatch dispatch) throws ru.bitel.bgbilling.common.BGException
      Возвращает список контактов, в том числе контакты из параметров договора.
      Parameters:
      contractId - код договора
      dispatch -
      Returns:
      Throws:
      ru.bitel.bgbilling.common.BGException
    • updateContact

      void updateContact(Contact current) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException
      Изменяет\создает новый контакт. Осуществляется проверка на соответствие шаблону типа контакта.
      Parameters:
      current - контакт (id <= 0 для созданиея нового)
      Throws:
      ru.bitel.bgbilling.common.BGException
      ru.bitel.bgbilling.common.BGMessageException - если проверка значения контакта по шаблону типа контакта не прошла
    • deleteContact

      void deleteContact(int contactId) throws ru.bitel.bgbilling.common.BGException
      Удаляет контакт. Проверяет наличие подписок для контакта перед удалением.
      Parameters:
      id -
      Throws:
      ru.bitel.bgbilling.common.BGException
      ru.bitel.bgbilling.common.BGMessageException - если контакт подписан на рассылки
    • getContactDefaultValue

      String getContactDefaultValue(int contactTypeId, int contractId) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException
      Throws:
      ru.bitel.bgbilling.common.BGException
      ru.bitel.bgbilling.common.BGMessageException
    • getSubscriptions

      List<Subscription> getSubscriptions(int dispatchId, int contractId) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException
      Возвращает список подписок
      Parameters:
      dispatchId - если 0, то возвращает список всех подписок для договора
      contractId - если 0, то возвращает список всех подписок на рассылку
      Returns:
      пустой список, если таковых нет
      Throws:
      ru.bitel.bgbilling.common.BGException
      ru.bitel.bgbilling.common.BGMessageException
    • getActiveSubscriptions

      List<Subscription> getActiveSubscriptions(int dispatchId) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException
      Возвращает список подписок
      Parameters:
      dispatchId - если 0, то возвращает список всех подписок для договора
      Returns:
      пустой список, если таковых нет
      Throws:
      ru.bitel.bgbilling.common.BGException
      ru.bitel.bgbilling.common.BGMessageException
    • deleteSubscription

      void deleteSubscription(int subscriptionId) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException
      Удаляет подписку
      Parameters:
      subscriptionId - код подписки
      Throws:
      ru.bitel.bgbilling.common.BGException
      ru.bitel.bgbilling.common.BGMessageException
    • updateSubscriptions

      void updateSubscriptions(Subscription subscription) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException
      Изменяет\создает подписку
      Parameters:
      subscription - (id <= 0 для создания новой)
      Throws:
      ru.bitel.bgbilling.common.BGException
      ru.bitel.bgbilling.common.BGMessageException - если в подписке нет контактов
    • addSubscriptions

      void addSubscriptions(String dispatchIds, String contractIds) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException
      Добавляет подписки на выбранные рассылки в выбранные договоры. Используется в групповой операции. Подписка добавится только в том случае, если в договоре заведен контакт (-ы) с таким же типом контакта, который указан в рассылке.
      Parameters:
      dispatchIds - список кодов рассылок через запятую.
      contractIds - список кодов договоров через запятую, которым следует добавить подписки на рассылки.
      Throws:
      ru.bitel.bgbilling.common.BGException
      ru.bitel.bgbilling.common.BGMessageException
    • getSenderTypes

      List<SenderType> getSenderTypes() throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException
      Возвращает методы отправки
      Returns:
      Throws:
      ru.bitel.bgbilling.common.BGException
      ru.bitel.bgbilling.common.BGMessageException
    • getSenderIfaceClassName

      String getSenderIfaceClassName()
      Возвращает имя интерфейса, который должен имплементировать новый создаваемый метод отправки
      Returns:
    • updateSenderType

      void updateSenderType(SenderType current) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException
      Изменяет метод отправки
      Parameters:
      current - создает при id <= 0
      Throws:
      ru.bitel.bgbilling.common.BGException
      ru.bitel.bgbilling.common.BGMessageException
    • deleteSenderType

      void deleteSenderType(int id) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException
      Удаляет метод отправки по его коду
      Parameters:
      id -
      Throws:
      ru.bitel.bgbilling.common.BGException
      ru.bitel.bgbilling.common.BGMessageException
    • getAddressParamList

      List<IdTitle> getAddressParamList() throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException
      Получение списка адресных параметров, которые заведены в параметрах договорах. ИСпользуется в условии отправки по адресу подписчика
      Returns:
      список адресных параметров в виде IdTitle
      Throws:
      ru.bitel.bgbilling.common.BGException
      ru.bitel.bgbilling.common.BGMessageException
    • getContracts

      List<ContractContact> getContracts(String name, int typeId)
      Получение списка договоров по контакту
      Parameters:
      name - Строка для поиска
      typeId - Id типа контакта
      Returns:
    • getCustomConditionCheckerIfaceName

      String getCustomConditionCheckerIfaceName()
      Получение имени интерфейса проверяльщика условия для пользовательского динамического класса.
      Returns:
      полное имя интерфейса, включая имя пакета.
    • setEventForSubscription

      void setEventForSubscription(int dispatchId, int contractId) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException
      Устанавливает подпискам договора флаг события
      Parameters:
      dispatchId - код рассылки
      contractId - ид договора
      Throws:
      ru.bitel.bgbilling.common.BGException
      ru.bitel.bgbilling.common.BGMessageException
    • getMessageStatisticList

      SearchResult<DispatchMessageStatistic> getMessageStatisticList(int contractId, int dispatchId, int messageId, int contactId, Period period, Page page) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException
      Получение статистики отправленных сообщений по договору и/или рассылке, и/или сообщению, и/или контакту за определенный период.
      Parameters:
      contractId - код договора
      dispatchId - код рассылки
      messageId - код сообщения из рассылки
      contactId - код контакта плагина
      period - период, за который нужно вывести статистику
      page - отображаемая страница
      Throws:
      ru.bitel.bgbilling.common.BGException
      ru.bitel.bgbilling.common.BGMessageException
    • installedModuleList

      List<String> installedModuleList() throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException
      Возвращает имена установленных модулей, сделано для обхода запрета "получения списка модулей"
      Returns:
      Throws:
      ru.bitel.bgbilling.common.BGException
      ru.bitel.bgbilling.common.BGMessageException