org.broadleafcommerce.core.payment.service
Interface PaymentContext

All Known Implementing Classes:

PaymentContextImpl

public interface PaymentContext

Method Summary

Money	getOriginalPaymentAmount() Deprecated.
PaymentInfo	getPaymentInfo()
Referenced	getReferencedPaymentInfo()
Money	getRemainingPaymentAmount() Deprecated.
Money	getRemainingTransactionAmount() Returns the remaining transaction amount that needs to be processed.
Money	getTransactionAmount() The amount that the system should attempt to process.
String	getTransactionId()
String	getUserName()
void	setRemainingTransactionAmount(Money amount) Sets the remaining transaction amount.
void	setTransactionAmount(Money amount) Sets the transaction amount
void	setTransactionId(String transactionId)

Method Detail

getOriginalPaymentAmount

Money getOriginalPaymentAmount()

Deprecated.

See Also:

getTransactionAmount()

getRemainingPaymentAmount

Money getRemainingPaymentAmount()

Deprecated.

See Also:

getRemainingTransactionAmount()

getTransactionAmount

Money getTransactionAmount()

The amount that the system should attempt to process. For example, when submitting an order, this would be the order.getTotal. If refunding $10, this would be 10.

Returns:

setTransactionAmount

void setTransactionAmount(Money amount)

Sets the transaction amount

Parameters:

amount -

getRemainingTransactionAmount

Money getRemainingTransactionAmount()

Returns the remaining transaction amount that needs to be processed. When using multiple forms of payment, each payment module will attempt to perform the operation if they are able to up to this amount.

Returns:

setRemainingTransactionAmount

void setRemainingTransactionAmount(Money amount)

Sets the remaining transaction amount.

Parameters:

amount -

getPaymentInfo

PaymentInfo getPaymentInfo()

getReferencedPaymentInfo

Referenced getReferencedPaymentInfo()

getTransactionId

String getTransactionId()

setTransactionId

void setTransactionId(String transactionId)

getUserName

String getUserName()