public interface CardPlugin
Modifier and Type | Method and Description |
---|---|
default void |
cardSearchFinished(CardSearchFinishedRequest request)
Метод обработки окончания поиска карты/купона.
В данном методе допустимо вызывать UIForms .NOTE: Может не вызываться в некоторых случаях при добавлении купона. |
default CardInfo |
getCardInfo(CardInfoRequest request)
Возвращает информацию о карте для отображения при вызове функции "Инфо по карте".
|
default CardInfo |
getCardInfo(CardSearchRequest request)
Deprecated.
метод не будет вызываться кассой, если реализован метод
getCardInfo(CardInfoRequest) |
default BonusOperationResponse |
rollback(java.lang.String txId)
Отмена списания бонусов.
|
CardSearchResponse |
searchCard(CardSearchRequest request)
Поиск информации по карте на основе предоставленных данных для поиска.
|
default void |
searchCardAsync(CardSearchRequest request,
CardSearchCallback callback)
Поиск информации по карте на основе предоставленных данных для поиска.
В качестве данных для поиска в метод могут быть переданы email или номер телефона. |
default void |
searchCardByMobileNumber(java.lang.String mobileNumber,
CardSearchCallback callback)
Deprecated.
метод устарел и не рекомендуется к использованию. Используйте метод
searchCardAsync(CardSearchRequest, CardSearchCallback)
В случае, если метод имеет реализацию (использует калбек), требуется чтобы searchCardAsync(CardSearchRequest, CardSearchCallback) не был реализован.
Для корректной работы кассы требуется, чтобы один из этих методов был реализован! |
default CardValidationResponse |
validateCard(CardValidationRequest request)
Метод валидации карт, с помощью которого можно запретить добавление в чек любой карты.
|
default BonusWriteOffOperationResponse |
writeOff(Card bonusCard,
java.math.BigDecimal amount,
BonusBalance balance,
Receipt receipt)
Производит списание бонусов/фишек с указанной карты.
|
default BonusWriteOffOperationResponse |
writeOff(Card bonusCard,
java.math.BigDecimal bonusesToWriteOff,
Receipt receipt)
Производит списание бонусов с указанной карты.
|
default void |
writeOffAsync(Card bonusCard,
java.math.BigDecimal amount,
BonusBalance balance,
Receipt receipt,
BonusWriteOffCallback callback)
Производит списание бонусов с указанной карты.
|
default void |
writeOffAsync(Card bonusCard,
java.math.BigDecimal amount,
Receipt receipt,
BonusWriteOffCallback callback)
Производит списание бонусов с указанной карты.
|
CardSearchResponse searchCard(CardSearchRequest request)
request
- исходные данные для поиска картыnull
; при возникновении нештатных ситуаций следует возвращать объект с не-позитивным
статусом
обработки запросаdefault void searchCardAsync(CardSearchRequest request, CardSearchCallback callback)
searchCardByMobileNumber(String, CardSearchCallback)
не был реализован.
В любом случае для корректной работы кассы требуется, чтобы один из этих методов был реализован!request
- исходные данные для поиска картыcallback
- калбек, который вызовется при завершении операции@Deprecated default void searchCardByMobileNumber(java.lang.String mobileNumber, CardSearchCallback callback)
searchCardAsync(CardSearchRequest, CardSearchCallback)
В случае, если метод имеет реализацию (использует калбек), требуется чтобы searchCardAsync(CardSearchRequest, CardSearchCallback)
не был реализован.
Для корректной работы кассы требуется, чтобы один из этих методов был реализован!mobileNumber
- номер мобильного телефона, по которому необходимо найти карту.callback
- калбек, который вызовется по завершению операцииdefault CardValidationResponse validateCard(CardValidationRequest request)
request
- данные для валидацииdefault void cardSearchFinished(CardSearchFinishedRequest request)
UIForms
.request
- запрос при окончании поиска карты/купонаdefault BonusWriteOffOperationResponse writeOff(Card bonusCard, java.math.BigDecimal bonusesToWriteOff, Receipt receipt)
UIForms
, вызов методов этого класса не будет иметь эффекта.bonusCard
- бонусная карта, с баланса которой собираемся списать бонусыbonusesToWriteOff
- количество бонусов для списанияreceipt
- чек, в котором производится данное списание бонусовBonusWriteOffOperationResponse
, описывающую результат выполнения операции или null, если данный
метод плагином не используется для списания и следует вызывать метод writeOffAsync(Card, BigDecimal, Receipt, BonusWriteOffCallback)
.writeOffAsync(Card, BigDecimal, Receipt, BonusWriteOffCallback)
,
writeOffAsync(Card, BigDecimal, Receipt, BonusWriteOffCallback)
default BonusWriteOffOperationResponse writeOff(Card bonusCard, java.math.BigDecimal amount, BonusBalance balance, Receipt receipt)
bonusCard
- бонусная карта, с баланса которой собираемся списать бонусыamount
- количество бонусов/фишек для списанияbalance
- баланс, с которого следует списатьreceipt
- чек, в котором производится данное списание бонусовBonusWriteOffOperationResponse
, описывающую результат выполнения операции или null, если данный
метод плагином не используется для списания и следует вызывать метод writeOffAsync(Card, BigDecimal, Receipt, BonusWriteOffCallback)
.writeOffAsync(Card, BigDecimal, Receipt, BonusWriteOffCallback)
default void writeOffAsync(Card bonusCard, java.math.BigDecimal amount, Receipt receipt, BonusWriteOffCallback callback)
BonusWriteOffCallback.onBonusWriteOffCompleted(BonusWriteOffOperationResponse)
.
В отличии отметода writeOff(Card, BigDecimal, Receipt)
, в данном методе разрешено использовать UIForms
.writeOff(Card, BigDecimal, Receipt)
, а должен
реализовывать её здесь. Методу writeOff(Card, BigDecimal, Receipt)
в таком случае требуется возвращать null.writeOff(Card, BigDecimal, Receipt)
bonusCard
- бонусная карта, требуется списать бонусы с которойamount
- величина к списаниюreceipt
- чек, в рамках которого производится списание бонусовcallback
- структура, содержащая метод обратного вызова, через который кассе будет передан результат списания бонусов.writeOff(Card, BigDecimal, Receipt)
default void writeOffAsync(Card bonusCard, java.math.BigDecimal amount, BonusBalance balance, Receipt receipt, BonusWriteOffCallback callback)
bonusCard
- бонусная карта, требуется списать бонусы с которойamount
- величина к списаниюbalance
- баланс, с которого следует списатьreceipt
- чек, в рамках которого производится списание бонусовcallback
- структура, содержащая метод обратного вызова, через который кассе будет передан результат списания бонусов.writeOff(Card, BigDecimal, Receipt)
default BonusOperationResponse rollback(java.lang.String txId)
txId
- идентификатор
транзакции списания бонусов, что надо "откатить"null
- результат выполнения операции@Deprecated default CardInfo getCardInfo(CardSearchRequest request)
getCardInfo(CardInfoRequest)
request
- номер карты, по которой следует получить информацию.default CardInfo getCardInfo(CardInfoRequest request)
request
- данные карты, по которой следует получить информацию.