Class TransactionLookupRequest
- java.lang.Object
 - 
- com.broadleafcommerce.paymentgateway.domain.TransactionLookupRequest
 
 
- 
- All Implemented Interfaces:
 Serializable
public class TransactionLookupRequest extends Object implements Serializable
- See Also:
 - Serialized Form
 
 
- 
- 
Constructor Summary
Constructors Constructor Description TransactionLookupRequest() 
- 
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected booleancanEqual(Object other)booleanequals(Object o)javax.money.MonetaryAmountgetAmount()The amount related to this transaction.Map<String,String>getAttributes()Map of additional attributes that can be used to identify the transaction.InstantgetDateRecorded()The timestamp when this transaction response was recordedStringgetGatewayTransactionId()The gateway-specific id for the transaction.StringgetGatewayTransactionType()The type of this transaction, as described by the gateway.StringgetId()The id of the Broadleaf transaction.StringgetPaymentId()The id of the related Broadleaf payment.StringgetRequestId()The id used to represent the request that produced this transaction.StringgetSourceEntityId()The ID of the source entity associated with the transaction.StringgetSourceEntityType()The type of the source entity associated with the transaction.StringgetTransactionReferenceId()The transaction id known by the payment gateway.StringgetType()The type of this transaction (authorize, capture, refund, etc.)inthashCode()voidsetAmount(javax.money.MonetaryAmount amount)The amount related to this transaction.voidsetAttributes(Map<String,String> attributes)Map of additional attributes that can be used to identify the transaction.voidsetDateRecorded(Instant dateRecorded)The timestamp when this transaction response was recordedvoidsetGatewayTransactionId(String gatewayTransactionId)The gateway-specific id for the transaction.voidsetGatewayTransactionType(String gatewayTransactionType)The type of this transaction, as described by the gateway.voidsetId(String id)The id of the Broadleaf transaction.voidsetPaymentId(String paymentId)The id of the related Broadleaf payment.voidsetRequestId(String requestId)The id used to represent the request that produced this transaction.voidsetSourceEntityId(String sourceEntityId)The ID of the source entity associated with the transaction.voidsetSourceEntityType(String sourceEntityType)The type of the source entity associated with the transaction.voidsetTransactionReferenceId(String transactionReferenceId)The transaction id known by the payment gateway.voidsetType(String type)The type of this transaction (authorize, capture, refund, etc.)StringtoString() 
 - 
 
- 
- 
Method Detail
- 
getId
public String getId()
The id of the Broadleaf transaction.- Returns:
 - The id of the Broadleaf transaction.
 
 
- 
getPaymentId
public String getPaymentId()
The id of the related Broadleaf payment.- Returns:
 - The id of the related Broadleaf payment.
 
 
- 
getType
public String getType()
The type of this transaction (authorize, capture, refund, etc.)- Returns:
 - The type of this transaction (authorize, capture, refund, etc.)
 
 
- 
getGatewayTransactionType
public String getGatewayTransactionType()
The type of this transaction, as described by the gateway.- Returns:
 - The type of this transaction, as described by the gateway.
 
 
- 
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
 
 
- 
getGatewayTransactionId
public String getGatewayTransactionId()
The gateway-specific id for the transaction.- Returns:
 - The gateway-specific id for 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()isORDER_FULFILLMENT, this would be the ID of theOrderFulfillment.- Returns:
 - The ID of the source entity associated with the transaction
 - See Also:
 getSourceEntityType()
 
- 
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
 
 
- 
getAmount
public javax.money.MonetaryAmount getAmount()
The amount related to this transaction. Depending on thetype, this may be the amount authorized, captured, refunded, etc.- Returns:
 - The amount related to this transaction
 
 
- 
getDateRecorded
public Instant getDateRecorded()
The timestamp when this transaction response was recorded- Returns:
 - The timestamp when this transaction response was recorded
 
 
- 
getAttributes
public Map<String,String> getAttributes()
Map of additional attributes that can be used to identify the transaction.- Returns:
 - Map of additional attributes that can be used to identify the transaction.
 
 
- 
setId
public void setId(String id)
The id of the Broadleaf transaction.- Parameters:
 id- The id of the Broadleaf transaction.
 
- 
setPaymentId
public void setPaymentId(String paymentId)
The id of the related Broadleaf payment.- Parameters:
 paymentId- The id of the related Broadleaf payment.
 
- 
setType
public void setType(String type)
The type of this transaction (authorize, capture, refund, etc.)- Parameters:
 type- The type of this transaction
 
- 
setGatewayTransactionType
public void setGatewayTransactionType(String gatewayTransactionType)
The type of this transaction, as described by the gateway.- Parameters:
 gatewayTransactionType- The type of this transaction, as described by the gateway.
 
- 
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
 
- 
setGatewayTransactionId
public void setGatewayTransactionId(String gatewayTransactionId)
The gateway-specific id for the transaction.- Parameters:
 gatewayTransactionId- The gateway-specific id for 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()isORDER_FULFILLMENT, this would be the ID of theOrderFulfillment.- Parameters:
 sourceEntityId- The ID of the source entity associated with the transaction- See Also:
 getSourceEntityType()
 
- 
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
 
- 
setAmount
public void setAmount(javax.money.MonetaryAmount amount)
The amount related to this transaction. Depending on thetype, this may be the amount authorized, captured, refunded, etc.- Parameters:
 amount- The amount related to 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
 
- 
setAttributes
public void setAttributes(Map<String,String> attributes)
Map of additional attributes that can be used to identify the transaction.- Parameters:
 attributes- Map of additional attributes that can be used to identify the transaction.
 
- 
canEqual
protected boolean canEqual(Object other)
 
 - 
 
 -