Interface PaymentService
public interface PaymentService
Сервайс для приходов и типов приходов.
Все операции над типом приход(PaymentType), настоятельно рекомендую совершать через справочники, такие как обновление(создание), удаление, получение элемента и получение списка всех типов.
Например так: getContext().getDirectory( PaymentType.class ).update/delete/list</>
Например так: getContext().getDirectory( PaymentType.class ).update/delete/list</>
-
Method Summary
Modifier and TypeMethodDescriptionvoid
deletePaymentInfo
(int paymentInfoId) int
paymentDelete
(int contractId, int paymentId) Удаление прихода договора.paymentGet
(int paymentId) Получение приходаpaymentInfoByPaymentId
(int paymentId) Получение дополнительной информации по ID платежаpaymentInfoByPaymentIds
(List<Integer> paymentIds) Получение списка дополнительной информации по платежамpaymentList
(int contractId, Period period, int members) Возвращает список платежей за период для договора отсортированный по датеint
paymentTypeDelete
(int paymentTypeId) Удаление типа прихода.paymentTypeGet
(int paymentTypeId) Метод в первую очередь для directory, соответсвенно если нужет paymentType, то вытаскиваем его через directory, а не от сюда.paymentTypeList
(Integer editable, Integer type) Получение списка типов прихода.void
paymentTypeMove
(int paymentTypeId, List<Integer> idList) Один из способов редактирования типа приход, если необходимо изменить положение типов приход в дереве.paymentTypeTree
(int editable, boolean showEmptyRoot) int
paymentTypeUpdate
(PaymentType paymentType) Обновление или создание типа приход.paymentUpdate
(Payment payment, String distribution) Обновление или создание прихода.void
updatePaymentInfo
(PaymentInfo paymentInfo)
-
Method Details
-
paymentGet
Payment paymentGet(int paymentId) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException Получение прихода- Parameters:
paymentId
- - ид прихода.- Throws:
ru.bitel.bgbilling.common.BGException
ru.bitel.bgbilling.common.BGMessageException
-
paymentList
SearchResult<Payment> paymentList(int contractId, Period period, int members) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException Возвращает список платежей за период для договора отсортированный по дате- Parameters:
contractId
- код договораperiod
- период, null - все платежи, можно что бы значения dateFrom и dateTo были равны null.members
- - если == 1, то только платежы данного договора, если = 2 то вернет еще и платежы з.субдоговоров, если = 3 то только платежы зависемых субдоговоров.holderTotalSum
- - возвращаемое поле, если != null, то сюда занесется общая сумма по всем выбранным приходам. Если вам не нужно это, ставте null.- Returns:
- список платежей, если платежей нет, возвращает пустой список
- Throws:
ru.bitel.bgbilling.common.BGException
ru.bitel.bgbilling.common.BGMessageException
-
paymentDelete
int paymentDelete(int contractId, int paymentId) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException Удаление прихода договора.- Parameters:
paymentId
- - код платежа.- Returns:
- - кол-во удаленных записей.
- Throws:
ru.bitel.bgbilling.common.BGException
ru.bitel.bgbilling.common.BGMessageException
-
paymentUpdate
List<Integer> paymentUpdate(Payment payment, String distribution) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException Обновление или создание прихода.- Parameters:
payment
- - bean в котором все данные и должны лежать.distribution
- - при создании, если != null, распределяет сумму прихода между указанными договорами.( форамат: cid : sum,..... )- Throws:
ru.bitel.bgbilling.common.BGException
ru.bitel.bgbilling.common.BGMessageException
-
paymentTypeGet
PaymentType paymentTypeGet(int paymentTypeId) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException Метод в первую очередь для directory, соответсвенно если нужет paymentType, то вытаскиваем его через directory, а не от сюда.- Parameters:
paymentTypeId
- - ид типа платежа.- Throws:
ru.bitel.bgbilling.common.BGException
ru.bitel.bgbilling.common.BGMessageException
-
paymentTypeList
List<PaymentType> paymentTypeList(Integer editable, Integer type) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException Получение списка типов прихода.- Parameters:
editable
- если = 0 - только редактируемые, = 1 - не редактируемые, null - все.type
- - 0 - элемент группы, 1 - группа, null - все Если editable или type будут иметь другие значения, то результатом будет пустой список.- Throws:
ru.bitel.bgbilling.common.BGException
ru.bitel.bgbilling.common.BGMessageException
-
paymentTypeTree
PaymentTypeItem paymentTypeTree(int editable, boolean showEmptyRoot) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException - Parameters:
editable
- 0 - редактируемые, 1 - не редактируемые, меньше 0 - все.
(смотреть статик поля PaymentType или точнее его родителя)showEmptyRoot
- - показывать ли пустые элементы группы.- Throws:
ru.bitel.bgbilling.common.BGException
ru.bitel.bgbilling.common.BGMessageException
-
paymentTypeUpdate
int paymentTypeUpdate(PaymentType paymentType) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException Обновление или создание типа приход.- Parameters:
paymentType
-- Throws:
ru.bitel.bgbilling.common.BGMessageException
- - если передаваемый тип == null, или его поля неворно заполнены.ru.bitel.bgbilling.common.BGException
-
paymentTypeDelete
int paymentTypeDelete(int paymentTypeId) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException Удаление типа прихода.- Parameters:
paymentTypeId
- - ид типа приход.- Returns:
- - кол-во удаленных значений.
- Throws:
ru.bitel.bgbilling.common.BGMessageException
- - в случае, если удаление невозможно в связи с нарушением ссылочной целостности.ru.bitel.bgbilling.common.BGException
-
paymentTypeMove
void paymentTypeMove(int paymentTypeId, List<Integer> idList) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException Один из способов редактирования типа приход, если необходимо изменить положение типов приход в дереве.- Parameters:
chargeTypeId
- - ид типа в который станет предкомidList
- - список ид которые будут перемещены.- Throws:
ru.bitel.bgbilling.common.BGException
ru.bitel.bgbilling.common.BGMessageException
-
paymentInfoByPaymentId
PaymentInfo paymentInfoByPaymentId(int paymentId) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException Получение дополнительной информации по ID платежа- Parameters:
paymentId
- ID платежа- Returns:
- Throws:
ru.bitel.bgbilling.common.BGException
ru.bitel.bgbilling.common.BGMessageException
-
paymentInfoByPaymentIds
List<PaymentInfo> paymentInfoByPaymentIds(List<Integer> paymentIds) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException Получение списка дополнительной информации по платежам- Parameters:
paymentIds
- список ID платежей- Returns:
- key - ID платежа, value - доп. информация
- Throws:
ru.bitel.bgbilling.common.BGException
ru.bitel.bgbilling.common.BGMessageException
-
updatePaymentInfo
- Throws:
ru.bitel.bgbilling.common.BGException
-
deletePaymentInfo
void deletePaymentInfo(int paymentInfoId) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException - Throws:
ru.bitel.bgbilling.common.BGException
ru.bitel.bgbilling.common.BGMessageException
-