Interface DispatchService
@MTOM
public interface DispatchService
-
Method Summary
Modifier and Type Method Description void
addMessageInclusion(DispatchMessage dm, javax.xml.ws.Holder<javax.activation.DataHandler> inclusion, java.lang.String fileName)
Добавляет вложение в сообщение.void
addSubscriptions(java.lang.String dispatchIds, java.lang.String contractIds)
Добавляет подписки на выбранные рассылки в выбранные договоры.void
deleteContact(int id)
Удаляет контакт.void
deleteContactType(int contactTypeId)
Удаляет тип контакта.void
deleteDispatch(Dispatch d)
Удаляет рассылку.void
deleteMessage(DispatchMessage dm)
Удаление сообщения из рассылки.void
deleteMessageInclusion(DispatchMessage dm, BGServerFile inclusion)
Удаляет вложение из сообщения.void
deleteSenderType(int id)
Удаляет метод отправки по его кодуvoid
deleteSubscription(int subscriptionId)
Удаляет подпискуjava.util.List<Subscription>
getActiveSubscriptions(int dispatchId)
Возвращает список подписокjava.util.List<IdTitle>
getAddressParamList()
Получение списка адресных параметров, которые заведены в параметрах договорах.java.lang.String
getContactDefaultValue(int contactTypeId, int contractId)
java.util.List<Contact>
getContacts(int contractId)
Deprecated.java.util.List<Contact>
getContacts(int contractId, Dispatch dispatch)
Возвращает список контактов, в том числе контакты из параметров договора.java.util.List<ContactType>
getContactTypes()
Возвращает список типов контактовjava.util.List<ContractContact>
getContracts(java.lang.String name, int typeId)
Получение списка договоров по контактуjava.lang.String
getCustomConditionCheckerIfaceName()
Получение имени интерфейса проверяльщика условия для пользовательского динамического класса.java.util.List<Dispatch>
getDispatchList()
Возвращает список всех рассылок.java.util.List<BGServerFile>
getMessageInclusions(DispatchMessage dm)
Возвращает список вложений в сообщениеjava.util.List<DispatchMessage>
getMessageList(int did, boolean onlyNotSent)
Возвращает список сообщения для рассылкиSearchResult<DispatchMessageStatistic>
getMessageStatisticList(int contractId, int dispatchId, int messageId, int contactId, Period period, Page page)
Получение статистики отправленных сообщений по договору и/или рассылке, и/или сообщению, и/или контакту за определенный период.java.lang.String
getSenderIfaceClassName()
Возвращает имя интерфейса, который должен имплементировать новый создаваемый метод отправкиjava.util.List<SenderType>
getSenderTypes()
Возвращает методы отправкиjava.util.List<Subscription>
getSubscriptions(int dispatchId, int contractId)
Возвращает список подписокjava.util.List<java.lang.String>
installedModuleList()
Возвращает имена установленных модулей, сделано для обхода запрета "получения списка модулей"void
setEventForSubscription(int dispatchId, int contractId)
Устанавливает подпискам договора флаг событияvoid
updateContact(Contact current)
Изменяет\создает новый контакт.void
updateContactType(ContactType current)
Изменяет\создает тип контактаvoid
updateDispatch(Dispatch d)
Изменяет\создает рассылкуvoid
updateMessage(DispatchMessage dm)
Изменяет\создает сообщениеvoid
updateSenderType(SenderType current)
Изменяет метод отправкиvoid
updateSubscriptions(Subscription subscription)
Изменяет\создает подписку
-
Method Details
-
getDispatchList
Возвращает список всех рассылок.- Returns:
- пустой список, если рассылки еще не были заведены
- Throws:
ru.bitel.bgbilling.common.BGException
-
getMessageList
java.util.List<DispatchMessage> getMessageList(int did, boolean onlyNotSent) throws ru.bitel.bgbilling.common.BGExceptionВозвращает список сообщения для рассылки- Parameters:
did
- код рассылкиonlyNotSent
- выбрать только неотправленные- Returns:
- пустой список, если сообщений в рассылке еще нет
- Throws:
ru.bitel.bgbilling.common.BGException
-
updateDispatch
Изменяет\создает рассылку- Parameters:
d
- рассылка (id <= 0 для создания новой)- Throws:
ru.bitel.bgbilling.common.BGException
ru.bitel.bgbilling.common.BGMessageException
- если у существующей рассылки изменяется тип контактов
-
updateMessage
Изменяет\создает сообщение- Parameters:
dm
- сообщение (id <= 0 для создания нового)- Throws:
ru.bitel.bgbilling.common.BGException
-
getMessageInclusions
java.util.List<BGServerFile> getMessageInclusions(DispatchMessage dm) throws ru.bitel.bgbilling.common.BGExceptionВозвращает список вложений в сообщение- Parameters:
dm
- сообщение- Returns:
- Throws:
ru.bitel.bgbilling.common.BGException
-
addMessageInclusion
void addMessageInclusion(DispatchMessage dm, javax.xml.ws.Holder<javax.activation.DataHandler> inclusion, java.lang.String fileName) throws ru.bitel.bgbilling.common.BGExceptionДобавляет вложение в сообщение. Нельзя добавлять вложения в отправленные сообщения.- Parameters:
dm
- сообщениеinclusion
- данные для вложенияfileName
- имя вложения- Throws:
ru.bitel.bgbilling.common.BGException
-
deleteMessageInclusion
void deleteMessageInclusion(DispatchMessage dm, BGServerFile inclusion) throws ru.bitel.bgbilling.common.BGExceptionУдаляет вложение из сообщения. Нельзя удалить вложение из отправленного сообщения.- Parameters:
dm
- сообщениеinclusion
- вложение- Throws:
ru.bitel.bgbilling.common.BGException
-
deleteDispatch
Удаляет рассылку. Удаление рассылки приводит к удалению всех шаблонов рассылки, всех сообщений рассылки и всех подписок на эту рассылку.- Parameters:
d
- рассылка- Throws:
ru.bitel.bgbilling.common.BGException
-
deleteMessage
Удаление сообщения из рассылки. Невозможно удалить отправленное сообщение, только если не установлен флаг allow.delete.sent.messages=1 в конфигурации плагина.- Parameters:
dm
- сообщение- Throws:
ru.bitel.bgbilling.common.BGException
-
updateContactType
Изменяет\создает тип контакта- Parameters:
current
- (id <= 0 для создания нового типа контакта)- Throws:
ru.bitel.bgbilling.common.BGException
-
deleteContactType
void deleteContactType(int contactTypeId) throws ru.bitel.bgbilling.common.BGExceptionУдаляет тип контакта. Тип контакта может быть удален ТОЛЬКО если отсутствуют рассылки с таким типом.- Parameters:
contactTypeId
- код типа контакта- Throws:
ru.bitel.bgbilling.common.BGException
-
getContactTypes
Возвращает список типов контактов- Returns:
- пустой список, если типов контактов еще нет
- Throws:
ru.bitel.bgbilling.common.BGException
-
getContacts
@RequestWrapper(className="ru.bitel.bgbilling.plugins.dispatch.common.jaxws.GetContactsOldRequest") @ResponseWrapper(className="ru.bitel.bgbilling.plugins.dispatch.common.jaxws.GetContactsOldResponse") @Deprecated java.util.List<Contact> getContacts(int contractId) throws ru.bitel.bgbilling.common.BGExceptionDeprecated.UsegetContacts(int, Dispatch)
instead- Throws:
ru.bitel.bgbilling.common.BGException
-
getContacts
java.util.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 id) throws ru.bitel.bgbilling.common.BGExceptionУдаляет контакт. Проверяет наличие подписок для контакта перед удалением.- Parameters:
id
-- Throws:
ru.bitel.bgbilling.common.BGException
ru.bitel.bgbilling.common.BGMessageException
- если контакт подписан на рассылки
-
getContactDefaultValue
java.lang.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
java.util.List<Subscription> getSubscriptions(int dispatchId, int contractId) throws ru.bitel.bgbilling.common.BGExceptionВозвращает список подписок- Parameters:
dispatchId
- если 0, то возвращает список всех подписок для договораcontractId
- если 0, то возвращает список всех подписок на рассылку- Returns:
- пустой список, если таковых нет
- Throws:
ru.bitel.bgbilling.common.BGException
-
getActiveSubscriptions
java.util.List<Subscription> getActiveSubscriptions(int dispatchId) throws ru.bitel.bgbilling.common.BGExceptionВозвращает список подписок- Parameters:
dispatchId
- если 0, то возвращает список всех подписок для договора- Returns:
- пустой список, если таковых нет
- Throws:
ru.bitel.bgbilling.common.BGException
-
deleteSubscription
void deleteSubscription(int subscriptionId) throws ru.bitel.bgbilling.common.BGExceptionУдаляет подписку- Parameters:
subscriptionId
- код подписки- Throws:
ru.bitel.bgbilling.common.BGException
-
updateSubscriptions
Изменяет\создает подписку- Parameters:
subscription
- (id <= 0 для создания новой)- Throws:
ru.bitel.bgbilling.common.BGException
ru.bitel.bgbilling.common.BGMessageException
- если в подписке нет контактов
-
addSubscriptions
void addSubscriptions(java.lang.String dispatchIds, java.lang.String contractIds) throws ru.bitel.bgbilling.common.BGExceptionДобавляет подписки на выбранные рассылки в выбранные договоры. Используется в групповой операции. Подписка добавится только в том случае, если в договоре заведен контакт (-ы) с таким же типом контакта, который указан в рассылке.- Parameters:
dispatchIds
- список кодов рассылок через запятую.contractIds
- список кодов договоров через запятую, которым следует добавить подписки на рассылки.- Throws:
ru.bitel.bgbilling.common.BGException
-
getSenderTypes
Возвращает методы отправки- Returns:
- Throws:
ru.bitel.bgbilling.common.BGException
-
getSenderIfaceClassName
java.lang.String getSenderIfaceClassName()Возвращает имя интерфейса, который должен имплементировать новый создаваемый метод отправки- Returns:
-
updateSenderType
Изменяет метод отправки- Parameters:
current
- создает при id <= 0- Throws:
ru.bitel.bgbilling.common.BGException
-
deleteSenderType
void deleteSenderType(int id) throws ru.bitel.bgbilling.common.BGExceptionУдаляет метод отправки по его коду- Parameters:
id
-- Throws:
ru.bitel.bgbilling.common.BGException
-
getAddressParamList
Получение списка адресных параметров, которые заведены в параметрах договорах. ИСпользуется в условии отправки по адресу подписчика- Returns:
- список адресных параметров в виде
IdTitle
- Throws:
ru.bitel.bgbilling.common.BGException
-
getContracts
Получение списка договоров по контакту- Parameters:
name
- Строка для поискаtypeId
- Id типа контакта- Returns:
-
getCustomConditionCheckerIfaceName
java.lang.String getCustomConditionCheckerIfaceName()Получение имени интерфейса проверяльщика условия для пользовательского динамического класса.- Returns:
- полное имя интерфейса, включая имя пакета.
-
setEventForSubscription
void setEventForSubscription(int dispatchId, int contractId) throws ru.bitel.bgbilling.common.BGExceptionУстанавливает подпискам договора флаг события- Parameters:
dispatchId
- код рассылкиcontractId
- ид договора- Throws:
ru.bitel.bgbilling.common.BGException
-
getMessageStatisticList
SearchResult<DispatchMessageStatistic> getMessageStatisticList(int contractId, int dispatchId, int messageId, int contactId, Period period, Page page) throws ru.bitel.bgbilling.common.BGExceptionПолучение статистики отправленных сообщений по договору и/или рассылке, и/или сообщению, и/или контакту за определенный период.- Parameters:
contractId
- код договораdispatchId
- код рассылкиmessageId
- код сообщения из рассылкиcontactId
- код контакта плагинаperiod
- период, за который нужно вывести статистикуpage
- отображаемая страница- Throws:
ru.bitel.bgbilling.common.BGException
-
installedModuleList
java.util.List<java.lang.String> installedModuleList() throws ru.bitel.bgbilling.common.BGExceptionВозвращает имена установленных модулей, сделано для обхода запрета "получения списка модулей"- Returns:
- Throws:
ru.bitel.bgbilling.common.BGException
-
getContacts(int, Dispatch)
instead