org.posper.fiscal

Class JTurnoverCounter

java.lang.Object

org.posper.fiscal.JTurnoverCounter

Direct Known Subclasses:

JTurnoverCounterAT

public abstract class JTurnoverCounter
extends Object

The turnover counter provides methods to set, increment, and get a turnover counter. The turnover counter depends on the ticket number.

Author:

hans

Constructor Summary

Constructors

Constructor and Description
JTurnoverCounter(int iNumber) The turnover counter is independent of country specific regulations and shall always reflect the latest comitted turnover total.

Method Summary

Modifier and Type	Method and Description
void	commitAndClose() Close must be called to have the counter record saved, the transaction committed, and the session closed.
Long	getPreviousTurnover() The turnover value associated with the instance
Long	getTurnover() The turnover value associated with the instance
abstract Long	getTurnoverFromTicketlines(String register_list) The turnover can be calculated from ticketlines.
void	incrementTurnover(Long turnover) Increments the turnover value.
void	setTurnover(long turnover) The turnover counter should never be set to an absolute value except at the very start of using the financial security module or after failures in setting the turnover counter.

Methods inherited from class java.lang.Object

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

Constructor Detail

JTurnoverCounter

public JTurnoverCounter(int iNumber)
                 throws FiscalTurnoverException

The turnover counter is independent of country specific regulations and shall always reflect the latest comitted turnover total. This will be assured by checking the current and the previous ticket. The turnover is always related to a ticket with a 'number' > 0 and can only be set if the previous ticket has a turnover value != null and the current ticket has turnover = null. If another instance closes a ticket at nearly the same time we could find a previous entry with no turnover set. Re-reading the entries in short intervals should solve the conflict or we have a differrent error. Instantiating this class creates a session on its own and opens a transaction. After normal processing the close() method must be called to save the entry, commit the transaction, and close the session.

Parameters:

iNumber -

Throws:

FiscalTurnoverException

Method Detail

getTurnover

public Long getTurnover()

The turnover value associated with the instance

Returns:

the turnover value as Long

getPreviousTurnover

public Long getPreviousTurnover()

The turnover value associated with the instance

Returns:

the turnover value as Long

getTurnoverFromTicketlines

public abstract Long getTurnoverFromTicketlines(String register_list)

The turnover can be calculated from ticketlines. This must be implemented country specifically because it's different which payment methods are being considered as relevent for the turnover

Parameters:

register_list - a comma separated list of register names to retrieve the values from (register_list=ALL|<name1>[,...])

Returns:

the calculated turnover value

setTurnover

public void setTurnover(long turnover)

The turnover counter should never be set to an absolute value except at the very start of using the financial security module or after failures in setting the turnover counter. Country secific regulations must be respected.

Parameters:

turnover -

commitAndClose

public void commitAndClose()

Close must be called to have the counter record saved, the transaction committed, and the session closed.

incrementTurnover

public void incrementTurnover(Long turnover)
                       throws FiscalTurnoverException

Increments the turnover value. The ticket number is used to assure that no turnover value for this given ticket exists. We check if the turnover value for the given number is null. If so, the turnover value can be set. We also check if the turnover value for the previous ticket exists. If so, the value can be incremented If not, we wait for 500ms and retry 2 times.

Parameters:

turnover -

Throws:

FiscalTurnoverException