ru.crystals.pos.api.card

Class CardEntity

java.lang.Object

ru.crystals.pos.api.card.CardEntity

All Implemented Interfaces:

Card

public class CardEntity
extends java.lang.Object
implements Card

Сущность, описывающая карту/купон.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<BonusBalance>	bonusBalances
private CardHolder	cardHolder
private java.lang.String	cardNumber
private CardStatus	cardStatus
private CardType	cardType
private CardCategory	category
private Counterparty	counterparty
private java.util.Map<java.lang.String,java.lang.String>	extendedAttributes
private java.lang.String	id
private CardSearchEventSource	inputType
private java.lang.String	processingId
private java.util.Optional<SearchInitiator>	searchInitiator
private java.util.Optional<java.lang.String>	softReceiptId

Constructor Summary

Constructors

Constructor and Description
CardEntity() Конструктор класса.
CardEntity(java.lang.String cardNumber, CardType type, java.lang.String processingId) Конструктор класса.
CardEntity(java.lang.String cardNumber, java.lang.String processingId) Конструктор класса.

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() Получить контрагент, которой привязан к карте
java.util.Map<java.lang.String,java.lang.String>	getExtendedAttributes() Получает мапу атрибутов, которые были добавлены к карте. Позволяет добавлять к карте любые дополнительные параметры, которые затем можно использовать где-нибудь в другом месте.
java.lang.String	getId() Получить уникальный идентификатор карты - идентификатор достаточный для получения полной информации по данной карте
CardSearchEventSource	getInputType() Возвращает способ, которым карта была считана.
java.lang.String	getProcessingId() Получить идентификатор процессинга, которому "принадлежит" карта
java.util.Optional<SearchInitiator>	getSearchInitiator() В случае инициирования поиска карты внешней системой возвращает информацию об этой системе.
java.util.Optional<java.lang.String>	getSoftReceiptId() Возвращает идентификатор мягкого чека из которого добавлена карта
BonusBalance	getTokensBalance() Получить фишечный баланс карты
void	setBonusBalance(BonusBalance bonusBalance) Установить бонусный баланс карты Если бонусных балансов было добавлено несколько через getBalances, то останется только один бонусный баланс
void	setCardHolder(CardHolder holder) Установить владельца карты
void	setCardNumber(java.lang.String cardNumber) Установить номер карты
void	setCardStatus(CardStatus status) Установить статус данной карты/купона
void	setCardType(CardType cardType) Установить тип карты
void	setCategory(CardCategory category) Устанавливает категорию карты/купона.
void	setCounterparty(Counterparty counterparty) Устанавливает контрагента
void	setId(java.lang.String id) Установить уникальный идентификатор данной карты.
void	setInputType(CardSearchEventSource inputType) Устанавливает способ, которым была введена карта.
void	setProcessingId(java.lang.String processingId) Установить идентификатор процессинга, которому "принадлежит" карта
void	setSearchInitiator(SearchInitiator searchInitiator)
void	setSoftReceiptId(java.util.Optional<java.lang.String> softReceiptId) Устанавливает идентификатор мягкого чека из которого добавлена карта
void	setTokensBalance(BonusBalance bonusBalance) Установить фишечный баланс карты Если фишечных балансов было добавлено несколько через getBalances, то останется только один фишечный баланс
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

id

private java.lang.String id

cardNumber

private java.lang.String cardNumber

cardType

private CardType cardType

cardHolder

private CardHolder cardHolder

processingId

private java.lang.String processingId

bonusBalances

private java.util.List<BonusBalance> bonusBalances

cardStatus

private CardStatus cardStatus

inputType

private CardSearchEventSource inputType

extendedAttributes

private java.util.Map<java.lang.String,java.lang.String> extendedAttributes

category

private CardCategory category

counterparty

private Counterparty counterparty

softReceiptId

private java.util.Optional<java.lang.String> softReceiptId

searchInitiator

private java.util.Optional<SearchInitiator> searchInitiator

Constructor Detail

CardEntity

public CardEntity()

Конструктор класса. Создаёт новый экземпляр класса CardEntity.

CardEntity

public CardEntity(java.lang.String cardNumber,
                  java.lang.String processingId)

Конструктор класса. Создаёт новый экземпляр класса CardEntity.

Parameters:

cardNumber - номер карты

processingId - идентификатор процессинга этой карты (идентификатор плагина, признавшего данную карту своей).

CardEntity

public CardEntity(java.lang.String cardNumber,
                  CardType type,
                  java.lang.String processingId)

Конструктор класса. Создаёт новый экземпляр класса CardEntity.

