BonusBalanceEntity (Set10POSAPI 0.0.0_DO_NOT_CHANGE

java.lang.Object
- ru.crystals.pos.api.card.BonusBalanceEntity

All Implemented Interfaces:: BonusBalance

public class BonusBalanceEntity
extends java.lang.Object
implements BonusBalance

Бонусный баланс карты.

Field Summary

Fields
Modifier and Type	Field and Description
`private java.math.BigDecimal`	`balance`
`private BalanceType`	`balanceType`
`private java.lang.String`	`bonusProcessingDisplayName`
`private java.math.BigDecimal`	`multiplier`
`private java.math.BigDecimal`	`rate`
`private java.util.Collection<BonusSubBalance>`	`subBalances`
`private java.math.BigDecimal`	`sumAllowedToChargeOff`
`private java.math.BigDecimal`	`sumToChargeOff`

Constructor Summary

Constructors
Constructor and Description

BonusBalanceEntity(java.math.BigDecimal balance)
Конструктор класса.

Constructors
Constructor and Description
`BonusBalanceEntity(java.math.BigDecimal balance)` Конструктор класса.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.math.BigDecimal`	`getBalance()` Получить текущий баланс бонусов на счету
`BalanceType`	`getBalanceType()` Тип баланса, если используются не просто бонусы, а фишки/марки, то списание их происходит нелинейно, например 10 фишек - 5 рублей скидки, 20 фишек - 8 рублей скидки и т.п.
`java.lang.String`	`getBonusProcessingDisplayName()` Получить наименование бонусной программы/процессинга для отображения в GUI кассы
`java.math.BigDecimal`	`getMultiplier()` Коэффициент перевода бонусокопеек в бонусорубли У внешней системы может быть исчисление бонусов в рублях и копейках, тогда этот коэффициент равен 100, т.к.
`java.math.BigDecimal`	`getRate()` Курс по которому бонусы (а точнее бонусокопейки) конвертируются в деньги (в копейках) Например, если списываем 4 балла внешней системы, а курс 0.25, то спишется 4 / 0.25 = 16 копеек.
`java.util.Collection<BonusSubBalance>`	`getSubBalances()`
`java.math.BigDecimal`	`getSumAllowedToChargeOff()` Получить количество бонусов, что позволено списать с этого баланса в текущем чеке
`java.math.BigDecimal`	`getSumToChargeOff()` Получить количество бонусов, что решили списать (или уже списали) с этого баланса в текущем чеке
`void`	`setBalance(java.math.BigDecimal balance)` Установить текущий баланс бонусов на счету.
`void`	`setBalanceType(BalanceType balanceType)` Установить тип баланса, если например бонусы используются как фишки/марки и т.п., то списание их происходит нелинейно
`void`	`setBonusProcessingDisplayName(java.lang.String bonusProcessingDisplayName)` Установить наименование бонусной программы/процессинга для отображения в GUI кассы.
`void`	`setMultiplier(java.math.BigDecimal multiplier)` Установить коэффициент перевода бонусокопеек в бонусорубли
`void`	`setRate(java.math.BigDecimal rate)` Установить курс для конвертации бонусов в деньги
`void`	`setSumAllowedToChargeOff(java.math.BigDecimal sumAllowedToChargeOff)` Установить количество бонусов, что позволено списать с этого баланса в текущем чеке.
`void`	`setSumToChargeOff(java.math.BigDecimal sumToChargeOff)` Установить количество бонусов, которые можно списать в текущем чеке.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - balance
```
private java.math.BigDecimal balance
```
  - sumAllowedToChargeOff
```
private java.math.BigDecimal sumAllowedToChargeOff
```
  - sumToChargeOff
```
private java.math.BigDecimal sumToChargeOff
```
  - bonusProcessingDisplayName
```
private java.lang.String bonusProcessingDisplayName
```
  - multiplier
```
private java.math.BigDecimal multiplier
```
  - rate
```
private java.math.BigDecimal rate
```
  - balanceType
```
private BalanceType balanceType
```
  - subBalances
```
private java.util.Collection<BonusSubBalance> subBalances
```
- Constructor Detail
  - BonusBalanceEntity
```
public BonusBalanceEntity(java.math.BigDecimal balance)
```
    Конструктор класса. Создаёт новый экземпляр класса BonusBalanceEntity.
    
    Parameters:
    
    balance - текущий баланс бонусов на счету.
- Method Detail
  - getBalance
```
public java.math.BigDecimal getBalance()
```
    Description copied from interface: BonusBalance
    
    Получить текущий баланс бонусов на счету
    
    Specified by:
    
    getBalance in interface BonusBalance
    
    Returns:
    
    баланс бонусов
  - setBalance
```
public void setBalance(java.math.BigDecimal balance)
```
    Установить текущий баланс бонусов на счету.
    
    Parameters:
    
    balance - баланс бонусов
  - getSumAllowedToChargeOff
```
public java.math.BigDecimal getSumAllowedToChargeOff()
```
    Description copied from interface: BonusBalance
    
    Получить количество бонусов, что позволено списать с этого баланса в текущем чеке
    
    Specified by:
    
    getSumAllowedToChargeOff in interface BonusBalance
    
    Returns:
    
    null, если расчет этого "потолка списания" не производился (неизвестно сколько можно списать)
  - setSumAllowedToChargeOff
```
public void setSumAllowedToChargeOff(java.math.BigDecimal sumAllowedToChargeOff)
```
    Установить количество бонусов, что позволено списать с этого баланса в текущем чеке.
    
    Parameters:
    
    sumAllowedToChargeOff - null, если расчет этого "потолка списания" не производился (неизвестно сколько можно списать).
  - getSumToChargeOff
```
public java.math.BigDecimal getSumToChargeOff()
```
    Description copied from interface: BonusBalance
    
    Получить количество бонусов, что решили списать (или уже списали) с этого баланса в текущем чеке
    
    Specified by:
    
    getSumToChargeOff in interface BonusBalance
    
    Returns:
    
    null, если количество бонусов для списания [еще] не ввели
  - setSumToChargeOff
```
public void setSumToChargeOff(java.math.BigDecimal sumToChargeOff)
```
    Установить количество бонусов, которые можно списать в текущем чеке.
    
    Parameters:
    
    sumToChargeOff - количество бонусов, которые можно списать в текущем чеке.
  - getBonusProcessingDisplayName
```
public java.lang.String getBonusProcessingDisplayName()
```
    Description copied from interface: BonusBalance
    
    Получить наименование бонусной программы/процессинга для отображения в GUI кассы
    
    Specified by:
    
    getBonusProcessingDisplayName in interface BonusBalance
    
    Returns:
    
    наименование бонусного процессинга
  - setBonusProcessingDisplayName
```
public void setBonusProcessingDisplayName(java.lang.String bonusProcessingDisplayName)
```
    Установить наименование бонусной программы/процессинга для отображения в GUI кассы.
    
    Parameters:
    
    bonusProcessingDisplayName - наименование бонусного процессинга.
  - getMultiplier
```
public java.math.BigDecimal getMultiplier()
```
    Description copied from interface: BonusBalance
    
    Коэффициент перевода бонусокопеек в бонусорубли У внешней системы может быть исчисление бонусов в рублях и копейках, тогда этот коэффициент равен 100, т.к. в 1 руб = 100 копеек. Вместо рублей и копеек могут быть другие названия, которые обозначим, как бонусорубли и бонусокопейки. По умолчанию, этот коэффициент равен 100, но если во внешней системе просто бонусы (например баллы), и кассиру необходимо вводить целое значение этих бонусов, то необходимо установить 1
    
    Specified by:
    
    getMultiplier in interface BonusBalance
    
    Returns:
    
    коэффициент перевода бонусокопеек в бонусорубли
  - setMultiplier
```
public void setMultiplier(java.math.BigDecimal multiplier)
```
    Установить коэффициент перевода бонусокопеек в бонусорубли
    
    Parameters:
    
    multiplier - коэффициент перевода бонусокопеек в бонусорубли
    
    Since:
    
    0.0.55
  - getRate
```
public java.math.BigDecimal getRate()
```
    Description copied from interface: BonusBalance
    
    Курс по которому бонусы (а точнее бонусокопейки) конвертируются в деньги (в копейках) Например, если списываем 4 балла внешней системы, а курс 0.25, то спишется 4 / 0.25 = 16 копеек. Если списали 15 рублей, то в баллах это 150 копеек * 0.25 = 37,5 баллов
    
    Specified by:
    
    getRate in interface BonusBalance
    
    Returns:
    
    курс для конвертации бонусов в деньги
  - setRate
```
public void setRate(java.math.BigDecimal rate)
```
    Установить курс для конвертации бонусов в деньги
    
    Parameters:
    
    rate - курс для конвертации бонусов в деньги
    
    Since:
    
    0.0.55
  - getBalanceType
```
public BalanceType getBalanceType()
```
    Description copied from interface: BonusBalance
    
    Тип баланса, если используются не просто бонусы, а фишки/марки, то списание их происходит нелинейно, например 10 фишек - 5 рублей скидки, 20 фишек - 8 рублей скидки и т.п.
    
    Specified by:
    
    getBalanceType in interface BonusBalance
    
    Returns:
    
    тип баланса
  - setBalanceType
```
public void setBalanceType(BalanceType balanceType)
```
    Установить тип баланса, если например бонусы используются как фишки/марки и т.п., то списание их происходит нелинейно
    
    Parameters:
    
    balanceType - тип баланса
    
    Since:
    
    0.0.60
  - getSubBalances
```
public java.util.Collection<BonusSubBalance> getSubBalances()
```
    Specified by:
    
    getSubBalances in interface BonusBalance
    
    Returns:
    
    "под-балансы" данного бонусного счета
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class BonusBalanceEntity

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

balance

sumAllowedToChargeOff

sumToChargeOff

bonusProcessingDisplayName

multiplier

rate

balanceType

subBalances

Constructor Detail

BonusBalanceEntity

Method Detail

getBalance

setBalance

getSumAllowedToChargeOff

setSumAllowedToChargeOff

getSumToChargeOff

setSumToChargeOff

getBonusProcessingDisplayName

setBonusProcessingDisplayName

getMultiplier

setMultiplier

getRate

setRate

getBalanceType

setBalanceType

getSubBalances

toString