PaymentsModel (posper 3.0 API)

java.lang.Object
- org.posper.tpv.payment.PaymentsModel

```
public class PaymentsModel
extends Object
```
The payments model provides all values and methods used for close cash. Changes:
- Serial number for close cash added
- Payments directly related to active cash instead going through tickets. Exception: getPayments/printPayments
- list all tax lines, i.e. also tax free and tax_total = 0 - don't count topup payments for total - added class DiscountLine to print discount statistics *

Author:

Hans, Adrian, Aaron Luchko

Field Summary

Fields
Modifier and Type	Field and Description
`protected static PaymentsModel`	`instance`
`protected Date`	`m_dDateEnd`
`protected Date`	`m_dDateStart`
`protected Double`	`m_dSalesSubtotal`
`protected Double`	`m_dSalesTotal`
`protected Integer`	`m_iPayments`
`protected Integer`	`m_iSales`
`protected List<DiscountLineFormatter>`	`m_lDiscounts`
`protected List<AccountingLineFormatter>`	`m_linesByAccountingLevel`
`protected List<AccountingLineFormatter>`	`m_linesByModifiers`
`protected List<Object[]>`	`m_lPayments`
`protected Integer`	`m_maxNumber`
`protected Integer`	`m_minNumber`
`protected List<Object[]>`	`m_oDiscounts`
`protected static CashRegister`	`m_reg`
`protected Integer`	`m_serialNr`
`protected String`	`m_sHost`
`protected Set<Ticket>`	`m_tickets`
`protected User`	`m_user`
`protected static String[]`	`SALEHEADERS`
`protected List<SalesLineFormatter>`	`slines`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPaymentLine(Object[] pline)`
`static PaymentsModel`	`emptyInstance()` PaymentsModel defines all methods that can be referenced in Printer.CloseCash.xml and and Printer.CurrentCash.xml and are used in JPanelCloseMoney and JPanelCloseCash.
`List<AccountingLineFormatter>`	`getAccountingLines(int levelMask)` Retrieves sales values for products having the accounting levels in levelMask.
`List<AccountingLineFormatter>`	`getAccountingLines(int levelMask, boolean groupByProduct)` Retrieves sales values for products having the accounting levels in levelMask.
`List<AccountingLineFormatter>`	`getAccountingLinesByModifier(int modifierMask, boolean groupByProduct)` Retrieves sales values for products having the modifiers in modifierMask set.
`CashRegister`	`getActiveCash()`
`Integer`	`getCashCloseNr()` Get the serial number of the active cashregister for the current host.
`Integer`	`getCurrentRegister(String host)` Get the serial number of the current register for host.
`Date`	`getDateEnd()` Get the closing date for cash close.
`Date`	`getDateStart()` Start date of the active cash register.
`List<DiscountLineFormatter>`	`getDiscountLines()` Retrieves the list of discount line formatters.
`String`	`getHost()` Host name of the current host.
`Integer`	`getMaxTicketNum()` Print the last ticket number of this sales period
`Integer`	`getMinTicketNum()` Print the first ticket number of this sales period
`HashMap<String,PaymentsLineFormatter[]>`	`getPaymentGroups()` Returns a hash with key value pairs where the key represents a payment method and the value represents a vector of PaymentLines
`List<PaymentsLineFormatter>`	`getPaymentLines()` Retrieves a list of all payment lines.
`List<PaymentsLineFormatter>`	`getPaymentLinesByHosts(String hosts)` Get a list of PaymentLineFormatters for the listed hosts.
`List<PaymentsLineFormatter>`	`getPaymentLinesByUser()` Get a list of PaymentsLineFormatters for the selected register of the current host.
`int`	`getPayments()` Number of payments
`AbstractTableModel`	`getPaymentsModel()` The payment table model is meant to be used in JPanelCloseMoney only.
`List<SalesLineFormatter>`	`getSaleLines()` Retrieves a list of all sales lines.
`int`	`getSales()` Return the number of sales transactions
`DiscountLineFormatter`	`getSalesByAccountingLevel(int mask)`
`AbstractTableModel`	`getSalesModel()` The sales table model is meant to be used in JPanelCloseMoney only.
`Double`	`getSalesSubtotal()` Net sum of all sales as Double
`Double`	`getSalesTotal()` Gross sum of all sales calculated from the ticketlines as Double.
`double`	`getTotal()` Total of all payments made.
`static PaymentsModel`	`loadInstance(CashRegister reg, String host, User user)` Loads all data related to the active cash register.
`String`	`printDateStart()` Start date of the current cash register formatted as timestamp string.
`String`	`printPayments()` Returns the total number of payments including top up's as string.
`String`	`printPaymentsTotal()` Return the total of payments formatted as string (excluding top up's).
`String`	`printSales()` Return the string formatted number of sales transactions.
`String`	`printSalesSubtotal()` Net sum of all sales calculated from the ticketlines formatted as currency.
`String`	`printSalesTotal()` Gross sum of all sales calculated from the ticketlines formatted as currency.
`void`	`setDateEnd(Date dValue)` Set the closing date for cash close.

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

- Field Detail
  - m_sHost
```
protected String m_sHost
```
  - m_dDateStart
```
protected Date m_dDateStart
```
  - m_dDateEnd
```
protected Date m_dDateEnd
```
  - m_iPayments
```
protected Integer m_iPayments
```
  - m_lPayments
```
protected List<Object[]> m_lPayments
```
  - m_oDiscounts
```
protected List<Object[]> m_oDiscounts
```
  - m_lDiscounts
```
protected List<DiscountLineFormatter> m_lDiscounts
```
  - m_linesByAccountingLevel
```
protected List<AccountingLineFormatter> m_linesByAccountingLevel
```
  - m_linesByModifiers
```
protected List<AccountingLineFormatter> m_linesByModifiers
```
  - slines
```
protected List<SalesLineFormatter> slines
```
  - m_iSales
```
protected Integer m_iSales
```
  - m_dSalesSubtotal
```
protected Double m_dSalesSubtotal
```
  - m_dSalesTotal
```
protected Double m_dSalesTotal
```
  - SALEHEADERS
```
protected static final String[] SALEHEADERS
```
  - m_serialNr
```
protected Integer m_serialNr
```
  - m_user
```
protected User m_user
```
  - m_tickets
```
protected Set<Ticket> m_tickets
```
  - m_reg
```
protected static CashRegister m_reg
```
  - instance
```
protected static PaymentsModel instance
```
  - m_minNumber
```
protected Integer m_minNumber
```
  - m_maxNumber
```
protected Integer m_maxNumber
```
- Method Detail
  - emptyInstance
```
public static PaymentsModel emptyInstance()
```
    PaymentsModel defines all methods that can be referenced in Printer.CloseCash.xml and and Printer.CurrentCash.xml and are used in JPanelCloseMoney and JPanelCloseCash.
    
    Returns:
    
    an empty instance of PaymentsModel
  - loadInstance
```
public static PaymentsModel loadInstance(CashRegister reg,
                                         String host,
                                         User user)
                                  throws BasicException
