CardPlugin (Set10POSAPI 0.0.0_DO_NOT_CHANGE

All Known Subinterfaces:

CardIssuePlugin
```
public interface CardPlugin
```
Интерфейс плагина карт (процессинга карт/купонов лояльности).

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
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)` Производит списание бонусов с указанной карты.

- Method Detail
  - searchCard
```
CardSearchResponse searchCard(CardSearchRequest request)
```
    Поиск информации по карте на основе предоставленных данных для поиска.
    
    Parameters:
    
    request - исходные данные для поиска карты
    
    Returns:
    
    не null; при возникновении нештатных ситуаций следует возвращать объект с не-позитивным статусом обработки запроса
  - searchCardAsync
```
default void searchCardAsync(CardSearchRequest request,
                             CardSearchCallback callback)
```
    Поиск информации по карте на основе предоставленных данных для поиска.
    В качестве данных для поиска в метод могут быть переданы email или номер телефона. Метод не асинхронный, использует калбек для передачи результата, управление возвращает при первой же возможности. В случае, если метод имеет реализацию (использует калбек), требуется чтобы searchCardByMobileNumber(String, CardSearchCallback) не был реализован. В любом случае для корректной работы кассы требуется, чтобы один из этих методов был реализован!
    
    Parameters:
    
    request - исходные данные для поиска карты
    
    callback - калбек, который вызовется при завершении операции
    
    Since:
    
    0.0.43
  - searchCardByMobileNumber
```
@Deprecated
default void searchCardByMobileNumber(java.lang.String mobileNumber,
                                                  CardSearchCallback callback)
```
    Deprecated. метод устарел и не рекомендуется к использованию. Используйте метод searchCardAsync(CardSearchRequest, CardSearchCallback) В случае, если метод имеет реализацию (использует калбек), требуется чтобы searchCardAsync(CardSearchRequest, CardSearchCallback) не был реализован. Для корректной работы кассы требуется, чтобы один из этих методов был реализован!
    
    Выполняет поиск карты по номеру телефона.
    Метод не асинхронный, возвращает результат выполнения через метод обраного вызова, а управление при первой же возможности.
    
    Parameters:
    
    mobileNumber - номер мобильного телефона, по которому необходимо найти карту.
    
    callback - калбек, который вызовется по завершению операции
  - validateCard
```
default CardValidationResponse validateCard(CardValidationRequest request)
```
    Метод валидации карт, с помощью которого можно запретить добавление в чек любой карты.
    
    Parameters:
    
    request - данные для валидации
    
    Returns:
    
    результат валидации. По умолчанию любая карта считается валидной.
    
    Since:
    
    0.0.75
  - cardSearchFinished
```
default void cardSearchFinished(CardSearchFinishedRequest request)
```
    Метод обработки окончания поиска карты/купона.
    В данном методе допустимо вызывать UIForms.
    NOTE: Может не вызываться в некоторых случаях при добавлении купона.
    
    Parameters:
    
    request - запрос при окончании поиска карты/купона
    
    Since:
    
    1.0.0
  - writeOff
```
default BonusWriteOffOperationResponse writeOff(Card bonusCard,
                                                java.math.BigDecimal bonusesToWriteOff,
                                                Receipt receipt)
```
    Производит списание бонусов с указанной карты. Этот метод синхронный и не возвращает управление, пока списание не будет выполнено. Также в этом методе запрещено пользоваться UIForms, вызов методов этого класса не будет иметь эффекта.
    
    Parameters:
    
    bonusCard - бонусная карта, с баланса которой собираемся списать бонусы
    
    bonusesToWriteOff - количество бонусов для списания
    
    receipt - чек, в котором производится данное списание бонусов
    
    Returns:
    
    структуру BonusWriteOffOperationResponse, описывающую результат выполнения операции или null, если данный метод плагином не используется для списания и следует вызывать метод writeOffAsync(Card, BigDecimal, Receipt, BonusWriteOffCallback).
    
    See Also:
    
    writeOffAsync(Card, BigDecimal, Receipt, BonusWriteOffCallback), writeOffAsync(Card, BigDecimal, Receipt, BonusWriteOffCallback)
  - writeOff
```
default BonusWriteOffOperationResponse writeOff(Card bonusCard,
                                                java.math.BigDecimal amount,
                                                BonusBalance balance,
                                                Receipt receipt)
