org.broadleafcommerce.core.payment.domain

Class PaymentTransactionImpl

java.lang.Object

org.broadleafcommerce.core.payment.domain.PaymentTransactionImpl

All Implemented Interfaces:

Serializable, MultiTenantCloneable<PaymentTransaction>, AdditionalFields, Status, PaymentTransaction

@Entity
public class PaymentTransactionImpl
extends Object
implements PaymentTransaction

Author:

Jerry Ocanas (jocanas)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,String>	additionalFields
protected BigDecimal	amount
protected ArchiveStatus	archiveStatus
protected String	customerIpAddress
protected Date	date
protected Long	id
protected OrderPayment	orderPayment
protected PaymentTransaction	parentTransaction Necessary for operations on a payment that require something to have happened beforehand.
protected String	rawResponse
protected Boolean	saveToken
protected Boolean	success
protected String	type

Constructor Summary

Constructors

Constructor and Description
PaymentTransactionImpl()

Method Summary

Modifier and Type	Method and Description
<G extends PaymentTransaction> CreateResponse<G>	createOrRetrieveCopyInstance(MultiTenantCopyContext context) Clone this entity for the purpose of multiple tenancy.
Map<String,String>	getAdditionalFields()
Money	getAmount() Gets the amount that this transaction is for
Character	getArchived()
String	getCustomerIpAddress() Gets the Customer IP address that instigated this transaction.
Date	getDate() Gets the date that this transaction was made on
Long	getId()
OrderPayment	getOrderPayment() The overall payment that this transaction applies to.
PaymentTransaction	getParentTransaction() Transactions can have a parent-child relationship for modifying transactions that can occur.
String	getRawResponse() Gets the string-representation of the serialized response from the gateway.
Boolean	getSuccess() Gets whether or not this transaction was successful.
PaymentTransactionType	getType() The type of
boolean	isActive()
boolean	isSaveToken() Indicates whether or not this transaction on the Order Payment contains a payment token (i.e.
void	setAdditionalFields(Map<String,String> additionalFields)
void	setAmount(Money amount) Sets the amount of this transaction
void	setArchived(Character archived)
void	setCustomerIpAddress(String customerIpAddress) Sets the Customer IP address that instigated the transaction.
void	setDate(Date date) Sets the date that this transaction was made on
void	setId(Long id)
void	setOrderPayment(OrderPayment orderPayment) Sets the overall payment that this transaction applies to
void	setParentTransaction(PaymentTransaction parentTransaction)
void	setRawResponse(String rawResponse) Sets the raw response that was returned from the gateway.
void	setSaveToken(boolean saveToken) Mark this transaction as containing (or going to contain) a token that should be saved on the user's profile as a CustomerPayment
void	setSuccess(Boolean success)
void	setType(PaymentTransactionType type)

Methods inherited from class java.lang.Object

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

Field Detail

id

protected Long id

type

protected String type

amount

protected BigDecimal amount

date

protected Date date

customerIpAddress

protected String customerIpAddress

rawResponse

protected String rawResponse

success

protected Boolean success

archiveStatus

protected ArchiveStatus archiveStatus

orderPayment

protected OrderPayment orderPayment

parentTransaction

protected PaymentTransaction parentTransaction

Necessary for operations on a payment that require something to have happened beforehand. For instance, an AUTHORIZE would not have a parent but a CAPTURE must have an AUTHORIZE parent and a REFUND must have a CAPTURE parent

additionalFields

protected Map<String,String> additionalFields

saveToken

protected Boolean saveToken

Constructor Detail

PaymentTransactionImpl

public PaymentTransactionImpl()

Method Detail

getId

public Long getId()

Specified by:

getId in interface PaymentTransaction

setId

public void setId(Long id)

Specified by:

setId in interface PaymentTransaction

getOrderPayment

public OrderPayment getOrderPayment()

Description copied from interface: PaymentTransaction

The overall payment that this transaction applies to. Note that if the relationship to an order payment is unset on this particular transaction, then this will automatically attempt to obtain the OrderPayment from PaymentTransaction.getParentTransaction().

Specified by:

getOrderPayment in interface PaymentTransaction

setOrderPayment

public void setOrderPayment(OrderPayment orderPayment)

Description copied from interface: PaymentTransaction

Sets the overall payment that this transaction applies to

Specified by:

setOrderPayment in interface PaymentTransaction

getParentTransaction

public PaymentTransaction getParentTransaction()

Description copied from interface: PaymentTransaction

Transactions can have a parent-child relationship for modifying transactions that can occur. Examples of this:

• PaymentTransactionType.CAPTURE -> PaymentTransactionType.AUTHORIZE
• PaymentTransactionType.REFUND -> PaymentTransactionType.CAPTURE OR PaymentTransactionType.SETTLED
• PaymentTransactionType.SETTLED -> PaymentTransactionType.CAPTURE
• PaymentTransactionType.VOID -> PaymentTransactionType.CAPTURE
• PaymentTransactionType.REVERSE_AUTH -> PaymentTransactionType.AUTHORIZE

For PaymentTransactionType.UNCONFIRMED, they will have children that will be either PaymentTransactionType.AUTHORIZE or PaymentTransactionType.AUTHORIZE_AND_CAPTURE.

Specified by:

getParentTransaction in interface PaymentTransaction

Returns:

setParentTransaction

public void setParentTransaction(PaymentTransaction parentTransaction)

Specified by:

setParentTransaction in interface PaymentTransaction

getType

public PaymentTransactionType getType()

Description copied from interface: PaymentTransaction

The type of

Specified by:

getType in interface PaymentTransaction

Returns:

setType

public void setType(PaymentTransactionType type)

Specified by:

setType in interface PaymentTransaction

getAmount

public Money getAmount()

Description copied from interface: PaymentTransaction

Gets the amount that this transaction is for

Specified by:

getAmount in interface PaymentTransaction

setAmount

public void setAmount(Money amount)

Description copied from interface: PaymentTransaction

Sets the amount of this transaction

Specified by:

setAmount in interface PaymentTransaction

getDate

public Date getDate()

Description copied from interface: PaymentTransaction

Gets the date that this transaction was made on

Specified by:

getDate in interface PaymentTransaction

setDate

public void setDate(Date date)

Description copied from interface: PaymentTransaction

Sets the date that this transaction was made on

Specified by:

setDate in interface PaymentTransaction

getCustomerIpAddress

public String getCustomerIpAddress()

Description copied from interface: PaymentTransaction

Gets the Customer IP address that instigated this transaction. This is an optional field

Specified by:

getCustomerIpAddress in interface PaymentTransaction

setCustomerIpAddress

public void setCustomerIpAddress(String customerIpAddress)

Description copied from interface: PaymentTransaction

Sets the Customer IP address that instigated the transaction. This is an optional field.

Specified by:

setCustomerIpAddress in interface PaymentTransaction

getRawResponse

public String getRawResponse()

Description copied from interface: PaymentTransaction

Gets the string-representation of the serialized response from the gateway. This is usually the complete request parameter map serialized in string form.

Specified by:

getRawResponse in interface PaymentTransaction

setRawResponse

public void setRawResponse(String rawResponse)

Description copied from interface: PaymentTransaction

Sets the raw response that was returned from the gateway.

Specified by:

setRawResponse in interface PaymentTransaction

getSuccess

public Boolean getSuccess()

Description copied from interface: PaymentTransaction

Gets whether or not this transaction was successful. There are multiple reasons that a transaction could be unsuccessful such as failed credit card processing or any other errors from the gateway.

Specified by:

getSuccess in interface PaymentTransaction

setSuccess

public void setSuccess(Boolean success)

Specified by:

setSuccess in interface PaymentTransaction

getAdditionalFields

public Map<String,String> getAdditionalFields()

Specified by:

getAdditionalFields in interface AdditionalFields

Specified by:

getAdditionalFields in interface PaymentTransaction

See Also:

PaymentAdditionalFieldType}

