CloseCashFormatter (posper 3.0 API)

java.lang.Object
- org.posper.hibernate.formatters.CloseCashFormatter

public class CloseCashFormatter
extends Object

Author:: hans

Constructor Summary

Constructors
Constructor and Description
`CloseCashFormatter(PaymentsModel oPayments)` CloseCashFormatter defines all methods that can be referenced in Printer.CloseCash.xml and and Printer.CurrentCash.xml through the $payments variable.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<AccountingLineFormatter>`	`getAccountingLines(int levelMask)` Retrieves a list of all accounting line formatters.
`Integer`	`getCashCloseNr()` Get the serial number of the active cashregister for the current host.
`String`	`getCompanyData(String element)` Retrieve elements from the CompanyData.xml ressource.
`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 a list of all discount line formatters.
`String`	`getHost()` Host name of the current host.
`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>`	`getPaymentLinesByHost(String hosts)` Get a list of PaymentLineFormatters for the listed hosts.
`List<PaymentsLineFormatter>`	`getPaymentLinesByUser()` Get a list of PaymentLineFormatters grouped by users and payment methods.
`int`	`getPayments()` Number of payments
`StatisticsFormatter`	`getRegisterStatistics()`
`List<SalesLineFormatter>`	`getSaleLines()` Retrieves the list of sales line formatters.
`int`	`getSales()` Return the number of sales transactions
`DiscountLineFormatter`	`getSalesByAccountingLevel(int levelsMask)` Get the statistics for products having defined accounting levels
`double`	`getTotal()` Total of all payments made.
`Set<String>`	`getUserNames()` Retrieve the distinct list of user names for users who were ever logged in during the current cash register period.
`String`	`printDateEnd()` End date of the current cash register formatted as timestamp string.
`String`	`printDateStart()` Start date of the current cash register formatted as timestamp string.
`String`	`printHost()` same as getHost()
`String`	`printMaxTicketNum()` Print the last ticket number of this sales period
`String`	`printMinTicketNum()` Print the first ticket number of this sales period
`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`	`printSalesTaxTotal()` Net sum of all sales calculated from the ticketlines, currency formatted string with 2 decimals.
`String`	`printSalesTotal()` Gross sum of all sales calculated from the ticketlines formatted as currency.
`String`	`printsSalesSubtotal()` Net sum of all sales calculated from the ticketlines formatted string with 2 decimals.
`String`	`printsSalesTaxTotal()` Net sum of all sales calculated from the ticketlines, formatted string with 2 decimals.
`String`	`printsSalesTotal()` Gross sum of all sales calculated from the ticketlines formatted with 2 decimals .
`void`	`refreshCompanyData()` Reread the company data resource.

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

- Constructor Detail
  - CloseCashFormatter
```
public CloseCashFormatter(PaymentsModel oPayments)
```
    CloseCashFormatter defines all methods that can be referenced in Printer.CloseCash.xml and and Printer.CurrentCash.xml through the $payments variable.
    
    Parameters:
    
    oPayments -
- Method Detail
  - getCashCloseNr
```
public Integer getCashCloseNr()
```
    Get the serial number of the active cashregister for the current host.
    
    Returns:
    
    the serial number.
  - getCompanyData
```
public String getCompanyData(String element)
```
    Retrieve elements from the CompanyData.xml ressource.
    
    Parameters:
    
    element -
    
    Returns:
    
    the value of element
  - refreshCompanyData
```
public void refreshCompanyData()
```
    Reread the company data resource. This can be used if tickets use frequently changing elements like advertising texts and changes shall immediately be available for the tickezs.
  - 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.
  - getDateEnd
```
public Date getDateEnd()
```
    Get the closing date for cash close.
    
    Returns:
    
    the closing date.
  - getDateStart
```
public Date getDateStart()
```
    Start date of the active cash register.
    
    Returns:
    
    the start date of the active cash register
  - getDiscountLines
```
public List<DiscountLineFormatter> getDiscountLines()
```
    Retrieves a list of all discount line formatters. DiscountLine as a class has an own set of methods that can be applied to a discount line.
    
    Returns:
    
    a list of all discount lines
  - getAccountingLines
```
public List<AccountingLineFormatter> getAccountingLines(int levelMask)
```
    Retrieves a list of all accounting line formatters.
    
    Parameters:
    
    levelMask -
    
    Returns:
    
    A AccountingLineFormatter list
  - 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
  - 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
    magcard: magcard - magcardrefund
    paper: paperin - paperout
    ticket: ticket - ticketremain
    daycashout: daycashout
    invoice: invoice
  - getPaymentLines
