org.broadleafcommerce.core.payment.service

Class PaymentContextImpl

java.lang.Object

org.broadleafcommerce.core.payment.service.PaymentContextImpl

All Implemented Interfaces:

PaymentContext

public class PaymentContextImpl
extends Object
implements PaymentContext

Field Summary

Fields

Modifier and Type	Field and Description
protected Money	originalPaymentAmount
protected PaymentInfo	paymentInfo
protected Referenced	referencedPaymentInfo
protected Money	remainingPaymentAmount
protected Money	remainingTransactionAmount
protected Money	transactionAmount
protected String	transactionId
protected String	userName

Constructor Summary

Constructors

Constructor and Description
PaymentContextImpl(Money transactionAmount, Money remainingTransactionAmount, PaymentInfo paymentInfo, Referenced referencedPaymentInfo, String userName)

Method Summary

Methods

Modifier and Type	Method and Description
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 remainingTransactionAmount) Sets the remaining transaction amount.
void	setTransactionAmount(Money transactionAmount) Sets the transaction amount
void	setTransactionId(String transactionId)

Methods inherited from class java.lang.Object

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

Field Detail

originalPaymentAmount

protected Money originalPaymentAmount

remainingPaymentAmount

protected Money remainingPaymentAmount

transactionAmount

protected Money transactionAmount

remainingTransactionAmount

protected Money remainingTransactionAmount

paymentInfo

protected PaymentInfo paymentInfo

referencedPaymentInfo

protected Referenced referencedPaymentInfo

transactionId

protected String transactionId

userName

protected String userName

Constructor Detail

PaymentContextImpl

public PaymentContextImpl(Money transactionAmount,
                  Money remainingTransactionAmount,
                  PaymentInfo paymentInfo,
                  Referenced referencedPaymentInfo,
                  String userName)

Method Detail

getOriginalPaymentAmount

@Deprecated
public Money getOriginalPaymentAmount()

Deprecated.

Specified by:

getOriginalPaymentAmount in interface PaymentContext

See Also:

PaymentContext.getTransactionAmount()

getRemainingPaymentAmount

@Deprecated
public Money getRemainingPaymentAmount()

Deprecated.

Specified by:

getRemainingPaymentAmount in interface PaymentContext

See Also:

PaymentContext.getRemainingTransactionAmount()

getTransactionAmount

public Money getTransactionAmount()

Description copied from interface: PaymentContext

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.

Specified by:

getTransactionAmount in interface PaymentContext

Returns:

setTransactionAmount

public void setTransactionAmount(Money transactionAmount)

Description copied from interface: PaymentContext

Sets the transaction amount

Specified by:

setTransactionAmount in interface PaymentContext

getRemainingTransactionAmount

public Money getRemainingTransactionAmount()

Description copied from interface: PaymentContext

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.

Specified by:

getRemainingTransactionAmount in interface PaymentContext

Returns:

setRemainingTransactionAmount

public void setRemainingTransactionAmount(Money remainingTransactionAmount)

Description copied from interface: PaymentContext

Sets the remaining transaction amount.

Specified by:

setRemainingTransactionAmount in interface PaymentContext

getPaymentInfo

public PaymentInfo getPaymentInfo()

Specified by:

getPaymentInfo in interface PaymentContext

getReferencedPaymentInfo

public Referenced getReferencedPaymentInfo()

Specified by:

getReferencedPaymentInfo in interface PaymentContext

getTransactionId

public String getTransactionId()

Specified by:

getTransactionId in interface PaymentContext

setTransactionId

public void setTransactionId(String transactionId)

Specified by:

setTransactionId in interface PaymentContext

getUserName

public String getUserName()

Specified by:

getUserName in interface PaymentContext