org.posper.hibernate.formatters

Class PaymentFormatter

java.lang.Object

org.posper.hibernate.formatters.PaymentFormatter

public class PaymentFormatter
extends Object

Provide additional methods to retrieve (formatted) Payment contents.

Author:

Aaron Luchko

Constructor Summary

Constructors

Constructor and Description
PaymentFormatter(Payment payment) Create a PaymentFormatter object

Method Summary

Modifier and Type	Method and Description
Double	getAmount() Retrieve the amount of the payment.
String	getAuthCode() Return the authorization code as returned by the gateway
Double	getCardBalance() Get the amount of the current closing balance.
String	getCardNumber() Return the holder name as returned by the gateway
String	getComment() Return the comment.
String	getHolderName() Return the holder name as returned by the gateway
String	getMethod() Convenience method to directly retrieve the payment method (i.e."
String	getName() Return the payment name.
PaymentInfo	getPaymentInfo() Retrieve the original PaymentInfo object.
Integer	getSerial() Return the serial number.
String	printAmount() Print the amount of the payment.
String	printCardBalance() Print the amount of the current closing balance.
String	printCreditBarcode() Print the barcode for a credit receipt
String	printsAmount() Print the amount of the payment.
String	printsCardBalance() Print the amount of the current closing balance.

Methods inherited from class java.lang.Object

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

Constructor Detail

PaymentFormatter

public PaymentFormatter(Payment payment)

Create a PaymentFormatter object

Parameters:

payment -

Method Detail

getPaymentInfo

public PaymentInfo getPaymentInfo()

Retrieve the original PaymentInfo object. PaymentInfo is abstract. The retrieved object is depending of context and the payment method.
Note that PaymentInfo objects are transient and you should know what you are doing if you use them.

Returns:

a PaymentInfo object

getMethod

public String getMethod()

Convenience method to directly retrieve the payment method (i.e."cash", don't confuse with Payment methods like getAmount()).

Returns:

the payment method

getAmount

public Double getAmount()

Retrieve the amount of the payment.

Returns:

the payment amount

printAmount

public String printAmount()

Print the amount of the payment.

Returns:

a curency formatted string

printsAmount

public String printsAmount()

Print the amount of the payment.

Returns:

a 2 decimals formatted string

printCardBalance

public String printCardBalance()

Print the amount of the current closing balance.

Returns:

a currency formatted string with the current closing balance.

printsCardBalance

public String printsCardBalance()

Print the amount of the current closing balance.

Returns:

a 2 decimals formatted string with the current closing balance. If the Balance is 0.0 an empty string is returned.

getCardBalance

public Double getCardBalance()

Get the amount of the current closing balance.

Returns:

the amount of the current closing balance as Double

getComment

public String getComment()

Return the comment.

Returns:

the comment string

getName

public String getName()

Return the payment name. The name is introduced from the entries as defined in the Payment.Types template

Returns:

the name string

getSerial

public Integer getSerial()

Return the serial number.

Returns:

the serial number

getAuthCode

public String getAuthCode()

Return the authorization code as returned by the gateway

Returns:

the authorization code as String

printCreditBarcode

public String printCreditBarcode()

Print the barcode for a credit receipt

Returns:

the barcode string

getHolderName

public String getHolderName()

Return the holder name as returned by the gateway

Returns:

the holder name as String if we have a card payment, otherwise null or an empty string.

getCardNumber

public String getCardNumber()

Return the holder name as returned by the gateway

Returns:

the holder name as String if we have a card payment, otherwise null or an empty string.