public class PaymentActionData extends ActionData
This class is the place holder for data used by payment actions.
Constructor and Description |
---|
PaymentActionData() |
Modifier and Type | Method and Description |
---|---|
java.lang.Long |
getAtomicPaymentId()
This method returns the atomic payment ID of current payment action
corresponds to.
|
java.lang.Long |
getAtomicPaymentToDistributeId()
This method returns the identifier of atomic payment to distribute.
|
java.lang.String |
getBackendPaymentId()
This method returns the backend payment ID in WebSphere Commerce Payments.
|
java.lang.String |
getBackendPiId()
This method returns the backend payment instruction ID in WebSphere Commerce Payments.
|
java.lang.String |
getErrorKey()
This method returns the error key of this payment action.
|
java.lang.Long |
getOrderId()
This method returns the order identifier in order system.
|
java.lang.String[] |
getOrderItems()
This method returns the order items associated with this payment action.
|
java.util.HashMap |
getProtocolData()
This method returns the protocol data for current payment action.
|
java.lang.Long[] |
getReleaseIds()
This method returns all release identifiers involved in current payment
action.
|
java.lang.Long |
getRmaId()
This method returns the RMA ID involved in current payment action.
|
java.util.Map |
getSensitiveInformation()
This method gets the sensitive information of this payment action.
|
boolean |
isAtomicPaymentToBeCanceled()
This method returns if the associated atomic payment has (or have been) to be canceled.
|
boolean |
isNewAtomicPaymentRequired()
This method returns if the new atomic payment is required to create, which
is decided by the configuration in Payment Rules.
|
boolean |
isUpdateRequired()
This method returns if local update is required.
|
void |
setAtomicPaymentId(java.lang.Long localAtomicPaymentId)
This method sets the atomic payment ID of current payment action
corresponds to.
|
void |
setAtomicPaymentToBeCanceled(boolean value)
This method sets if the associated atomic payment has (or have been) to be canceled.
|
void |
setAtomicPaymentToDistributeId(java.lang.Long long1)
This method sets the identifier of atomic payment to distribute.
|
void |
setBackendPaymentId(java.lang.String localBackendPaymentId)
This method sets the backend payment ID in WebSphere Commerce Payments.
|
void |
setBackendPiId(java.lang.String localBackendPiId)
This method sets the backend payment instruction ID in WebSphere Commerce Payments.
|
void |
setErrorKey(java.lang.String string)
This method sets the error key of this payment action.
|
void |
setNewAtomicPaymentRequired(boolean localNewAtomicPaymentRequired)
This method sets if the new atomic payment is required to create, which
is decided by the configuration in Payment Rules.
|
void |
setOrderId(java.lang.Long localOrderId)
This method sets the order identifier in order system.
|
void |
setOrderItems(java.lang.String[] localOrderItems)
This method sets the order items associated with this payment action.
|
void |
setProtocolData(java.util.HashMap localProtocolData)
This method sets the protocol data for current payment action.
|
void |
setReleaseIds(java.lang.Long[] localReleaseIds)
This method sets all release identifiers involved in current payment
action.
|
void |
setRmaId(java.lang.Long localRmaId)
This method sets the RMA ID involved in current payment action.
|
void |
setSensitiveInformation(java.util.Map localSensitiveInformation)
This method sets the sensitive information of this payment action.
|
void |
setUpdateRequired(boolean localUpdateRequired)
This method sets the flag of if local update is required.
|
java.lang.String |
toString()
This method returns a human-readable representation of this object.
|
getActionName, getAmount, getCurrency, getEDPPaymentInstructionId, getIndex, getOperationResult, getPaymentSystem, getPhase, getPolicyId, getReadableStatus, getStoreId, isHasExecuted, isMaskSensitiveData, setActionName, setAmount, setCurrency, setEDPPaymentInstructionId, setHasExecuted, setIndex, setMaskSensitiveData, setOperationResult, setPaymentSystem, setPhase, setPolicyId, setReadableStatus, setStoreId
public final void setAtomicPaymentId(java.lang.Long localAtomicPaymentId)
localAtomicPaymentId
- The atomic payment ID to setpublic final java.lang.Long getAtomicPaymentId()
public final void setAtomicPaymentToBeCanceled(boolean value)
value
- If the associated atomic payment has (or have been) to be canceledpublic final boolean isAtomicPaymentToBeCanceled()
public final void setBackendPaymentId(java.lang.String localBackendPaymentId)
localBackendPaymentId
- The backend payment ID to set in WebSphere Commerce Payments.public final java.lang.String getBackendPaymentId()
public final void setBackendPiId(java.lang.String localBackendPiId)
localBackendPiId
- The backend payment instruction id in WebSphere Commerce Paymentspublic final java.lang.String getBackendPiId()
public final void setNewAtomicPaymentRequired(boolean localNewAtomicPaymentRequired)
localNewAtomicPaymentRequired
- If the new atomic payment is required to createpublic final boolean isNewAtomicPaymentRequired()
public final void setOrderId(java.lang.Long localOrderId)
localOrderId
- The order ID to setpublic final java.lang.Long getOrderId()
public final void setProtocolData(java.util.HashMap localProtocolData)
localProtocolData
- The protocol data to setpublic final java.util.HashMap getProtocolData()
public final void setReleaseIds(java.lang.Long[] localReleaseIds)
localReleaseIds
- All release identifiers involved in current payment actionpublic final java.lang.Long[] getReleaseIds()
public final void setRmaId(java.lang.Long localRmaId)
localRmaId
- The RMA ID to setpublic final java.lang.Long getRmaId()
public final void setUpdateRequired(boolean localUpdateRequired)
localUpdateRequired
- If local update is requiredpublic final boolean isUpdateRequired()
public java.lang.String toString()
toString
in class ActionData
public java.lang.Long getAtomicPaymentToDistributeId()
public void setAtomicPaymentToDistributeId(java.lang.Long long1)
long1
- The identifier of atomic payment to distributepublic java.lang.String getErrorKey()
public void setErrorKey(java.lang.String string)
string
- The error key of this payment actionpublic java.util.Map getSensitiveInformation()
public void setSensitiveInformation(java.util.Map localSensitiveInformation)
localSensitiveInformation
- the sensitive information of this payment actionpublic java.lang.String[] getOrderItems()
public void setOrderItems(java.lang.String[] localOrderItems)
localOrderItems
- the order items associated with this payment action.