```
public List<PaymentsLineFormatter> getPaymentLines()
```
    Retrieves a list of all payment lines. PaymentsLineFormatter has an own set of methods that can be applied to a payment line.
    
    Returns:
    
    a list of all payment lines
  - getPayments
```
public int getPayments()
```
    Number of payments
    
    Returns:
    
    the number of payments made
  - getSaleLines
```
public List<SalesLineFormatter> getSaleLines()
```
    Retrieves the list of sales line formatters. A sales line formatter exists for each tax.
    
    Returns:
    
    a list of sales line formatters
  - getSales
```
public int getSales()
```
    Return the number of sales transactions
    
    Returns:
    
    the number of sales transactions.
  - getTotal
```
public double getTotal()
```
    Total of all payments made.
    
    Returns:
    
    the sum of all payment amounts. Top up's are not counted.
  - getPaymentLinesByHost
```
public List<PaymentsLineFormatter> getPaymentLinesByHost(String hosts)
```
    Get a list of PaymentLineFormatters for the listed hosts. The list is grouped by hosts, users, and methods. Only the current period of the respective host can bew reported.
    
    Parameters:
    
    hosts - comma separated list of hostnames. If hosts is empty, localhost is assumed.
    
    Returns:
    
    a list of PaymentLineFormatters for the listed hosts
  - getPaymentLinesByUser
```
public List<PaymentsLineFormatter> getPaymentLinesByUser()
```
    Get a list of PaymentLineFormatters grouped by users and payment methods. Depending on the context also previous register periods can be listed.
    
    Returns:
    
    a list of PaymentLineFormatters for the calling host and the period selected in m_payments.
  - printDateEnd
```
public String printDateEnd()
```
    End date of the current cash register formatted as timestamp string.
    
    Returns:
    
    the end date as String
  - printDateStart
```
public String printDateStart()
```
    Start date of the current cash register formatted as timestamp string.
    
    Returns:
    
    the start date as String
  - printHost
```
public String printHost()
```
    same as getHost()
    
    Returns:
  - 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.
  - 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.
  - printsSalesSubtotal
```
public String printsSalesSubtotal()
```
    Net sum of all sales calculated from the ticketlines formatted string with 2 decimals.
    
    Returns:
    
    net sum of all sales.
  - printsSalesTaxTotal
```
public String printsSalesTaxTotal()
```
    Net sum of all sales calculated from the ticketlines, formatted string with 2 decimals.
    
    Returns:
    
    net sum of all sales as string w/o currency
  - printSalesTaxTotal
```
public String printSalesTaxTotal()
```
    Net sum of all sales calculated from the ticketlines, currency formatted string with 2 decimals.
    
    Returns:
    
    net sum of all sales as currency formatted string
  - printSalesTotal
```
public String printSalesTotal()
```
    Gross sum of all sales calculated from the ticketlines formatted as currency.
    
    Returns:
    
    gross sum of all sales.
  - printsSalesTotal
```
public String printsSalesTotal()
```
    Gross sum of all sales calculated from the ticketlines formatted with 2 decimals .
    
    Returns:
    
    gross sum of all sales.
  - getSalesByAccountingLevel
```
public DiscountLineFormatter getSalesByAccountingLevel(int levelsMask)
```
    Get the statistics for products having defined accounting levels
    
    Parameters:
    
    levelsMask -
    
    Returns:
  - printMinTicketNum
```
public String printMinTicketNum()
```
    Print the first ticket number of this sales period
    
    Returns:
    
    the first ticket number as String
  - printMaxTicketNum
```
public String printMaxTicketNum()
```
    Print the last ticket number of this sales period
    
    Returns:
    
    the last ticket number as String
  - getUserNames
```
public Set<String> getUserNames()
```
    Retrieve the distinct list of user names for users who were ever logged in during the current cash register period.
    
    Returns:
    
    a list of strings with the user names.
  - getRegisterStatistics
```
public StatisticsFormatter getRegisterStatistics()
```

Class CloseCashFormatter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CloseCashFormatter

Method Detail

getCashCloseNr

getCompanyData

refreshCompanyData

getCurrentRegister

getDateEnd

getDateStart

getDiscountLines

getAccountingLines

getHost

getPaymentGroups

getPaymentLines

getPayments

getSaleLines

getSales

getTotal

getPaymentLinesByHost

getPaymentLinesByUser

printDateEnd

printDateStart

printHost

printPayments

printPaymentsTotal

printSales

printSalesSubtotal

printsSalesSubtotal

printsSalesTaxTotal

printSalesTaxTotal

printSalesTotal

printsSalesTotal

getSalesByAccountingLevel

printMinTicketNum

printMaxTicketNum

getUserNames

getRegisterStatistics