```
    Производит списание бонусов/фишек с указанной карты. Аналогичен методу #writeOff(Card, BigDecimal, Receipt), но можно указать баланс, с которого следует списать. Вызывается при списании фишек.
    
    Parameters:
    
    bonusCard - бонусная карта, с баланса которой собираемся списать бонусы
    
    amount - количество бонусов/фишек для списания
    
    balance - баланс, с которого следует списать
    
    receipt - чек, в котором производится данное списание бонусов
    
    Returns:
    
    структуру BonusWriteOffOperationResponse, описывающую результат выполнения операции или null, если данный метод плагином не используется для списания и следует вызывать метод writeOffAsync(Card, BigDecimal, Receipt, BonusWriteOffCallback).
    
    Since:
    
    0.0.60
    
    See Also:
    
    writeOffAsync(Card, BigDecimal, Receipt, BonusWriteOffCallback)
  - writeOffAsync
```
default void writeOffAsync(Card bonusCard,
                           java.math.BigDecimal amount,
                           Receipt receipt,
                           BonusWriteOffCallback callback)
```
    Производит списание бонусов с указанной карты. Этот метод не асинхронный, возвращает результат выполнения через метод обратного вызова, а управление при первой же возможности. Результат выполнения метода передаётся через метод обратного вызова BonusWriteOffCallback.onBonusWriteOffCompleted(BonusWriteOffOperationResponse). В отличии отметода writeOff(Card, BigDecimal, Receipt), в данном методе разрешено использовать UIForms.
    Если плагину требуется манипулировать UI при списании бонусов, он не должен реализовывать логику в методе writeOff(Card, BigDecimal, Receipt), а должен реализовывать её здесь. Методу writeOff(Card, BigDecimal, Receipt) в таком случае требуется возвращать null.
    Касса выбирает какой метод вызывать по следующему алгоритму:
    1. Вызвать метод writeOff(Card, BigDecimal, Receipt)
    2. Если метод вернул null, вызывать метод асинхронного списания.
    3. В противном случае не вызывать метод асинхронного списания.
    Parameters:
    
    bonusCard - бонусная карта, требуется списать бонусы с которой
    
    amount - величина к списанию
    
    receipt - чек, в рамках которого производится списание бонусов
    
    callback - структура, содержащая метод обратного вызова, через который кассе будет передан результат списания бонусов.
    
    Since:
    
    0.0.35
    
    See Also:
    
    writeOff(Card, BigDecimal, Receipt)
  - writeOffAsync
```
default void writeOffAsync(Card bonusCard,
                           java.math.BigDecimal amount,
                           BonusBalance balance,
                           Receipt receipt,
                           BonusWriteOffCallback callback)
```
    Производит списание бонусов с указанной карты. Аналогичен методу #writeOffAsync(Card, BigDecimal, Receipt, BonusWriteOffCallback), но можно указать баланс, с которого следует списать. Вызывается при списании фишек.
    
    Parameters:
    
    bonusCard - бонусная карта, требуется списать бонусы с которой
    
    amount - величина к списанию
    
    balance - баланс, с которого следует списать
    
    receipt - чек, в рамках которого производится списание бонусов
    
    callback - структура, содержащая метод обратного вызова, через который кассе будет передан результат списания бонусов.
    
    Since:
    
    0.0.60
    
    See Also:
    
    writeOff(Card, BigDecimal, Receipt)
  - rollback
```
default BonusOperationResponse rollback(java.lang.String txId)
```
    Отмена списания бонусов.
    
    Parameters:
    
    txId - идентификатор транзакции списания бонусов, что надо "откатить"
    
    Returns:
    
    не null - результат выполнения операции
  - getCardInfo
```
@Deprecated
default CardInfo getCardInfo(CardSearchRequest request)
```
    Deprecated. метод не будет вызываться кассой, если реализован метод getCardInfo(CardInfoRequest)
    
    Возвращает информацию о карте и её держателе.
    
    Parameters:
    
    request - номер карты, по которой следует получить информацию.
    
    Returns:
    
    информация о карте или иной результат, если карта не найдена.
  - getCardInfo
```
default CardInfo getCardInfo(CardInfoRequest request)
```
    Возвращает информацию о карте для отображения при вызове функции "Инфо по карте".
    
    Parameters:
    
    request - данные карты, по которой следует получить информацию.
    
    Returns:
    
    информация о карте или иной результат, если карта не найдена.
    
    Since:
    
    1.0.0

Interface CardPlugin

Method Summary

Method Detail

searchCard

searchCardAsync

searchCardByMobileNumber

validateCard

cardSearchFinished

writeOff

writeOff

writeOffAsync

writeOffAsync

rollback

getCardInfo

getCardInfo