java.lang.Object
- com.broadleafcommerce.cartoperation.domain.payment.CreditAccountTransaction

All Implemented Interfaces:

com.broadleafcommerce.data.tracking.core.ContextStateAware, Serializable
```
public class CreditAccountTransaction
extends Object
implements Serializable, com.broadleafcommerce.data.tracking.core.ContextStateAware
```
The transaction information for the credit account.

Author:

Dima Myroniuk (dmyroniuk)

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

CreditAccountTransaction()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected boolean`	`canEqual(Object other)`
`boolean`	`equals(Object o)`
`javax.money.MonetaryAmount`	`getAmount()`	The amount related to this transaction.
`com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState`	`getContextState()`	A subset of `Tracking` information to expose the context state for this object.
`CreditAccountRef`	`getCreditAccountRef()`	The credit account reference to the credit account.
`javax.money.CurrencyUnit`	`getCurrency()`	The currency gathered from `getAmount()`
`Instant`	`getDateRecorded()`	The timestamp when this transaction response was recorded.
`String`	`getId()`	The id of this transaction.
`String`	`getReason()`	The reason for this transaction.
`String`	`getReasonDescription()`	Description for the reason for this transaction.
`String`	`getRequestId()`	The id used to represent the request that produced this transaction.
`String`	`getSource()`	The name of the system that initiated the transaction - e.g.
`String`	`getSourceEntityId()`	The ID of the source entity associated with the transaction.
`String`	`getSourceEntityType()`	The type of the source entity associated with the transaction.
`String`	`getSourceUserId()`	The id of user who initiated the transaction.
`String`	`getSourceUserType()`	The type of user who initiated the transaction.
`String`	`getTransactionReferenceId()`	The transaction id known by the payment gateway.
`String`	`getType()`	The type of this transaction.
`int`	`hashCode()`
`void`	`setAmount(javax.money.MonetaryAmount amount)`	The amount related to this transaction.
`void`	`setContextState(com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)`	A subset of `Tracking` information to expose the context state for this object.
`void`	`setCreditAccountRef(CreditAccountRef creditAccountRef)`	The credit account reference to the credit account.
`void`	`setCurrency(javax.money.CurrencyUnit currencyUnit)`
`void`	`setDateRecorded(Instant dateRecorded)`	The timestamp when this transaction response was recorded.
`void`	`setId(String id)`	The id of this transaction.
`void`	`setReason(String reason)`	The reason for this transaction.
`void`	`setReasonDescription(String reasonDescription)`	Description for the reason for this transaction.
`void`	`setRequestId(String requestId)`	The id used to represent the request that produced this transaction.
`void`	`setSource(String source)`	The name of the system that initiated the transaction - e.g.
`void`	`setSourceEntityId(String sourceEntityId)`	The ID of the source entity associated with the transaction.
`void`	`setSourceEntityType(String sourceEntityType)`	The type of the source entity associated with the transaction.
`void`	`setSourceUserId(String sourceUserId)`	The id of user who initiated the transaction.
`void`	`setSourceUserType(String sourceUserType)`	The type of user who initiated the transaction.
`void`	`setTransactionReferenceId(String transactionReferenceId)`	The transaction id known by the payment gateway.
`void`	`setType(String type)`	The type of this transaction.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreditAccountTransaction
```
public CreditAccountTransaction()
```
- Method Detail
  - getCurrency
```
@Nullable
public javax.money.CurrencyUnit getCurrency()
```
    The currency gathered from getAmount()
    
    Returns:
    
    The currency gathered from the amount
  - setCurrency
```
public void setCurrency(javax.money.CurrencyUnit currencyUnit)
```
  - getId
```
public String getId()
```
    The id of this transaction.
    
    Returns:
    
    The id of this transaction.
  - getCreditAccountRef
```
public CreditAccountRef getCreditAccountRef()
```
    The credit account reference to the credit account.
    
    Returns:
    
    The credit account reference to the credit account.
  - getTransactionReferenceId
```
public String getTransactionReferenceId()
```
    The transaction id known by the payment gateway. This reference can be used to link the request to the gateway's record of the transaction in the case that the calling application does not receive a response from the gateway.
    
    Returns:
    
    The transaction id known by the payment gateway
  - getRequestId
```
public String getRequestId()
```
    The id used to represent the request that produced this transaction.
    
    Returns:
    
    The id used to represent the request that produced this transaction
  - getType
```
public String getType()
```
    The type of this transaction. By default, it can be "CREDIT" or "DEBIT"
    
    Returns:
    
    The type of this transaction
  - getSource
```
public String getSource()
```
    The name of the system that initiated the transaction - e.g. CART_OPERATION_SERVICES vs ORDER_OPERATION_SERVICES.
    
    Returns:
    
    The name of the system that initiated the transaction
  - getSourceUserType
```
public String getSourceUserType()
```
    The type of user who initiated the transaction. By default, it can be "BLC_CUSTOMER", "BLC_ACCOUNT" or "BLC_CSR".
    
    Returns:
    
    The type of user who initiated the transaction
  - getSourceUserId
```
public String getSourceUserId()
```
    The id of user who initiated the transaction.
    
    Returns:
    
    The id of user who initiated the transaction
  - getSourceEntityType
```
public String getSourceEntityType()
```
    The type of the source entity associated with the transaction. For example, "CHECKOUT_REQUEST" or "ORDER_FULFILLMENT".
    
    Returns:
    
    The type of the source entity associated with the transaction
  - getSourceEntityId
```
public String getSourceEntityId()
```
    The ID of the source entity associated with the transaction.
    For example, if getSourceEntityType() is ORDER_FULFILLMENT, this would be the ID of the OrderFulfillment.
    
    Returns:
    
    The ID of the source entity associated with the transaction
    
    See Also:
    
    getSourceEntityType()
  - getReason
```
public String getReason()
```
    The reason for this transaction.
    
    Returns:
    
    The reason for this transaction
  - getReasonDescription
```
public String getReasonDescription()
```
    Description for the reason for this transaction.
    
    Returns:
    
    Description for the reason for this transaction
  - getDateRecorded
```
public Instant getDateRecorded()
```
    The timestamp when this transaction response was recorded.
    
    Returns:
    
    The timestamp when this transaction response was recorded
  - getAmount
```
public javax.money.MonetaryAmount getAmount()
```
    The amount related to this transaction.
    
    Returns:
    
    The amount related to this transaction
  - getContextState
```
public com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState getContextState()
```
    A subset of Tracking information to expose the context state for this object.
    
    Specified by:
    
    getContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware
    
    Returns:
    
    a subset of Tracking information to expose the context state for this object
  - setId
```
public void setId(String id)
```
    The id of this transaction.
    
    Parameters:
    
    transactionId - The id of this transaction.
  - setCreditAccountRef
```
public void setCreditAccountRef(CreditAccountRef creditAccountRef)
```
    The credit account reference to the credit account.
    
    Parameters:
    
    transactionId - The credit account reference to the credit account.
  - setTransactionReferenceId
```
public void setTransactionReferenceId(String transactionReferenceId)
```
    The transaction id known by the payment gateway. This reference can be used to link the request to the gateway's record of the transaction in the case that the calling application does not receive a response from the gateway.
    
    Parameters:
    
    transactionReferenceId - The transaction id known by the payment gateway
  - setRequestId
```
public void setRequestId(String requestId)
```
    The id used to represent the request that produced this transaction.
    
    Parameters:
    
    requestId - The id used to represent the request that produced this transaction
  - setType
```
public void setType(String type)
```
    The type of this transaction. By default, it can be "CREDIT" or "DEBIT"
    
    Parameters:
    
    type - The type of this transaction
  - setSource
```
public void setSource(String source)
```
    The name of the system that initiated the transaction - e.g. CART_OPERATION_SERVICES vs ORDER_OPERATION_SERVICES.
    
    Parameters:
    
    source - The name of the system that initiated the transaction
  - setSourceUserType
```
public void setSourceUserType(String sourceUserType)
```
    The type of user who initiated the transaction. By default, it can be "BLC_CUSTOMER", "BLC_ACCOUNT" or "BLC_CSR".
    
    Parameters:
    
    sourceUserType - The type of user who initiated the transaction
  - setSourceUserId
```
public void setSourceUserId(String sourceUserId)
```
    The id of user who initiated the transaction.
    
    Parameters:
    
    sourceUserId - The id of user who initiated the transaction
  - setSourceEntityType
```
public void setSourceEntityType(String sourceEntityType)
```
    The type of the source entity associated with the transaction. For example, "CHECKOUT_REQUEST" or "ORDER_FULFILLMENT".
    
    Parameters:
    
    sourceEntityType - The type of the source entity associated with the transaction
  - setSourceEntityId
```
public void setSourceEntityId(String sourceEntityId)
```
    The ID of the source entity associated with the transaction.
    For example, if getSourceEntityType() is ORDER_FULFILLMENT, this would be the ID of the OrderFulfillment.
    
    Parameters:
    
    sourceEntityId - The ID of the source entity associated with the transaction
    
    See Also:
    
    getSourceEntityType()
  - setReason
```
public void setReason(String reason)
```
    The reason for this transaction.
    
    Parameters:
    
    reason - The reason for this transaction
  - setReasonDescription
```
public void setReasonDescription(String reasonDescription)
```
    Description for the reason for this transaction.
    
    Parameters:
    
    reasonDescription - Description for the reason for this transaction
  - setDateRecorded
```
public void setDateRecorded(Instant dateRecorded)
```
    The timestamp when this transaction response was recorded.
    
    Parameters:
    
    dateRecorded - The timestamp when this transaction response was recorded
  - setAmount
```
public void setAmount(javax.money.MonetaryAmount amount)
```
    The amount related to this transaction.
    
    Parameters:
    
    amount - The amount related to this transaction
  - setContextState
```
public void setContextState(com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)
```
    A subset of Tracking information to expose the context state for this object.
    
    Specified by:
    
    setContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware
    
    Parameters:
    
    contextState - a subset of Tracking information to expose the context state for this object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - canEqual
```
protected boolean canEqual(Object other)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class CreditAccountTransaction

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CreditAccountTransaction

Method Detail

getCurrency

setCurrency

getId

getCreditAccountRef

getTransactionReferenceId

getRequestId

getType

getSource

getSourceUserType

getSourceUserId

getSourceEntityType

getSourceEntityId

getReason

getReasonDescription

getDateRecorded

getAmount

getContextState

setId

setCreditAccountRef

setTransactionReferenceId

setRequestId

setType

setSource

setSourceUserType

setSourceUserId

setSourceEntityType

setSourceEntityId

setReason

setReasonDescription

setDateRecorded

setAmount

setContextState

equals

canEqual

hashCode

toString