setAdditionalFields

public void setAdditionalFields(Map<String,String> additionalFields)

Specified by:

setAdditionalFields in interface AdditionalFields

Specified by:

setAdditionalFields in interface PaymentTransaction

isSaveToken

public boolean isSaveToken()

Description copied from interface: PaymentTransaction

Indicates whether or not this transaction on the Order Payment contains a payment token (i.e. PaymentAdditionalFieldType.TOKEN) and should be saved as a CustomerPayment on the user's profile

Specified by:

isSaveToken in interface PaymentTransaction

Returns:

- whether or not this transaction should be tokenized

setSaveToken

public void setSaveToken(boolean saveToken)

Description copied from interface: PaymentTransaction

Mark this transaction as containing (or going to contain) a token that should be saved on the user's profile as a CustomerPayment

Specified by:

setSaveToken in interface PaymentTransaction

getArchived

public Character getArchived()

Specified by:

getArchived in interface Status

setArchived

public void setArchived(Character archived)

Specified by:

setArchived in interface Status

isActive

public boolean isActive()

Specified by:

isActive in interface Status

createOrRetrieveCopyInstance

public <G extends PaymentTransaction> CreateResponse<G> createOrRetrieveCopyInstance(MultiTenantCopyContext context)
                                                                              throws CloneNotSupportedException

Description copied from interface: MultiTenantCloneable

Clone this entity for the purpose of multiple tenancy. Note, extending classes should follow this pattern:

public CreateResponse<MyClass> createOrRetrieveCopyInstance(MultiTenantCopyContext context) throws CloneNotSupportedException { CreateResponse<MyClass> createResponse = super.createOrRetrieveCopyInstance(context); if (createResponse.isAlreadyPopulated()) { return createResponse; } MyClass myClone = createResponse.getClone(); //copy extended field values on myClone here return createResponse; }

Support should also be added for @Embeddable classes that contribute fields (collections or basic) to a cloneable entity:

public CreateResponse<G extends MyClass> createOrRetrieveCopyInstance(MultiTenantCopyContext context) throws CloneNotSupportedException { CreateResponse createResponse = context.createOrRetrieveCopyInstance(this); MyClass myClone = createResponse.getClone(); //copy extended field values on myClone here return createResponse; }

Specified by:

createOrRetrieveCopyInstance in interface MultiTenantCloneable<PaymentTransaction>

Parameters:

context - a context object providing persistence and library functionality for copying entities

Returns:

the resulting copy container, possibly already persisted

Throws:

CloneNotSupportedException - if there's a problem detected with the cloning configuration