Package ru.bitel.bgbilling.kernel.contract.api.common.service

Interface ContractService

public interface ContractService

Method Summary

Modifier and Type	Method	Description
Contract	contractByTitle(String contractTitle)
List<ContractCard>	contractCardList(int contractId)
org.json.JSONObject	contractCommentPatternList(int contractId)
String	contractCommentPatternValue(int contractId, int patternId)
void	contractDelete(int contractId, boolean save, String folder)	Удаление договора
void	contractDomainUpdate(int contractId, int domainId)	Обновление домена договора
Contract	contractGet(int contractId)
void	contractGroupAdd(int contractId, int contractGroupId)
void	contractGroupRemove(int contractId, int contractGroupId)
org.json.JSONObject	contractInfoGet(int contractId)	Информация о договоре
List<Contract>	contractList(String title, String comment, int fc, long groupMask, List<FilterEntityAttr> entityFilter, boolean subContracts, boolean closed, boolean hidden, javax.xml.ws.Holder<Page> page)
List<Contract>	contractList0(int contractId, String title, String comment, int fc, Set<Integer> labelsIds, List<FilterEntityAttr> entityFilter, boolean subContracts, boolean closed, boolean hidden, javax.xml.ws.Holder<Page> page)
String	contractListByFilter(ContractFilters contractFilters, List<FilterEntityAttr> entityFilter, javax.xml.ws.Holder<Page> page)
String	contractModuleConfigGet(int contractId, int moduleId, String key)
void	contractModuleConfigSet(int contractId, int moduleId, String key, String value)	Установка параметра конфига модуля для договора.
EntityAttr	contractParameterGet(int contractId, int parameterId)	Получение параметра договора.
ContractParameterGroup	contractParameterGroupGet(int id)	Deprecated. use ContractParameterService.contractParameterGroupGet(int)
List<ContractParameterGroup>	contractParameterGroupList()	Deprecated. use ContractParameterService.contractParameterGroupList()
MapHolder<Integer,EntityAttr>	contractParameterMap(int contractId, int paramGroupId)	Map параметров договора. Если параметр не заведен (не указан, не добавлен), то данный параметр будет отсутствовать в результате.
MapHolder<Integer,EntityAttr>	contractParameterMapByType(int contractId, int parameterType)
void	contractParameterUpdate(int contractId, EntityAttr parameter)	Добавление/обновление/удаление параметра договора.
int	contractPasswordOnceCheck(String passwordOnce)	Вход по единоразовому паролю, сгенерированному при вызове contractPasswordReset
void	contractPasswordReset(int contractId, String email)	Сброс пароля с отправкой нового на email.
void	contractPasswordUpdate(int contractId, String password, boolean generate)	Установка нового пароля для ЛК договора.
void	contractsDomainUpdate(List<Integer> contractIds, int domainId)	Обновление домена договоров
List<Contract>	contractSubList(int contractId, int subMode, boolean withSuperCid)	Получение списка субдоговоров.
org.json.JSONObject	contractTitleAndCommentGet(int contractId)
void	contractTitleAndCommentUpdate(int contractId, String title, String comment, int patternId)
void	contractUpdate(int contractId, Contract contract)	Обновление уже существующего договора в БД.
boolean	hasModuleInstance(int contractId, int moduleId)	Проверка на наличие привязки указанного модуля к договору.
SearchResult<ru.bitel.bgbilling.kernel.contract.search.common.ContractHistoryRecord>	searchContractHistoryRecord(Page page)
void	sendWebPasswordOfContractToEmail(String email, int contractId)	Отправка пароля статистики на почту
void	updateContractHistoryRecord(int contractId)

Method Details

contractGet

Contract contractGet(int contractId)
              throws ru.bitel.bgbilling.common.BGException

Parameters:

contractId - - код договора.

Returns:

- договор или null, если договор отсутствует.

Throws:

ru.bitel.bgbilling.common.BGException

contractByTitle

Contract contractByTitle(String contractTitle)
                  throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

contractUpdate

void contractUpdate(int contractId,
 Contract contract)
             throws ru.bitel.bgbilling.common.BGException

Обновление уже существующего договора в БД.

Parameters:

contractId - ID договора.

contract - договор.

Throws:

ru.bitel.bgbilling.common.BGException

contractGroupAdd

void contractGroupAdd(int contractId,
 int contractGroupId)
               throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

contractGroupRemove

void contractGroupRemove(int contractId,
 int contractGroupId)
                  throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