```
    Loads all data related to the active cash register.
    
    Parameters:
    
    reg -
    
    host -
    
    user -
    
    Returns:
    
    return a PaymentsModel instance filled with data.
    
    Throws:
    
    BasicException
  - getPaymentGroups
```
public HashMap<String,PaymentsLineFormatter[]> getPaymentGroups()
```
    Returns a hash with key value pairs where the key represents a payment method and the value represents a vector of PaymentLines
    
    Returns:
    
    a hash which can contain the following keys:
    cash: cash - cashrefund
    cashin: cashin - cashout
    cheque: cheque - chequerefund
    credit: credit - creditredeem
    cheque: cheque - chequerefund
    magcard: magcard - magcardrefund
    membercard: paperin - paperout
    membercard: ticket - ticketremain
    membercard: daycashout
    membercard: invoice
  - getPayments
```
public int getPayments()
```
    Number of payments
    
    Returns:
    
    the number of payments made
  - getTotal
```
public double getTotal()
```
    Total of all payments made.
    
    Returns:
    
    the sum of all payment amounts. Top up's are not counted.
  - getHost
```
public String getHost()
```
    Host name of the current host. This is generally the host for which the active cash is closed.
    
    Returns:
    
    the host name
  - getDateStart
```
public Date getDateStart()
```
    Start date of the active cash register.
    
    Returns:
    
    the start date of the active cash register
  - printDateStart
```
public String printDateStart()
```
    Start date of the current cash register formatted as timestamp string.
    
    Returns:
    
    the start date as String
  - getCashCloseNr
```
public Integer getCashCloseNr()
```
    Get the serial number of the active cashregister for the current host.
    
    Returns:
    
    the serial number.
  - setDateEnd
```
public void setDateEnd(Date dValue)
```
    Set the closing date for cash close.
    
    Parameters:
    
    dValue - is the date value to set.
  - getDateEnd
```
public Date getDateEnd()
```
    Get the closing date for cash close.
    
    Returns:
    
    the closing date.
  - printPayments
```
public String printPayments()
```
    Returns the total number of payments including top up's as string.
    
    Returns:
    
    the total number of payments.
  - printPaymentsTotal
```
public String printPaymentsTotal()
```
    Return the total of payments formatted as string (excluding top up's).
    
    Returns:
    
    the total of payments.
  - getSales
```
public int getSales()
```
    Return the number of sales transactions
    
    Returns:
    
    the number of sales transactions.
  - printSales
```
public String printSales()
```
    Return the string formatted number of sales transactions.
    
    Returns:
    
    th string formattede number of sales transactions
  - printSalesSubtotal
```
public String printSalesSubtotal()
```
    Net sum of all sales calculated from the ticketlines formatted as currency.
    
    Returns:
    
    net sum of all sales.
  - getSalesSubtotal
```
public Double getSalesSubtotal()
```
    Net sum of all sales as Double
    
    Returns:
    
    net sum of all sales.
  - printSalesTotal
```
public String printSalesTotal()
```
    Gross sum of all sales calculated from the ticketlines formatted as currency.
    
    Returns:
    
    gross sum of all sales.
  - getSalesTotal
```
public Double getSalesTotal()
```
    Gross sum of all sales calculated from the ticketlines as Double.
    
    Returns:
    
    gross sum of all sales.
  - getMinTicketNum
```
public Integer getMinTicketNum()
```
    Print the first ticket number of this sales period
    
    Returns:
    
    the first ticket number as String
  - getMaxTicketNum
```
public Integer getMaxTicketNum()
```
    Print the last ticket number of this sales period
    
    Returns:
    
    the last ticket number as String
  - getPaymentLines
```
public List<PaymentsLineFormatter> getPaymentLines()
```
    Retrieves a list of all payment lines. PaymentLine as a class has an own set of methods that can be applied to a payment line.
    
    Returns:
    
    a list of all payment lines formatters
  - getSalesByAccountingLevel
```
public DiscountLineFormatter getSalesByAccountingLevel(int mask)
```
  - addPaymentLine
```
public void addPaymentLine(Object[] pline)
```
  - getSaleLines
```
public List<SalesLineFormatter> getSaleLines()
```
    Retrieves a list of all sales lines. SalesLine as a class has an own set of methods that can be applied to a sales line.
    
    Returns:
    
    a list of all sales lines
  - getPaymentsModel
```
public AbstractTableModel getPaymentsModel()
```
    The payment table model is meant to be used in JPanelCloseMoney only.
    
    Returns:
    
    the payment table model
  - getDiscountLines
```
public List<DiscountLineFormatter> getDiscountLines()
```
    Retrieves the list of discount line formatters. DiscountLine as a class The DiscountLineFormatter class provides methods to insert the values into a printer template.
    
    Returns:
    
    The list of discount lines
  - getAccountingLines
```
public List<AccountingLineFormatter> getAccountingLines(int levelMask)
```
    Retrieves sales values for products having the accounting levels in levelMask. The AccountingLineFormatter class provides methods to insert the values into a printer template.
    
    Parameters:
    
    levelMask - The mask representing the desired accounting levels.
    
    Returns:
    
    the list of accounting lines.
  - getAccountingLines
```
public List<AccountingLineFormatter> getAccountingLines(int levelMask,
                                                        boolean groupByProduct)
