Interface ContractService


public interface ContractService
  • 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​(java.lang.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

      java.util.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

      java.util.List<Contract> contractList​(java.lang.String title, java.lang.String comment, int fc, long groupMask, java.util.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

      java.util.List<Contract> contractList0​(int contractId, java.lang.String title, java.lang.String comment, int fc, java.util.Set<java.lang.Integer> labelsIds, java.util.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

      java.lang.String contractListByFilter​(ContractFilters contractFilters, java.util.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, java.lang.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, java.lang.String email) throws ru.bitel.bgbilling.common.BGException
      Сброс пароля с отправкой нового на email.
      Parameters:
      contractId -
      email - если указан, то происходит проверка что он совпадает с тем, что указан в договоре - иначе просто отправляет на тот что в договоре.
      Throws:
      ru.bitel.bgbilling.common.BGException
    • contractPasswordOnceCheck

      int contractPasswordOnceCheck​(java.lang.String passwordOnce) throws ru.bitel.bgbilling.common.BGException
      Вход по единоразовому паролю, сгенерированному при вызове contractPasswordReset
      Parameters:
      passwordOnce - единоразовый пароль
      Returns:
      ID договора или 0, если пароль не найден
      Throws:
      ru.bitel.bgbilling.common.BGException
    • contractParameterMap

      MapHolder<java.lang.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
      Получение группы параметров договора по ID.
      Parameters:
      id - ID группы параметров.
      Returns:
      Throws:
      ru.bitel.bgbilling.common.BGException
    • contractParameterGroupList

      java.util.List<ContractParameterGroup> contractParameterGroupList() throws ru.bitel.bgbilling.common.BGException
      Получение списка групп параметров договора.
      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

      java.lang.String contractModuleConfigGet​(int contractId, int moduleId, java.lang.String key) throws ru.bitel.bgbilling.common.BGException
      Throws:
      ru.bitel.bgbilling.common.BGException
    • contractModuleConfigSet

      void contractModuleConfigSet​(int contractId, int moduleId, java.lang.String key, java.lang.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​(java.util.List<java.lang.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<java.lang.Integer,​EntityAttr> contractParameterMapByType​(int contractId, int parameterType) throws ru.bitel.bgbilling.common.BGException
      Throws:
      ru.bitel.bgbilling.common.BGException
    • sendWebPasswordOfContractToEmail

      void sendWebPasswordOfContractToEmail​(java.lang.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, java.lang.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, java.lang.String title, java.lang.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

      java.lang.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

      java.util.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