ru.crystals.pos.api.ext.loyal.dto

Class AddForSaleResult

java.lang.Object

ru.crystals.pos.api.ext.loyal.dto.AddForSaleResult

public class AddForSaleResult
extends java.lang.Object

Результат обработки плагином события добавления товара в чек.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Collection<Action>	actionsToTake Действия, которые нужно произвести, если добавление новой позиции пройдет успешно.
private java.util.Map<java.lang.String,java.lang.String>	extendedReceiptAttributes Дополнительные данные в формате <ключ, значение>, которые будут добавлены в чек.
private NewLineItem	newLineItem Сущность для передачи кассе данных о новой позиции чека (может быть null, если добавляется несколько позиций через newLineItems)
private java.util.List<NewLineItem>	newLineItems Список позиций, которые нужно добавить (если заполнен, то newLineItem игнорируется)

Constructor Summary

Constructors

Modifier	Constructor and Description
	AddForSaleResult() Конструктор класса.
	AddForSaleResult(NewLineItem newLineItem) Конструктор класса.
private	AddForSaleResult(NewLineItem newLineItem, java.util.List<NewLineItem> newLineItems)

Method Summary

Modifier and Type	Method and Description
java.util.Collection<Action>	getActionsToTake() Возвращает коллекцию действий, которые нужно произвести, если добавление пройдет успешно.
java.util.Map<java.lang.String,java.lang.String>	getExtendedReceiptAttributes() Возвращает дополнительные данные в формате <ключ, значение>, которые будут добавлены в чек.
NewLineItem	getNewLineItem() Возвращает сущность для передачи кассе данных о новой позиции чека.
java.util.List<NewLineItem>	getNewLineItems() Возвращает список сущностей для передачи кассе данных о новых позициях чека.
void	setNewLineItem(NewLineItem newLineItem) Устанавливает сущность для передачи кассе данных о новой позиции чека.
java.lang.String	toString()
static AddForSaleResult	withItems(java.util.List<NewLineItem> newLineItems) Создает новый экземпляр результата обработки с несколькими позициями для добавления в чек

Methods inherited from class java.lang.Object

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

Field Detail

newLineItem

private NewLineItem newLineItem

Сущность для передачи кассе данных о новой позиции чека (может быть null, если добавляется несколько позиций через newLineItems)

newLineItems

private java.util.List<NewLineItem> newLineItems

Список позиций, которые нужно добавить (если заполнен, то newLineItem игнорируется)

Since:

1.13.0

actionsToTake

private java.util.Collection<Action> actionsToTake

Действия, которые нужно произвести, если добавление новой позиции пройдет успешно.

extendedReceiptAttributes

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

Дополнительные данные в формате <ключ, значение>, которые будут добавлены в чек.

Constructor Detail

AddForSaleResult

public AddForSaleResult()

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

AddForSaleResult

private AddForSaleResult(NewLineItem newLineItem,
                         java.util.List<NewLineItem> newLineItems)

AddForSaleResult

public AddForSaleResult(NewLineItem newLineItem)

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

Parameters:

newLineItem - сущность для передачи кассе данных о новой позиции чека

Method Detail

withItems

public static AddForSaleResult withItems(java.util.List<NewLineItem> newLineItems)

Создает новый экземпляр результата обработки с несколькими позициями для добавления в чек

Parameters:

newLineItems - список данных для добавления нескольких позиций

Returns:

новый экземпляр результата обработки

getNewLineItem

public NewLineItem getNewLineItem()

Возвращает сущность для передачи кассе данных о новой позиции чека.

Returns:

сущность для передачи кассе данных о новой позиции чека.

setNewLineItem

public void setNewLineItem(NewLineItem newLineItem)

Устанавливает сущность для передачи кассе данных о новой позиции чека.

Данные игнорируются, если заполнены getNewLineItems()

Parameters:

newLineItem - сущность для передачи кассе данных о новой позиции чека

getNewLineItems

public java.util.List<NewLineItem> getNewLineItems()

Возвращает список сущностей для передачи кассе данных о новых позициях чека.

Returns:

потенциально немодицифируемый список сущностей для передачи кассе данных о новых позиции чека.

Since:

1.13.0

getActionsToTake

public java.util.Collection<Action> getActionsToTake()

Возвращает коллекцию действий, которые нужно произвести, если добавление пройдет успешно.

Returns:

коллекция действий

API Note:

Важно знать:
1. Каждый Action атомарен и не влияет на выполнение других
2. Выполнение не гарантируется и не влияет на добавление товара в чек

getExtendedReceiptAttributes

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

Возвращает дополнительные данные в формате <ключ, значение>, которые будут добавлены в чек.

Returns:

коллекция ключей и значений

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object