Parameters:

cardNumber - номер карты

type - тип карты

processingId - идентификатор процессинга

See Also:

CardType

Method Detail

getId

public java.lang.String getId()

Description copied from interface: Card

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

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

Specified by:

getId in interface Card

Returns:

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

setId

public void setId(java.lang.String id)

Установить уникальный идентификатор данной карты.

Parameters:

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

See Also:

getId()

getCardNumber

public java.lang.String getCardNumber()

Description copied from interface: Card

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

Specified by:

getCardNumber in interface Card

Returns:

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

setCardNumber

public void setCardNumber(java.lang.String cardNumber)

Установить номер карты

Parameters:

cardNumber - номер карты

getCardType

public CardType getCardType()

Description copied from interface: Card

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

Specified by:

getCardType in interface Card

Returns:

тип карты

See Also:

CardType

setCardType

public void setCardType(CardType cardType)

Установить тип карты

Parameters:

cardType - тип карты

See Also:

CardType

getCardHolder

public CardHolder getCardHolder()

Description copied from interface: Card

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

Specified by:

getCardHolder in interface Card

Returns:

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

See Also:

CardHolder

setCardHolder

public void setCardHolder(CardHolder holder)

Установить владельца карты

Parameters:

holder - владелец карты

See Also:

CardHolderEntity

getProcessingId

public java.lang.String getProcessingId()

Description copied from interface: Card

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

Specified by:

getProcessingId in interface Card

Returns:

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

setProcessingId

public void setProcessingId(java.lang.String processingId)

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

Parameters:

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

getBonusBalance

public BonusBalance getBonusBalance()

Description copied from interface: Card

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

Specified by:

getBonusBalance in interface Card

Returns:

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

See Also:

BonusBalance

getTokensBalance

public BonusBalance getTokensBalance()

Description copied from interface: Card

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

Specified by:

getTokensBalance in interface Card

Returns:

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

See Also:

BonusBalance

getBalances

public java.util.Collection<BonusBalance> getBalances()

Description copied from interface: Card

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

Specified by:

getBalances in interface Card

Returns:

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

See Also:

BonusBalance

setBonusBalance

public void setBonusBalance(BonusBalance bonusBalance)

Установить бонусный баланс карты Если бонусных балансов было добавлено несколько через getBalances, то останется только один бонусный баланс

Parameters:

bonusBalance - бонусный баланс карты

See Also:

BonusBalanceEntity

setTokensBalance

public void setTokensBalance(BonusBalance bonusBalance)

Установить фишечный баланс карты Если фишечных балансов было добавлено несколько через getBalances, то останется только один фишечный баланс

Parameters:

bonusBalance - фишечный баланс карты

See Also:

BonusBalanceEntity

getCardStatus

public CardStatus getCardStatus()

Description copied from interface: Card

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

Specified by:

getCardStatus in interface Card

Returns:

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

See Also:

CardStatus

setCardStatus

public void setCardStatus(CardStatus status)

Установить статус данной карты/купона

Parameters:

status - статус карты/купона

See Also:

CardStatus

getInputType

public CardSearchEventSource getInputType()

Description copied from interface: Card

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

Specified by:

getInputType in interface Card

Returns:

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

getExtendedAttributes

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

Description copied from interface: Card

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

Specified by:

getExtendedAttributes in interface Card

Returns:

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

setInputType

public void setInputType(CardSearchEventSource inputType)

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

Parameters:

inputType - способ, которым была введена карта.

getCategory

public CardCategory getCategory()

Description copied from interface: Card

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

Specified by:

getCategory in interface Card

Returns:

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

setCategory

public void setCategory(CardCategory category)

Устанавливает категорию карты/купона.

Parameters:

category - категория

getCounterparty

public Counterparty getCounterparty()

Description copied from interface: Card

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

Specified by:

getCounterparty in interface Card

Returns:

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

setCounterparty

public void setCounterparty(Counterparty counterparty)

Устанавливает контрагента

Parameters:

counterparty - контрагент

Since:

0.0.75

getSoftReceiptId

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

Description copied from interface: Card

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

Specified by:

getSoftReceiptId in interface Card

Returns:

не null

setSoftReceiptId

public void setSoftReceiptId(java.util.Optional<java.lang.String> softReceiptId)

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

Parameters:

softReceiptId - идентификатор мягкого чека

Since:

1.12.0

getSearchInitiator

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

Description copied from interface: Card

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

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

Specified by:

getSearchInitiator in interface Card

Returns:

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

setSearchInitiator

public void setSearchInitiator(SearchInitiator searchInitiator)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object