org.posper.hibernate

Class Payment

java.lang.Object

org.posper.hibernate.AbstractHibernateObject<Type>

org.posper.hibernate.AbstractIdentifiedHibernateObject<Payment>

org.posper.hibernate.Payment

All Implemented Interfaces:

Serializable, Cloneable

public class Payment
extends AbstractIdentifiedHibernateObject<Payment>
implements Cloneable

All payment records, related to both ticket and cashregister. Changes:

- added property cashregister

- cashregister is set to ActiveCash on creation

- amount will be rounded to two digits when set

- version for clone set to zero

Author:

Hans, Aaron Luchko

See Also:

Serialized Form

Field Summary

Fields inherited from class org.posper.hibernate.AbstractIdentifiedHibernateObject

id

Constructor Summary

Constructors

Constructor and Description
Payment() Contructor, always set current cashregister relationship

Method Summary

Modifier and Type	Method and Description
Payment	clone()
void	delete() This is a convenience method to wrap the operation in a transaction.
double	getAmount()
String	getAuth_code() This is the authentication code for credit card payments.
String	getCard_number()
CashRegister	getCashregister()
String	getComment()
Double	getConversion_rate()
String	getCurrency_code()
String	getHolder_name()
String	getMethod()
String	getName() The name of the payment method.
PaymentInfo	getPaymentInfo()
Integer	getSerial() A serial number can be used to identify payments created in the Payments dialog.
Ticket	getTicket()
Payment	getTipRecord()
void	revertGatewayPayment() Revert a card related payment: The gateway transaction is reverted if possible.
void	setActiveCash()
void	setAmount(Double amount)
void	setAuth_code(String auth_code) See getAuth_code
void	setCard_number(String card_number)
void	setCashregister(CashRegister cashregister)
void	setComment(String comment)
void	setConversion_rate(Double conversion_rate)
void	setCurrency_code(String currency_code)
void	setHolder_name(String holder_name)
void	setMethod(String method)
void	setName(String name) The name of the payment method.
void	setPaymentInfo(PaymentInfo paymentInfo)
void	setSerial(Integer serial) The serial number should be set in a DB trigger rather then in POSper to have flexibility for customized solutions.
void	setTicket(Ticket ticket)
String	submitGatewayPayment() WIP: Submit the payment to the appropriate gateway.

Methods inherited from class org.posper.hibernate.AbstractIdentifiedHibernateObject

equals, getId, getVersion, hashCode, setId, setVersion

Methods inherited from class org.posper.hibernate.AbstractHibernateObject

getGetters, getKeyValue, merge, refresh, save

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Payment

public Payment()

Contructor, always set current cashregister relationship

Method Detail

getTicket

public Ticket getTicket()

setCashregister

public void setCashregister(CashRegister cashregister)

getCashregister

public CashRegister getCashregister()

getComment

public String getComment()

setComment

public void setComment(String comment)

setTicket

public void setTicket(Ticket ticket)

getAmount

public double getAmount()

Returns:

how much this payment was for, a negative value signifies the payment was out (refund) while positive is in (sale)

setAmount

public void setAmount(Double amount)

Parameters:

amount - how much this payment was for

getMethod

public String getMethod()

setMethod

public void setMethod(String method)

getConversion_rate

public Double getConversion_rate()

setConversion_rate

public void setConversion_rate(Double conversion_rate)

getCurrency_code

public String getCurrency_code()

setCurrency_code

public void setCurrency_code(String currency_code)

clone

public Payment clone()

Overrides:

clone in class Object

getPaymentInfo

public PaymentInfo getPaymentInfo()

Returns:

the paymentInfo

setPaymentInfo

public void setPaymentInfo(PaymentInfo paymentInfo)

Parameters:

paymentInfo - the paymentInfo to set

getSerial

public Integer getSerial()

A serial number can be used to identify payments created in the Payments dialog.

Returns:

the serial number as Integer

setSerial

public void setSerial(Integer serial)

The serial number should be set in a DB trigger rather then in POSper to have flexibility for customized solutions.

Parameters:

serial -

getName

public String getName()

The name of the payment method. This is a customer specific value and assigned in Payment.Types.

Returns:

the name string

setName

public void setName(String name)

The name of the payment method. This is a customer specific value and assigned in Payment.Types.

Parameters:

name -

setActiveCash

public void setActiveCash()

getAuth_code

public String getAuth_code()

This is the authentication code for credit card payments. Depending on the payment method this can be a customer specific value. For types 'credit' and 'redeem_credits' this is the ID of the associated credit record in a central database

Parameters:

name -

setAuth_code

public void setAuth_code(String auth_code)

See getAuth_code

Parameters:

auth_code -

getCard_number

public String getCard_number()

Returns:

setCard_number

public void setCard_number(String card_number)

getHolder_name

public String getHolder_name()

setHolder_name

public void setHolder_name(String holder_name)

submitGatewayPayment

public String submitGatewayPayment()

WIP: Submit the payment to the appropriate gateway. Not used yet.

Returns:

'OK' or an error message

revertGatewayPayment

public void revertGatewayPayment()
                          throws PaymentGatewayException

Revert a card related payment: The gateway transaction is reverted if possible. On failure an error message will be printed to the audit log as well as to posper.log. If the payment is not gateway related, the method does nothing. This method does not remove the payment from the ticket.

Throws:

PaymentGatewayException

delete

public void delete()
            throws BasicException

Description copied from class: AbstractHibernateObject

This is a convenience method to wrap the operation in a transaction. The current session contect is used. Hibernate should not be configured to close the session when a transaction is comitted. If the operation failes, the transaction is rolled back, the session is closed, and a BasicException is thrown. Take care not to use this method within a running transaction!

Overrides:

delete in class AbstractHibernateObject<Payment>

Throws:

BasicException

getTipRecord

public Payment getTipRecord()