```
    Retrieves sales values for products having the accounting levels in levelMask. The AccountingLineFormatter class provides methods to insert the values into a printer template.
    
    Parameters:
    
    levelMask - The mask representing the desired accounting levels.
    
    groupByProduct -
    
    Returns:
    
    the list of accounting lines.
  - getAccountingLinesByModifier
```
public List<AccountingLineFormatter> getAccountingLinesByModifier(int modifierMask,
                                                                  boolean groupByProduct)
```
    Retrieves sales values for products having the modifiers in modifierMask set. The AccountingLineFormatter class provides methods to insert the values into a printer template.
    
    Parameters:
    
    modifierMask -
    
    groupByProduct -
    
    Returns:
    
    the list of accounting lines.
  - getSalesModel
```
public AbstractTableModel getSalesModel()
```
    The sales table model is meant to be used in JPanelCloseMoney only.
    
    Returns:
    
    the sales table model
  - getCurrentRegister
```
public Integer getCurrentRegister(String host)
```
    Get the serial number of the current register for host.
    
    Parameters:
    
    host - hostname to get the current serial number from.
    
    Returns:
    
    the serial number of the hosts current register.
  - getPaymentLinesByHosts
```
public List<PaymentsLineFormatter> getPaymentLinesByHosts(String hosts)
```
    Get a list of PaymentLineFormatters for the listed hosts. The list is grouped by hosts, users, and methods
    
    Parameters:
    
    hosts - comma separated list of hostnames
    
    Returns:
    
    a list of PaymentLineFormatters for the listed hosts
  - getPaymentLinesByUser
```
public List<PaymentsLineFormatter> getPaymentLinesByUser()
```
    Get a list of PaymentsLineFormatters for the selected register of the current host. The list is grouped by users and methods.
    
    Returns:
    
    a list of PaymentLineFormatters for register
  - getActiveCash
```
public CashRegister getActiveCash()
```

Class PaymentsModel

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

m_sHost

m_dDateStart

m_dDateEnd

m_iPayments

m_lPayments

m_oDiscounts

m_lDiscounts

m_linesByAccountingLevel

m_linesByModifiers

slines

m_iSales

m_dSalesSubtotal

m_dSalesTotal

SALEHEADERS

m_serialNr

m_user

m_tickets

m_reg

instance

m_minNumber

m_maxNumber

Method Detail

emptyInstance

loadInstance

getPaymentGroups

getPayments

getTotal

getHost

getDateStart

printDateStart

getCashCloseNr

setDateEnd

getDateEnd

printPayments

printPaymentsTotal

getSales

printSales

printSalesSubtotal

getSalesSubtotal

printSalesTotal

getSalesTotal

getMinTicketNum

getMaxTicketNum

getPaymentLines

getSalesByAccountingLevel

addPaymentLine

getSaleLines

getPaymentsModel

getDiscountLines

getAccountingLines

getAccountingLines

getAccountingLinesByModifier

getSalesModel

getCurrentRegister

getPaymentLinesByHosts

getPaymentLinesByUser

getActiveCash