contractSubList

List<Contract> contractSubList(int contractId,
 int subMode,
 boolean withSuperCid)
                        throws ru.bitel.bgbilling.common.BGException

Получение списка субдоговоров.

Parameters:

contractId - - код договора.

subMode - - зависимый, независимый режим из KernelConst. Если subMode == -1, вернет все субдоговора.

withSuperCid - - если == true, то в список добавится и супер договор в начало списка.

Throws:

ru.bitel.bgbilling.common.BGException

contractList

List<Contract> contractList(String title,
 String comment,
 int fc,
 long groupMask,
 List<FilterEntityAttr> entityFilter,
 boolean subContracts,
 boolean closed,
 boolean hidden,
 javax.xml.ws.Holder<Page> page)
                     throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

contractList0

List<Contract> contractList0(int contractId,
 String title,
 String comment,
 int fc,
 Set<Integer> labelsIds,
 List<FilterEntityAttr> entityFilter,
 boolean subContracts,
 boolean closed,
 boolean hidden,
 javax.xml.ws.Holder<Page> page)
                      throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

contractListByFilter

String contractListByFilter(ContractFilters contractFilters,
 List<FilterEntityAttr> entityFilter,
 javax.xml.ws.Holder<Page> page)
                     throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

contractPasswordUpdate

void contractPasswordUpdate(int contractId,
 String password,
 boolean generate)
                     throws ru.bitel.bgbilling.common.BGException

Установка нового пароля для ЛК договора.

Parameters:

contractId - ID договора.

password - пароль.

generate - нужно ли сгенерировать автоматически, если true - то значение аргумента password игнорируется.

Throws:

ru.bitel.bgbilling.common.BGException

hasModuleInstance

boolean hasModuleInstance(int contractId,
 int moduleId)
                   throws ru.bitel.bgbilling.common.BGException

Проверка на наличие привязки указанного модуля к договору.

Parameters:

contractId - код договора

moduleId - код модуля

Returns:

true если экземпляр модуля привязан к договору, false - в противном случае.

Throws:

ru.bitel.bgbilling.common.BGException

contractPasswordReset

void contractPasswordReset(int contractId,
 String email)
                    throws ru.bitel.bgbilling.common.BGException

Сброс пароля с отправкой нового на email.

Parameters:

contractId -

email - если указан, то происходит проверка что он совпадает с тем, что указан в договоре - иначе просто отправляет на тот что в договоре.

Throws:

ru.bitel.bgbilling.common.BGException

contractPasswordOnceCheck

int contractPasswordOnceCheck(String passwordOnce)
                       throws ru.bitel.bgbilling.common.BGException

Вход по единоразовому паролю, сгенерированному при вызове contractPasswordReset

Parameters:

passwordOnce - единоразовый пароль

Returns:

ID договора или 0, если пароль не найден

Throws:

ru.bitel.bgbilling.common.BGException

contractParameterMap

MapHolder<Integer,EntityAttr> contractParameterMap(int contractId,
 int paramGroupId)
                                            throws ru.bitel.bgbilling.common.BGException

Map параметров договора.
Если параметр не заведен (не указан, не добавлен), то данный параметр будет отсутствовать в результате. Примером может служить параметр типа флаг - отсутствие параметра означает false.

Parameters:

contractId - ID договора.

paramGroupId - ID группы параметров договора ContractParameterGroup. Если значение >0, то выдаются параметры указанной группы, иначе - все параметры.

Returns:

Throws:

ru.bitel.bgbilling.common.BGException

contractParameterGroupGet

ContractParameterGroup contractParameterGroupGet(int id)
                                          throws ru.bitel.bgbilling.common.BGException

Deprecated.

use ContractParameterService.contractParameterGroupGet(int)

Получение группы параметров договора по ID.

Parameters:

id - ID группы параметров.

Returns:

Throws:

ru.bitel.bgbilling.common.BGException

contractParameterGroupList

List<ContractParameterGroup> contractParameterGroupList()
                                                 throws ru.bitel.bgbilling.common.BGException

Deprecated.

use ContractParameterService.contractParameterGroupList()

Получение списка групп параметров договора.

Returns:

Throws:

ru.bitel.bgbilling.common.BGException

searchContractHistoryRecord

SearchResult<ru.bitel.bgbilling.kernel.contract.search.common.ContractHistoryRecord> searchContractHistoryRecord(Page page)
                                                                                                          throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

