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

Class Discount

java.lang.Object

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

public class Discount
extends java.lang.Object

Описывает предоставленную на позицию скидку.

NOTE: все денежные суммы представлены в BigDecimal с двумя знаками после запятой, т.е. scale=2.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	applyToSplitPosition Признак применения скидки на отделенную позицию.
private java.lang.String	cardNumber Номер карты, применение которой спровоцировало срабатывание данной скидки.
private boolean	disableRedistribution Признак запрета перераспределения скидки тюнером ФЗ-54 между позициями чека.
private java.lang.String	discountId Идентификатор данной скидки (код скидки).
private java.lang.String	discountName Наименование акции внешней системы.
private DiscountType	discountType Тип скидки
private int	posNo Номер позиции, на которую дана эта скидка.
private java.math.BigDecimal	quantity Количество товара в позиции, на которое предоставлена данная скидка.
private boolean	receiptWideDiscount Флаг-признак, указывающий была ли данная скидка скидкой на весь чек (до "размазывания"/распределения данной скидки по позициям).
private java.math.BigDecimal	value Величина скидки.
private DiscountValueType	valueType Тип значения скидки.

Constructor Summary

Constructors

Constructor and Description
Discount(int posNo, java.lang.String cardNumber, java.math.BigDecimal value, java.lang.String discountId) Конструктор класса.
Discount(int posNo, java.lang.String cardNumber, java.math.BigDecimal value, java.lang.String discountId, java.math.BigDecimal quantity) Конструктор класса.
Discount(int posNo, java.lang.String cardNumber, java.math.BigDecimal value, java.lang.String discountId, java.lang.String discountName) Конструктор класса.
Discount(int posNo, java.lang.String cardNumber, java.math.BigDecimal value, java.lang.String discountId, java.lang.String discountName, java.math.BigDecimal quantity) Конструктор класса.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCardNumber() Вернет номер карты, применение которой спровоцировало срабатывание данной скидки.
java.lang.String	getDiscountId() Вернет Идентификатор данной скидки (код скидки).
java.lang.String	getDiscountName() Вернет наименование акции внешней системы.
DiscountType	getDiscountType()
int	getPosNo() Вернет номер позиции, на которую дана эта скидка.
java.math.BigDecimal	getQuantity() Вернет количество товара в позиции, на которое предоставлена скидка, или null, если скидка предоставлена на всю позицию.
java.math.BigDecimal	getValue() Возвращает величину скидки.
DiscountValueType	getValueType() Вернет тип значения скидки.
boolean	isApplyToSplitPosition() Вернет признак применения скидки на отделенную позицию.
boolean	isDisableRedistribution()
boolean	isReceiptWideDiscount() Вернет признак была ли эта скидка дана (в процессинге) на весь чек, а не конкретно на эту позицию.
void	setApplyToSplitPosition(boolean applyToSplitPosition) Установит признак применения скидки на отделенную позицию.
void	setDisableRedistribution(boolean disableRedistribution)
void	setDiscountType(DiscountType discountType)
void	setReceiptWideDiscount(boolean receiptWideDiscount) Установит признак: "дана ли была эта скидка на весь чек".
void	setValueType(DiscountValueType valueType) Установит тип значения скидки.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

posNo

private int posNo

Номер позиции, на которую дана эта скидка.

quantity

private java.math.BigDecimal quantity

Количество товара в позиции, на которое предоставлена данная скидка. Опциональный параметр

cardNumber

private java.lang.String cardNumber

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

value

private java.math.BigDecimal value

Величина скидки.

discountId

private java.lang.String discountId

Идентификатор данной скидки (код скидки).

receiptWideDiscount

private boolean receiptWideDiscount

Флаг-признак, указывающий была ли данная скидка скидкой на весь чек (до "размазывания"/распределения данной скидки по позициям).

Since:

0.0.27

discountType

private DiscountType discountType

Тип скидки

Since:

0.0.60

discountName

private java.lang.String discountName

Наименование акции внешней системы. Опциональный параметр.

disableRedistribution

private boolean disableRedistribution

Признак запрета перераспределения скидки тюнером ФЗ-54 между позициями чека.

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

NOTE: учитывается только для скидки бонусами DiscountType.BONUSES.

applyToSplitPosition

private boolean applyToSplitPosition

Признак применения скидки на отделенную позицию.

Данный признак может понадобиться, например, при применении скидок фишками, когда скидка действует на одну единицу товара и в позиции больше одной единицы товара (в таком случае после применения первой скидки позиция будет разделена на две). Этот признак позволит примениться скидке не на оригинальную позицию, а на отделенную, тем самым позволив распределить скидки по всем позициям после разделения.

