org.posper.hibernate.formatters

Class PaymentsLineFormatter

java.lang.Object

org.posper.hibernate.formatters.PaymentsLineFormatter

public class PaymentsLineFormatter
extends Object

Author:

hans

Constructor Summary

Constructors

Constructor and Description
PaymentsLineFormatter(String type, Double value, String user, String host, String currencyCode, Double currencyConversion, String comment) Creates a new PaymentsLine instance.

Method Summary

Modifier and Type	Method and Description
String	getComment() The comment of the payment.
String	getType() The payment type string as stored in the DB.
String	getUserName() The name of the user associated with the ticket belonging to the payment.
Double	getValue() The total amount for the respective type.
String	printForeignValue() The currency formatted total for payments made in a foreign currency.
String	printsValue() The 2 decimals formatted total for the respective type.
String	printType() The localized payment type string.
String	printValue() The currency formatted total for the respective type.

Methods inherited from class java.lang.Object

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

Constructor Detail

PaymentsLineFormatter

public PaymentsLineFormatter(String type,
                             Double value,
                             String user,
                             String host,
                             String currencyCode,
                             Double currencyConversion,
                             String comment)

Creates a new PaymentsLine instance. For list of payment types see (?) TODO publish this list somewhere. A valid list can always be retrieved from the localization files posper.messages. Each type must be present with key=transpayment.<type>

Parameters:

type - payment type, e.g. cash or magcard

value -

Method Detail

printType

public String printType()

The localized payment type string. If the option paymentsByComment is set the comment field will be appended to the type string.

Returns:

the localized payment type string

getType

public String getType()

The payment type string as stored in the DB.

Returns:

the generic payment type.

printsValue

public String printsValue()

The 2 decimals formatted total for the respective type.

Returns:

the total formatted as string with 2 decimals.

printValue

public String printValue()

The currency formatted total for the respective type.

Returns:

the total formatted as currency string.

printForeignValue

public String printForeignValue()

The currency formatted total for payments made in a foreign currency.

Returns:

the total formatted as currency string.

getValue

public Double getValue()

The total amount for the respective type.

Returns:

the total amount

getUserName

public String getUserName()

The name of the user associated with the ticket belonging to the payment.

Returns:

the user name as string.

getComment

public String getComment()

The comment of the payment. For magcards this is the card circuit.

Returns:

the comment as string.