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

# Interface ChargeService

public interface ChargeService

- ## Method Summary

  Modifier and Type
  Method
  Description
  `int`
  `chargeDelete(int chargeId)`
  Удаление расхода договора.
  `int`
  `chargeDelete(int contractId, int chargeId)`
  Удаление расхода договора.
  `Charge`
  `chargeGet(int chargeId)`
  Получение расхода договора по его ид.
  `SearchResult<Charge>`
  `chargeList(int contractId, int type, Period period, int members)`
  Получает список расходов для договора
  `int`
  `chargeTypeDelete(int chargeTypeId)`
  Удаление типа расход/возврат.
  `ChargeType`
  `chargeTypeGet(int chargeTypeId)`
  Получение типа расхода.
  На прямую лучше не использовать, берите через справочник</>.
  `List<ChargeType>`
  `chargeTypeList(Integer editable, Integer type, Boolean isPayback)`
  Получение списка типов расхода.
  Если нужны все, на прямую лучше не использовать, берите через справочник.
  `void`
  `chargeTypeMove(int chargeTypeId, List<Integer> idList)`
  Один из способов редактирования типа расход, если необходимо изменить положение типов расхода в дереве.
  `PaymentTypeItem`
  `chargeTypeTree(int editable, boolean isPayback, boolean showEmptyRoot)`
  Получение дерева типов.
  `int`
  `chargeTypeUpdate(ChargeType chargeType)`
  Обновление или создание типа расход/возврат
  `int`
  `chargeUpdate(Charge charge)`
  Создание или обновление расхода.
  `SearchResult<Charge>`
  `paybackList(int contractId, int paybackTypeId, Period period, int members)`
  Получает список возвратов для договора

- ## Method Details

  - ### chargeGet

    Charge chargeGet(int chargeId) throws Exception
    Получение расхода договора по его ид.
    Throws:
      `Exception`

  - ### chargeList

    SearchResult<Charge> chargeList(int contractId, int type, Period period, int members) throws Exception
    Получает список расходов для договора
    Parameters:
      `contractId` - код договора.
      `type` - код типа расхода, если <1, то значит всех типов.
      `period` - период начисления расхода для поиска.
      `members` - - если == 1, то только расходы данного договора, если = 2 то вернет еще и расходы з.субдоговоров, если = 3 то только расходы зависемых субдоговоров.
      `holderTotalSum` - - возвращаемое поле, если != null, то сюда занесется общая сумма по всем выбранным приходам. Если вам не нужно это, ставте null.
    Throws:
      `Exception`

  - ### chargeDelete

    @RequestWrapper(className="ru.bitel.bgbilling.kernel.contract.balance.common.jaxws.ChargeDeleteByIdRequest") @ResponseWrapper(className="ru.bitel.bgbilling.kernel.contract.balance.common.jaxws.ChargeDeleteByIdResponse") int chargeDelete(int chargeId) throws Exception
    Удаление расхода договора.
    Parameters:
      `chargeId` -
    Returns:
      - кол-во удаленных строк
    Throws:
      `Exception`

  - ### chargeDelete

    int chargeDelete(int contractId, int chargeId) throws Exception
    Удаление расхода договора.
    Parameters:
      `chargeId` -
    Returns:
      - кол-во удаленных строк
    Throws:
      `Exception`

  - ### chargeUpdate

    int chargeUpdate(Charge charge) throws Exception
    Создание или обновление расхода.
    Parameters:
      `charge` - - bean расхода.
    Returns:
      ид созданного/обнавленного расхода.
    Throws:
      `Exception`

  - ### paybackList

    SearchResult<Charge> paybackList(int contractId, int paybackTypeId, Period period, int members) throws Exception
    Получает список возвратов для договора
    Parameters:
      `contractId` - код договора.
      `period` - период начисления возврата для поиска.
      `members` - - если == 1, то только возвраты данного договора, если = 2 то вернет еще и расходы з.субдоговоров, если = 3 то только возвраты зависемых субдоговоров.4
      `holderTotalSum` - - возвращаемое поле, если != null, то сюда занесется общая сумма по всем выбранным приходам. Если вам не нужно это, ставте null.
    Throws:
      `Exception`

  - ### chargeTypeGet

    ChargeType chargeTypeGet(int chargeTypeId) throws Exception
    Получение типа расхода.
    На прямую лучше не использовать, берите через справочник</>.
    Parameters:
      `chargeTypeId` - - ид типа расхода.
    Throws:
      `Exception`

  - ### chargeTypeList

    List<ChargeType> chargeTypeList(Integer editable, Integer type, Boolean isPayback) throws Exception
    Получение списка типов расхода.
    Если нужны все, на прямую лучше не использовать, берите через справочник.
    Parameters:
      `editable` - если = 0 - только редактируемые, = 1 - не редактируемые, null или меньше 0 - все.
      `type` - - 0 - элемент группы, 1 - группа, null или меньше 0 - все
      `isPayback` - - если true, то возврат , если false приход, если null - все. Если editable или type будут иметь другие значения, то результатом будет пустой список.
    Throws:
      `Exception`

  - ### chargeTypeTree

    PaymentTypeItem chargeTypeTree(int editable, boolean isPayback, boolean showEmptyRoot) throws Exception
    Получение дерева типов.
    Parameters:
      `editable` - - 0 - редактируемые, 1 - не редактируемые, меньше 0 - все.
      `isPayback` - - если true то только возвраты, false - расходы
      `showEmptyRoot` - - показывать ли пустые элементы группы.
    Throws:
      `Exception`

  - ### chargeTypeMove

    void chargeTypeMove(int chargeTypeId, List<Integer> idList) throws Exception
    Один из способов редактирования типа расход, если необходимо изменить положение типов расхода в дереве.
    Parameters:
      `chargeTypeId` - - ид типа в который станет предком
      `idList` - - список ид которые будут перемещены.
    Throws:
      `Exception`

  - ### chargeTypeUpdate

    int chargeTypeUpdate(ChargeType chargeType) throws Exception
    Обновление или создание типа расход/возврат
    Parameters:
      `chargeTypeId` -
    Returns:
    Throws:
      `BGMessageException` - - если передаваемый тип == null, или его поля неворно заполнены.
      `Exception`

  - ### chargeTypeDelete

    int chargeTypeDelete(int chargeTypeId) throws Exception
    Удаление типа расход/возврат.
    Parameters:
      `chargeTypeId` - - код удаляемого расхода.
    Returns:
      - число удаленных записей.
    Throws:
      `BGMessageException` - - в случае, если удаление невозможно в связи с нарушением ссылочной целостности.
      `Exception`