NOTE: признак должен проставляться на вторую и последующую скидку к одной позиции.

valueType

private DiscountValueType valueType

Тип значения скидки.

Constructor Detail

Discount

public Discount(int posNo,
                java.lang.String cardNumber,
                java.math.BigDecimal value,
                java.lang.String discountId)

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

Parameters:

posNo - Номер позиции, на которую дана эта скидка.

cardNumber - Номер карты, применение которой спровоцировало срабатывание данной скидки.

value - Размер скидки.

discountId - Идентификатор данной скидки (код скидки).

Discount

public Discount(int posNo,
                java.lang.String cardNumber,
                java.math.BigDecimal value,
                java.lang.String discountId,
                java.math.BigDecimal quantity)

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

Parameters:

posNo - Номер позиции, на которую дана эта скидка.

cardNumber - Номер карты, применение которой спровоцировало срабатывание данной скидки.

value - Размер скидки.

discountId - Идентификатор данной скидки (код скидки).

quantity - Кол-во товара в позиции, на которое предоставлена скидка

Discount

public Discount(int posNo,
                java.lang.String cardNumber,
                java.math.BigDecimal value,
                java.lang.String discountId,
                java.lang.String discountName)

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

Parameters:

posNo - Номер позиции, на которую дана эта скидка.

cardNumber - Номер карты, применение которой спровоцировало срабатывание данной скидки.

value - Размер скидки.

discountId - Идентификатор данной скидки (код скидки).

discountName - Наименование акции внешней системы.

Discount

public Discount(int posNo,
                java.lang.String cardNumber,
                java.math.BigDecimal value,
                java.lang.String discountId,
                java.lang.String discountName,
                java.math.BigDecimal quantity)

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

Parameters:

posNo - Номер позиции, на которую дана эта скидка.

cardNumber - Номер карты, применение которой спровоцировало срабатывание данной скидки.

value - Размер скидки.

discountId - Идентификатор данной скидки (код скидки).

discountName - Наименование акции внешней системы.

quantity - Кол-во товара в позиции, на которое предоставлена скидка.

Method Detail

getPosNo

public int getPosNo()

Вернет номер позиции, на которую дана эта скидка.

Returns:

номер позиции.

getCardNumber

public java.lang.String getCardNumber()

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

Returns:

номер карты

getValue

public java.math.BigDecimal getValue()

Возвращает величину скидки.

Returns:

величина скидки.

getDiscountId

public java.lang.String getDiscountId()

Вернет Идентификатор данной скидки (код скидки).

Returns:

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

isReceiptWideDiscount

public boolean isReceiptWideDiscount()

Вернет признак была ли эта скидка дана (в процессинге) на весь чек, а не конкретно на эту позицию.

Returns:

false, если эта скидка была изначально (в процессинге) дана именно на эту позицию

setReceiptWideDiscount

public void setReceiptWideDiscount(boolean receiptWideDiscount)

Установит признак: "дана ли была эта скидка на весь чек".

Parameters:

receiptWideDiscount - значение, в которое надо установить флаг-признак: "является ли скидка на данную позицию частью скидки на чек"

getQuantity

public java.math.BigDecimal getQuantity()

Вернет количество товара в позиции, на которое предоставлена скидка, или null, если скидка предоставлена на всю позицию.

getDiscountType

public DiscountType getDiscountType()

setDiscountType

public void setDiscountType(DiscountType discountType)

getDiscountName

public java.lang.String getDiscountName()

Вернет наименование акции внешней системы.

Returns:

наименование акции внешней системы.

isDisableRedistribution

public boolean isDisableRedistribution()

setDisableRedistribution

public void setDisableRedistribution(boolean disableRedistribution)

isApplyToSplitPosition

public boolean isApplyToSplitPosition()

Вернет признак применения скидки на отделенную позицию.

Returns:

true, если скидку нужно применить к отделенной позиции.

setApplyToSplitPosition

public void setApplyToSplitPosition(boolean applyToSplitPosition)

Установит признак применения скидки на отделенную позицию.

Parameters:

applyToSplitPosition - значение признака применения скидки на отделенную позицию

getValueType

public DiscountValueType getValueType()

Вернет тип значения скидки.

Returns:

тип значения скидки.

setValueType

public void setValueType(DiscountValueType valueType)

Установит тип значения скидки.

Parameters:

valueType - тип значения скидки

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object