ru.crystals.pos.spi.receipt

Interface Card

All Known Implementing Classes:

CardEntity

public interface Card

Интерфейс для получения информации о карте/купоне.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<BonusBalance>	getBalances() Получить балансы карты (может быть бонусный и фишечный)
BonusBalance	getBonusBalance() Получить бонусный баланс карты
CardHolder	getCardHolder() Получить владельца карты
java.lang.String	getCardNumber() Получить номер карты
CardStatus	getCardStatus() Получить статус данной карты/купона
CardType	getCardType() Получить тип карты
CardCategory	getCategory() Получить категорию к которой "принадлежит" карта/купон.
Counterparty	getCounterparty() Получить контрагент, которой привязан к карте
default java.util.Map<java.lang.String,java.lang.String>	getExtendedAttributes() Получает мапу атрибутов, которые были добавлены к карте. Позволяет добавлять к карте любые дополнительные параметры, которые затем можно использовать где-нибудь в другом месте.
java.lang.String	getId() Получить уникальный идентификатор карты - идентификатор достаточный для получения полной информации по данной карте
CardSearchEventSource	getInputType() Возвращает способ, которым карта была считана.
java.lang.String	getProcessingId() Получить идентификатор процессинга, которому "принадлежит" карта
default java.util.Optional<SearchInitiator>	getSearchInitiator() В случае инициирования поиска карты внешней системой возвращает информацию об этой системе.
default java.util.Optional<java.lang.String>	getSoftReceiptId() Возвращает идентификатор мягкого чека из которого добавлена карта
BonusBalance	getTokensBalance() Получить фишечный баланс карты

Method Detail

getId

java.lang.String getId()

Получить уникальный идентификатор карты - идентификатор достаточный для получения полной информации по данной карте

NOTE: в большинстве случаев будет совпадать с getCardNumber() номером} карты. Но возможны и исключения: например, это может быть NFC-метка - и информацию по карте (включая ее номер) можно получить только сделав запрос в процессинговый центр (передав туда эту NFC-метку) владельца данной карточной системы.

Returns:

идентификатор карты

getCardNumber

java.lang.String getCardNumber()

Получить номер карты

Returns:

null, если номер карты не известен

getCardType

CardType getCardType()

Получить тип карты

Returns:

тип карты

See Also:

CardType

getCardHolder

CardHolder getCardHolder()

Получить владельца карты

Returns:

null, если карта не персонализированная или владелец неизвестен

See Also:

CardHolder

getProcessingId

java.lang.String getProcessingId()

Получить идентификатор процессинга, которому "принадлежит" карта

Returns:

null, если идентификатор процессинга неизвестен

getBonusBalance

BonusBalance getBonusBalance()

Получить бонусный баланс карты

Returns:

null, если у карты нету бонусного баланса

See Also:

BonusBalance

getTokensBalance

BonusBalance getTokensBalance()

Получить фишечный баланс карты

Returns:

null, если у карты нету фишечного баланса

See Also:

BonusBalance

getBalances

java.util.Collection<BonusBalance> getBalances()

Получить балансы карты (может быть бонусный и фишечный)

Returns:

пустую коллекцию, если у карты нету балансов

See Also:

BonusBalance

getCardStatus

CardStatus getCardStatus()

Получить статус данной карты/купона

Returns:

null будет рассматриваться как CardStatus.ACTIVE

See Also:

CardStatus

getInputType

CardSearchEventSource getInputType()

Возвращает способ, которым карта была считана.

Returns:

способ, которым карта была считана.

Since:

0.0.31

getExtendedAttributes

default java.util.Map<java.lang.String,java.lang.String> getExtendedAttributes()

Получает мапу атрибутов, которые были добавлены к карте.
Позволяет добавлять к карте любые дополнительные параметры, которые затем можно использовать где-нибудь в другом месте.

Returns:

мапу атрибутов, которые были добавлены к карте или пустую мапу, если таких нет.

Since:

0.0.32

getCategory

CardCategory getCategory()

Получить категорию к которой "принадлежит" карта/купон.

Returns:

null, если категория не задана

Since:

0.0.72

getCounterparty

Counterparty getCounterparty()

Получить контрагент, которой привязан к карте

Returns:

null, если контрагент не задан

Since:

0.0.75

getSoftReceiptId

default java.util.Optional<java.lang.String> getSoftReceiptId()

Возвращает идентификатор мягкого чека из которого добавлена карта

Returns:

не null

Since:

1.12.0

getSearchInitiator

default java.util.Optional<SearchInitiator> getSearchInitiator()

В случае инициирования поиска карты внешней системой возвращает информацию об этой системе.

Например, если карта была найдена по номеру телефона, полученного от плагина проверки возраста метод вернёт информацию об этом плагине.

Returns:

информацию об внешней системе, инициировавшую поиск карты