ru.crystals.pos.api.plugin.card

Class BonusWriteOffOperationResponse

java.lang.Object

ru.crystals.pos.api.plugin.card.BonusOperationResponse

ru.crystals.pos.api.plugin.card.BonusWriteOffOperationResponse

public class BonusWriteOffOperationResponse
extends BonusOperationResponse

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

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.String,java.lang.String>	cardExtendedAttributesMap Мапа расширенных атрибутов карты, которые плагин может к карте прицепить. Необходима на случай, если вдруг плагинам нужно будет хранить какую-то исключительно свою информацию в карте, которая затем может выгружаться на стороне сервера в ERP или ещё зачем.
private java.lang.String	operatorMessage Текст сообщения, что надо показать кассиру
private java.util.Map<java.lang.String,java.lang.String>	receiptExtendedAttributesMap Мапа расширенных атрибутов чека, которые плагин может к чеку прицепить. Необходима на случай, если вдруг плагинам нужно будет хранить какую-то исключительно свою информацию в чеке, которая затем может выгружаться на стороне сервера в ERP или ещё зачем.

Constructor Summary

Constructors

Constructor and Description
BonusWriteOffOperationResponse() Конструктор класса.
BonusWriteOffOperationResponse(BonusOperationStatus responseStatus, java.lang.String txId, java.lang.String operatorMessage) Конструкто класса.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	getCardExtendedAttributesMap() Мапа расширенных атрибутов карты, которые плагин может к карте прицепить. Необходима на случай, если вдруг плагинам нужно будет хранить какую-то исключительно свою информацию в карте, которая затем может выгружаться на стороне сервера в ERP или ещё зачем.
java.lang.String	getOperatorMessage() Вернет текст сообщения, что надо показать кассиру по результатам списания.
java.util.Map<java.lang.String,java.lang.String>	getReceiptExtendedAttributesMap() Мапа расширенных атрибутов, которыми плагин лояльности может наградить чек. Заполняется плагином в случае, если он хочет добавить к чеку какие-то дополнительные параметры.
void	setOperatorMessage(java.lang.String operatorMessage) Устанавливает текст сообщения кассиру.
java.lang.String	toString()

Methods inherited from class ru.crystals.pos.api.plugin.card.BonusOperationResponse

getResponseStatus, getTxId, setResponseStatus, setTxId

Methods inherited from class java.lang.Object

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

Field Detail

operatorMessage

private java.lang.String operatorMessage

Текст сообщения, что надо показать кассиру

receiptExtendedAttributesMap

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

Мапа расширенных атрибутов чека, которые плагин может к чеку прицепить.
Необходима на случай, если вдруг плагинам нужно будет хранить какую-то исключительно свою информацию в чеке, которая затем может выгружаться на стороне сервера в ERP или ещё зачем.

cardExtendedAttributesMap

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

Мапа расширенных атрибутов карты, которые плагин может к карте прицепить.
Необходима на случай, если вдруг плагинам нужно будет хранить какую-то исключительно свою информацию в карте, которая затем может выгружаться на стороне сервера в ERP или ещё зачем.

Constructor Detail

BonusWriteOffOperationResponse

public BonusWriteOffOperationResponse(BonusOperationStatus responseStatus,
                                      java.lang.String txId,
                                      java.lang.String operatorMessage)

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

Parameters:

responseStatus - результат проведения операции списания

txId - идентификатор транзакции списания

operatorMessage - сообщение кассиру

BonusWriteOffOperationResponse

public BonusWriteOffOperationResponse()

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

See Also:

BonusWriteOffOperationResponse(BonusOperationStatus, String, String)

Method Detail

getOperatorMessage

public java.lang.String getOperatorMessage()

Вернет текст сообщения, что надо показать кассиру по результатам списания.

Например, данное сообщение может соджержать кратное локализованное описание ошибки, в понятном кассиру виде. Или какой-нибудь рекламный текст (например, если это оказалось милионное успешное списание средств в процессинге).

Returns:

null либо пустая строка, если не надо показывать сообщений NOTE: если вернет пустую строку, но результат операции при этом будет отрицательным, то касса SET10 самомстоятельно сформирует шаблонное сообщение об ошибке.

setOperatorMessage

public void setOperatorMessage(java.lang.String operatorMessage)

Устанавливает текст сообщения кассиру.

Parameters:

operatorMessage - текст сообщения кассиру или null, если такого нет.

getReceiptExtendedAttributesMap

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

Мапа расширенных атрибутов, которыми плагин лояльности может наградить чек.
Заполняется плагином в случае, если он хочет добавить к чеку какие-то дополнительные параметры.

Returns:

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

getCardExtendedAttributesMap

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

Мапа расширенных атрибутов карты, которые плагин может к карте прицепить.
Необходима на случай, если вдруг плагинам нужно будет хранить какую-то исключительно свою информацию в карте, которая затем может выгружаться на стороне сервера в ERP или ещё зачем.

Returns:

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

toString

public java.lang.String toString()

Overrides:

toString in class BonusOperationResponse