updateContractHistoryRecord

void updateContractHistoryRecord(int contractId)
                          throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

contractModuleConfigGet

String contractModuleConfigGet(int contractId,
 int moduleId,
 String key)
                        throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

contractModuleConfigSet

void contractModuleConfigSet(int contractId,
 int moduleId,
 String key,
 String value)
                      throws ru.bitel.bgbilling.common.BGException

Установка параметра конфига модуля для договора.

Parameters:

contractId - ID договора.

moduleId - ID модуля.

key - ключ.

value - значение.

Throws:

ru.bitel.bgbilling.common.BGException

contractDomainUpdate

void contractDomainUpdate(int contractId,
 int domainId)
                   throws ru.bitel.bgbilling.common.BGException

Обновление домена договора

Parameters:

contractId - ID договора.

domainId - ID домена.

Throws:

ru.bitel.bgbilling.common.BGException

contractsDomainUpdate

void contractsDomainUpdate(List<Integer> contractIds,
 int domainId)

Обновление домена договоров

Parameters:

contractIds - ID договоров.

domainId - ID домена.

contractParameterUpdate

void contractParameterUpdate(int contractId,
 EntityAttr parameter)
                      throws ru.bitel.bgbilling.common.BGException

Добавление/обновление/удаление параметра договора. Удаление происходит в случае, если entityAttr null или значение внутри entityAttr пустое.

Parameters:

contractId - ID договора.

parameter - параметр.

Throws:

ru.bitel.bgbilling.common.BGException

See Also:

• EntityAttrText

contractParameterGet

EntityAttr contractParameterGet(int contractId,
 int parameterId)
                         throws ru.bitel.bgbilling.common.BGException

Получение параметра договора.

Parameters:

contractId - ID договора

parameterId - ID параметра

Returns:

Throws:

ru.bitel.bgbilling.common.BGException

contractParameterMapByType

MapHolder<Integer,EntityAttr> contractParameterMapByType(int contractId,
 int parameterType)
                                                  throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

sendWebPasswordOfContractToEmail

void sendWebPasswordOfContractToEmail(String email,
 int contractId)
                               throws ru.bitel.bgbilling.common.BGException

Отправка пароля статистики на почту

Parameters:

email - адрес или несколько адресов, куда будет отправлен пароль

Throws:

ru.bitel.bgbilling.common.BGException

contractDelete

void contractDelete(int contractId,
 boolean save,
 String folder)
             throws ru.bitel.bgbilling.common.BGException

Удаление договора

Parameters:

contractId - id удаляемого договора

save - нужно ли сохранять удаляемый договор на диск

folder - путь до директории для сохранения копии удаляемого договора

Throws:

ru.bitel.bgbilling.common.BGException

contractInfoGet

org.json.JSONObject contractInfoGet(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

contractTitleAndCommentGet

org.json.JSONObject contractTitleAndCommentGet(int contractId)
                                        throws ru.bitel.bgbilling.common.BGException,
ru.bitel.bgbilling.common.BGMessageException

Throws:

ru.bitel.bgbilling.common.BGException

ru.bitel.bgbilling.common.BGMessageException

contractCommentPatternList

org.json.JSONObject contractCommentPatternList(int contractId)
                                        throws ru.bitel.bgbilling.common.BGException,
ru.bitel.bgbilling.common.BGMessageException

Throws:

ru.bitel.bgbilling.common.BGException

ru.bitel.bgbilling.common.BGMessageException

contractTitleAndCommentUpdate

void contractTitleAndCommentUpdate(int contractId,
 String title,
 String comment,
 int patternId)
                            throws ru.bitel.bgbilling.common.BGException,
ru.bitel.bgbilling.common.BGMessageException

Throws:

ru.bitel.bgbilling.common.BGException

ru.bitel.bgbilling.common.BGMessageException

contractCommentPatternValue

String contractCommentPatternValue(int contractId,
 int patternId)
                            throws ru.bitel.bgbilling.common.BGException,
ru.bitel.bgbilling.common.BGMessageException

Throws:

ru.bitel.bgbilling.common.BGException

ru.bitel.bgbilling.common.BGMessageException

contractCardList

List<ContractCard> contractCardList(int contractId)
                             throws ru.bitel.bgbilling.common.BGException,
ru.bitel.bgbilling.common.BGMessageException

Throws:

ru.bitel.bgbilling.common.BGException

ru.bitel.bgbilling.common.BGMessageException