ru.bitel.bgbilling.modules.inet.api.common.service

## Interface InetServService

-     public interface InetServService

- - ### Method Summary

    All Methods Instance Methods Abstract Methods Deprecated Methods
    Modifier and Type | Method and Description
    --- | ---
    `int` | `authorizationRequest(int contractId, int servId, boolean accountingPeriodActivate, long timeout)`
    `byte[]` | `inetGetIpFromParent(InetServ serv)`
    `void` | `inetOptionDelete(int id)`
    `InetOption` | `inetOptionGet(int id)`
    `java.util.List<InetOption>` | `inetOptionList()`
    `void` | `inetOptionMove(int newParentId, java.util.Set<java.lang.Integer> ids)`
    `InetOption` | `inetOptionTree()`
    `int` | `inetOptionUpdate(InetOption b)`
    `void` | `inetServDelete(int id)` Deprecated.
    `void` | `inetServDelete(int id, boolean force)` Удаление сервиса договора по его ID.
    `InetServ` | `inetServGet(int inetServId)` Получение сервиса (аккаунта) договора по его ID.
    `void` | `inetServIsActive(InetServ inetServ)`
    `java.util.List<InetServ>` | `inetServList(int contractId)` Deprecated. Use {@link #inetServList(int, String) instead
    `java.util.List<InetServ>` | `inetServList(int contractId, java.lang.String orderBy)` Получение списка сервисов определенного договора с возможностью сортировки списка.
    `java.lang.String` | `inetServLoginGenerate()`
    `void` | `inetServMove(InetServ inetServ, int cidTo)`
    `java.util.List<InetServOption>` | `inetServOptionList(int inetServId)`
    `java.lang.String` | `inetServPasswordGenerate(int inetServTypeId)`
    `java.util.List<InetServRestriction>` | `inetServRestrictionList(int inetServId)` Deprecated.
    `java.util.List<InetServRestriction>` | `inetServRestrictionList(int contractId, int inetServId)`
    `void` | `inetServRestrictionListUpdate(int contractId, int inetServId, java.util.List<InetServRestriction> restrictionList)`
    `void` | `inetServRestrictionListUpdate(int inetServId, java.util.List<InetServRestriction> restrictionList)` Deprecated.
    `void` | `inetServSaReinit(int id)`
    `void` | `inetServStateModify(int inetServId, short state, int accessCode)`
    `InetServ` | `inetServTree(int contractId)` Получение дерева сервисов (аккаунтов) договора.
    `void` | `inetServTypeDelete(int id)` Удаление типа сервиса.
    `InetServType` | `inetServTypeGet(int id)` Получение типа сервиса по его ID.
    `java.util.List<InetServType>` | `inetServTypeList()` Получение списка типов сервиса.
    `int` | `inetServTypeUpdate(InetServType b)` Создание/обновление типа сервиса.
    `int` | `inetServUpdate(InetServ inetServ, java.util.List<InetServOption> optionList, boolean generateLogin, boolean generatePassword, long saWaitTimeout)` Создание/обновление сервиса договора.
    `void` | `inetServWrap(InetServ inetServ, int cidTo, java.util.Date date)`
    `java.util.List<java.lang.Integer>` | `ipResourceCategoryIds(int deviceId, int interfaceId, int serviceTypeId)`
    `java.lang.String` | `ipResourceLinkCheck()`
    `void` | `ipResourceLinkSet()`
    `java.util.List<InetServ>` | `searchInetServ(java.lang.String login, IpRange ip, int serviceTypeId, int vlan, java.lang.String title, java.lang.String identifier, java.lang.String macAddress, boolean loginStrictCheck)`
    `void` | `trafficTypeDelete(int id)`
    `TrafficType` | `trafficTypeGet(int id)`
    `void` | `trafficTypeLinkDelete(int id)`
    `TrafficTypeLink` | `trafficTypeLinkGet(int id)`
    `java.util.List<TrafficTypeLink>` | `trafficTypeLinkList()`
    `int` | `trafficTypeLinkUpdate(TrafficTypeLink b)`
    `java.util.List<TrafficType>` | `trafficTypeList()`
    `int` | `trafficTypeUpdate(TrafficType b)`
    `int` | `vlanResourceCategoryId(int deviceId)` Deprecated.
    `java.util.Set<java.lang.Integer>` | `vlanResourceCategoryIds(int deviceId)`

- - ### Method Detail

    - #### inetServTypeGet

          InetServType inetServTypeGet(int id)
                                throws ru.bitel.bgbilling.common.BGException

      Получение типа сервиса по его ID.
      Parameters:
        `id` - ID типа сервиса.
      Returns:
        тип сервиса.
      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### inetServTypeList

          java.util.List<InetServType> inetServTypeList()
                                                 throws ru.bitel.bgbilling.common.BGException

      Получение списка типов сервиса.
      Returns:
        список типов сервиса.
      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### inetServTypeUpdate

          int inetServTypeUpdate(InetServType b)
                          throws ru.bitel.bgbilling.common.BGException

      Создание/обновление типа сервиса.
      Parameters:
        `b` - обновляемый тип сервиса, если id<=0, то создается новый.
      Returns:
        ID созданного/обновленного типа сервиса.
      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### inetServTypeDelete

          void inetServTypeDelete(int id)
                           throws ru.bitel.bgbilling.common.BGException

      Удаление типа сервиса. Если в БД есть сервисы данного типа, то будет брошен BGMessageException.
      Parameters:
        `id` - ID типа сервиса.
      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### inetServGet

          InetServ inetServGet(int inetServId)
                        throws ru.bitel.bgbilling.common.BGException

      Получение сервиса (аккаунта) договора по его ID.
      Parameters:
        `inetServId` - ID сервиса.
      Returns:
        сервис договора.
      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### inetServList

          @RequestWrapper(className="ru.bitel.bgbilling.modules.inet.api.common.service.jaxws.InetServListOldRequest")
           @ResponseWrapper(className="ru.bitel.bgbilling.modules.inet.api.common.service.jaxws.InetServListOldResponse")
           @Deprecated
          java.util.List<InetServ> inetServList(int contractId)
                                                                                                                                                                                                                                                                                   throws ru.bitel.bgbilling.common.BGException

      Deprecated. Use {@link #inetServList(int, String) instead
      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### inetServList

          java.util.List<InetServ> inetServList(int contractId,
                                                java.lang.String orderBy)
                                         throws ru.bitel.bgbilling.common.BGException

      Получение списка сервисов определенного договора с возможностью сортировки списка.
      Parameters:
        `contractId` - код договора.
        `orderBy` - строка с параметрами сортировки. Используется в sql-выражении order by по полям таблицы inet_serv_-MID-. Если сортировка не требуется, то в данный метод можно передать null.
      Returns:
        список сервисов договора.
      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### inetServTree

          InetServ inetServTree(int contractId)
                         throws ru.bitel.bgbilling.common.BGException

      Получение дерева сервисов (аккаунтов) договора.
      Parameters:
        `contractId` - ID договора
      Returns:
        дерево сервисов договора, корень данного дерева - фиктивный сервис с ID=0.
      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### inetServUpdate

          int inetServUpdate(InetServ inetServ,
                             java.util.List<InetServOption> optionList,
                             boolean generateLogin,
                             boolean generatePassword,
                             long saWaitTimeout)
                      throws ru.bitel.bgbilling.common.BGException,
                             ru.bitel.bgbilling.common.BGMessageException

      Создание/обновление сервиса договора.
      Parameters:
        `inetServ` - сервис (аккаунт) договора.
        `optionList` - список статических опций.
        `generateLogin` - нужно ли генерировать логин (или использовать тот, что в переданном объекте inetServ).
        `generatePassword` - нужно ли генерировать пароль (или использовать тот, что в переданном объекте inetServ).
        `saWaitTimeout` -
      Returns:
        ID созданного/обновленного сервиса договора.
      Throws:
        `ru.bitel.bgbilling.common.BGException`
        `ru.bitel.bgbilling.common.BGMessageException`

    - #### inetServDelete

          @RequestWrapper(className="ru.bitel.bgbilling.modules.inet.api.common.service.jaxws.InetServDeleteOldRequest")
           @ResponseWrapper(className="ru.bitel.bgbilling.modules.inet.api.common.service.jaxws.InetServDeleteOldResponse")
           @Deprecated
          void inetServDelete(int id)
                                                                                                                                                                                                                                                                     throws ru.bitel.bgbilling.common.BGException

      Deprecated.
      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### inetServDelete

          void inetServDelete(int id,
                              boolean force)
                       throws ru.bitel.bgbilling.common.BGException

      Удаление сервиса договора по его ID.
      Parameters:
        `id` - ID сервиса договора.
        `force` - если true - то принудительное удаление договора, без проверки на период и активные сессии.
      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### inetServIsActive

          void inetServIsActive(InetServ inetServ)
                         throws ru.bitel.bgbilling.common.BGException

      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### inetServStateModify

          void inetServStateModify(int inetServId,
                                   short state,
                                   int accessCode)
                            throws ru.bitel.bgbilling.common.BGException

      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### inetServLoginGenerate

          java.lang.String inetServLoginGenerate()
                                          throws ru.bitel.bgbilling.common.BGException

      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### inetServPasswordGenerate

          java.lang.String inetServPasswordGenerate(int inetServTypeId)
                                             throws ru.bitel.bgbilling.common.BGException

      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### inetServWrap

          void inetServWrap(InetServ inetServ,
                            int cidTo,
                            java.util.Date date)
                     throws ru.bitel.bgbilling.common.BGException

      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### inetServMove

          void inetServMove(InetServ inetServ,
                            int cidTo)
                     throws ru.bitel.bgbilling.common.BGException

      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### inetOptionGet

          InetOption inetOptionGet(int id)
                            throws ru.bitel.bgbilling.common.BGException

      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### inetOptionList

          java.util.List<InetOption> inetOptionList()
                                             throws ru.bitel.bgbilling.common.BGException

      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### inetOptionTree

          InetOption inetOptionTree()
                             throws ru.bitel.bgbilling.common.BGException

      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### inetOptionUpdate

          int inetOptionUpdate(InetOption b)
                        throws ru.bitel.bgbilling.common.BGException

      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### inetOptionDelete

          void inetOptionDelete(int id)
                         throws ru.bitel.bgbilling.common.BGException

      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### inetOptionMove

          void inetOptionMove(int newParentId,
                              java.util.Set<java.lang.Integer> ids)
                       throws ru.bitel.bgbilling.common.BGException

      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### trafficTypeGet

          TrafficType trafficTypeGet(int id)
                              throws ru.bitel.bgbilling.common.BGException

      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### trafficTypeList

          java.util.List<TrafficType> trafficTypeList()
                                               throws ru.bitel.bgbilling.common.BGException

      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### trafficTypeUpdate

          int trafficTypeUpdate(TrafficType b)
                         throws ru.bitel.bgbilling.common.BGException

      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### trafficTypeDelete

          void trafficTypeDelete(int id)
                          throws ru.bitel.bgbilling.common.BGException

      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### trafficTypeLinkGet

          TrafficTypeLink trafficTypeLinkGet(int id)
                                      throws ru.bitel.bgbilling.common.BGException

      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### trafficTypeLinkList

          java.util.List<TrafficTypeLink> trafficTypeLinkList()
                                                       throws ru.bitel.bgbilling.common.BGException

      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### trafficTypeLinkUpdate

          int trafficTypeLinkUpdate(TrafficTypeLink b)
                             throws ru.bitel.bgbilling.common.BGException

      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### trafficTypeLinkDelete

          void trafficTypeLinkDelete(int id)
                              throws ru.bitel.bgbilling.common.BGException

      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### inetServOptionList

          java.util.List<InetServOption> inetServOptionList(int inetServId)
                                                     throws ru.bitel.bgbilling.common.BGException

      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### inetServRestrictionList

          @RequestWrapper(className="ru.bitel.bgbilling.modules.inet.api.common.service.jaxws.InetServRestrictionListOldRequest")
           @ResponseWrapper(className="ru.bitel.bgbilling.modules.inet.api.common.service.jaxws.InetServRestrictionListOldResponse")
           @Deprecated
          java.util.List<InetServRestriction> inetServRestrictionList(int inetServId)
                                                                                                                                                                                                                                                                                                                               throws ru.bitel.bgbilling.common.BGException

      Deprecated.
      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### inetServRestrictionList

          java.util.List<InetServRestriction> inetServRestrictionList(int contractId,
                                                                      int inetServId)
                                                               throws ru.bitel.bgbilling.common.BGException

      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### inetServRestrictionListUpdate

          @RequestWrapper(className="ru.bitel.bgbilling.modules.inet.api.common.service.jaxws.InetServRestrictionListUpdateOldRequest")
           @ResponseWrapper(className="ru.bitel.bgbilling.modules.inet.api.common.service.jaxws.InetServRestrictionListUpdateOldResponse")
           @Deprecated
          void inetServRestrictionListUpdate(int inetServId,
                                                                                                                                                                                                                                                                                                                         java.util.List<InetServRestriction> restrictionList)
                                                                                                                                                                                                                                                                                                                  throws ru.bitel.bgbilling.common.BGException

      Deprecated.
      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### inetServRestrictionListUpdate

          void inetServRestrictionListUpdate(int contractId,
                                             int inetServId,
                                             java.util.List<InetServRestriction> restrictionList)
                                      throws ru.bitel.bgbilling.common.BGException

      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### vlanResourceCategoryId

          @Deprecated
          int vlanResourceCategoryId(int deviceId)
                                          throws ru.bitel.bgbilling.common.BGException

      Deprecated.
      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### vlanResourceCategoryIds

          java.util.Set<java.lang.Integer> vlanResourceCategoryIds(int deviceId)
                                                            throws ru.bitel.bgbilling.common.BGException

      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### ipResourceCategoryIds

          java.util.List<java.lang.Integer> ipResourceCategoryIds(int deviceId,
                                                                  int interfaceId,
                                                                  int serviceTypeId)
                                                           throws ru.bitel.bgbilling.common.BGException

      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### searchInetServ

          java.util.List<InetServ> searchInetServ(java.lang.String login,
                                                  IpRange ip,
                                                  int serviceTypeId,
                                                  int vlan,
                                                  java.lang.String title,
                                                  java.lang.String identifier,
                                                  java.lang.String macAddress,
                                                  boolean loginStrictCheck)
                                           throws ru.bitel.bgbilling.common.BGException

      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### inetServSaReinit

          void inetServSaReinit(int id)
                         throws ru.bitel.bgbilling.common.BGException

      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### ipResourceLinkCheck

          java.lang.String ipResourceLinkCheck()
                                        throws ru.bitel.bgbilling.common.BGException

      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### ipResourceLinkSet

          void ipResourceLinkSet()
                          throws ru.bitel.bgbilling.common.BGException

      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### inetGetIpFromParent

          byte[] inetGetIpFromParent(InetServ serv)
                              throws ru.bitel.bgbilling.common.BGException

      Throws:
        `ru.bitel.bgbilling.common.BGException`

    - #### authorizationRequest

          int authorizationRequest(int contractId,
                                   int servId,
                                   boolean accountingPeriodActivate,
                                   long timeout)
                            throws ru.bitel.bgbilling.common.BGException

      Throws:
        `ru.bitel.bgbilling.common.BGException`