ru.crystals.pos.api.plugin

Interface GoodsPlugin

All Superinterfaces:

FiscalizationListener, ReconciliationReportMaker

public interface GoodsPlugin
extends FiscalizationListener, ReconciliationReportMaker

Интерфейс плагина товара.

Method Summary

Modifier and Type	Method and Description
default void	addForRefund(AddForRefundRequest request) Запрос на добавление товара в чек произвольного возврата.
void	addForSale(AddForSaleRequest addForSaleRequest) Запрос на добавление товара в чек для продажи.
MerchandiseEntity	findByBarcode(java.lang.String barcode) Запрос на поиск товара по штрихкоду.
default PositionalRefundPreparationResult	preparePositionalRefund(PositionalRefundPreparationRequest request) Запрос на подготовку возвращаемых позиций, принадлежащих плагину, при возврате по чеку.
void	removeFromSale(RemoveFromSaleRequest request) Запрос на удаление товарной позиции из чека продажи.

Methods inherited from interface ru.crystals.pos.spi.plugin.FiscalizationListener

eventReceiptFiscalized, onRepeatSend

Methods inherited from interface ru.crystals.pos.spi.plugin.ReconciliationReportMaker

createDailyReport, hasDailyReports

Method Detail

addForSale

void addForSale(AddForSaleRequest addForSaleRequest)

Запрос на добавление товара в чек для продажи.

Касса вызывает этот метод, когда необходимо добавить товар в чек.
Товар содержится в аргументе addForSaleRequest.

Результат добавления/не добавления товара возвращается в кассу обратными (callback) вызовами содержащимися в аргументе addForSaleRequest.

Parameters:

addForSaleRequest - необходимые для добавления товара данные и реализация callback интерфейса

See Also:

AddForSaleRequest

addForRefund

default void addForRefund(AddForRefundRequest request)

Запрос на добавление товара в чек произвольного возврата. Чек произвольного возврата образуется, когда пользователь желает вернуть один или несоклько товаров не по чеку продажи, по которому они были куплены. Таким образом, ссылки на оригинальный чек продажи у такого чека не будет.

Parameters:

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

Since:

0.0.34

removeFromSale

void removeFromSale(RemoveFromSaleRequest request)

Запрос на удаление товарной позиции из чека продажи.

Касса вызывает метод, когда необходимо удалить добавленную позицию из чека, дважды.
Первый раз управление передается плагину для проверки возможности удаления.
Далее, если удаление возможно, на кассе выводится диалог: "Удалить позицию из чека?" (Да | Нет)
После положительного выбора управление передается плагину для выполнения необходимых действий с позицией перед удалением из чека. Под удалением подразумевается, что плагин выполнит все необходимые ему действия.
Удаление записи из БД касса выполняет после получения второго положительного ответа в callback, т.е.:
RemoveFromSaleCallback.completed(boolean)

Parameters:

request - содержит удаляемую позицию, чек и реализацию callback интерфейса

findByBarcode

MerchandiseEntity findByBarcode(java.lang.String barcode)

Запрос на поиск товара по штрихкоду.

Касса вызывает этот метод, когда был просканирован штрихкод и касса находится в режиме добавления товаров в чек.
Если плагин распознал шрихкод как товар, продажу которого он осуществляет, то необходимо вернуть новую сущность MerchandiseEntity, иначе null.
В режиме продажи, касса передаст управление плагину вызовом метода addForSale(AddForSaleRequest), найденный товар можно будет получить методом AddForSaleRequest.getMerchandise().

Parameters:

barcode - штрихкод

Returns:

сущность товара или null

preparePositionalRefund

default PositionalRefundPreparationResult preparePositionalRefund(PositionalRefundPreparationRequest request)

Запрос на подготовку возвращаемых позиций, принадлежащих плагину, при возврате по чеку.

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

Метод не вызывается, если в планируемом к возврату чеке нет позиций этого плагина, доступных для возврата

Parameters:

request - запрос на подготовку возврата по чеку

Returns:

результат подготовки возврата

Since:

1.10.3