PaymentActionData

java.lang.Object
- com.ibm.commerce.payment.actions.ActionData
- - com.ibm.commerce.payment.actions.PaymentActionData

All Implemented Interfaces:

java.io.Serializable
```
public class PaymentActionData
extends ActionData
```
This class is the place holder for data used by payment actions.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

PaymentActionData()

Constructors
Constructor and Description
`PaymentActionData()`

Method Summary

All Methods Instance Methods Concrete Methods
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.

Methods inherited from class com.ibm.commerce.payment.actions.ActionData
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

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PaymentActionData
```
public PaymentActionData()
```
- Method Detail
  - setAtomicPaymentId
```
public final void setAtomicPaymentId(java.lang.Long localAtomicPaymentId)
```
    This method sets the atomic payment ID of current payment action corresponds to.
    
    Parameters:
    
    localAtomicPaymentId - The atomic payment ID to set
  - getAtomicPaymentId
```
public final java.lang.Long getAtomicPaymentId()
```
    This method returns the atomic payment ID of current payment action corresponds to.
    
    Returns:
    
    Long The atomic payment ID to set
  - setAtomicPaymentToBeCanceled
```
public final void setAtomicPaymentToBeCanceled(boolean value)
```
    This method sets if the associated atomic payment has (or have been) to be canceled.
    
    Parameters:
    
    value - If the associated atomic payment has (or have been) to be canceled
  - isAtomicPaymentToBeCanceled
```
public final boolean isAtomicPaymentToBeCanceled()
```
    This method returns if the associated atomic payment has (or have been) to be canceled.
    
    Returns:
    
    value If the associated AP has (or have been) to be canceled
  - setBackendPaymentId
```
public final void setBackendPaymentId(java.lang.String localBackendPaymentId)
```
    This method sets the backend payment ID in WebSphere Commerce Payments.
    
    Parameters:
    
    localBackendPaymentId - The backend payment ID to set in WebSphere Commerce Payments.
  - getBackendPaymentId
```
public final java.lang.String getBackendPaymentId()
```
    This method returns the backend payment ID in WebSphere Commerce Payments.
    
    Returns:
    
    backendPaymentId The backend payment ID to set in WebSphere Commerce Payments
  - setBackendPiId
```
public final void setBackendPiId(java.lang.String localBackendPiId)
```
    This method sets the backend payment instruction ID in WebSphere Commerce Payments.
    
    Parameters:
    
    localBackendPiId - The backend payment instruction id in WebSphere Commerce Payments
  - getBackendPiId
```
public final java.lang.String getBackendPiId()
```
    This method returns the backend payment instruction ID in WebSphere Commerce Payments.
    
    Returns:
    
    backendPiId The backend payment instruction id in WebSphere Commerce Payments
  - setNewAtomicPaymentRequired
```
public final 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.
    
    Parameters:
    
    localNewAtomicPaymentRequired - If the new atomic payment is required to create
  - isNewAtomicPaymentRequired
```
public final boolean isNewAtomicPaymentRequired()
```
    This method returns if the new atomic payment is required to create, which is decided by the configuration in Payment Rules.
    
    Returns:
    
    boolean localNewAtomicPaymentRequired If the new atomic payment is required to create
  - setOrderId
```
public final void setOrderId(java.lang.Long localOrderId)
```
    This method sets the order identifier in order system.
    
    Parameters:
    
    localOrderId - The order ID to set
  - getOrderId
```
public final java.lang.Long getOrderId()
```
    This method returns the order identifier in order system.
    
    Returns:
    
    orderId The order ID in order system
  - setProtocolData
```
public final void setProtocolData(java.util.HashMap localProtocolData)
```
    This method sets the protocol data for current payment action.
    
    Parameters:
    
    localProtocolData - The protocol data to set
  - getProtocolData
```
public final java.util.HashMap getProtocolData()
```
    This method returns the protocol data for current payment action.
    
    Returns:
    
    protocolData The protocol data for current payment action
  - setReleaseIds
```
public final void setReleaseIds(java.lang.Long[] localReleaseIds)
```
    This method sets all release identifiers involved in current payment action.
    
    Parameters:
    
    localReleaseIds - All release identifiers involved in current payment action
  - getReleaseIds
```
public final java.lang.Long[] getReleaseIds()
```
    This method returns all release identifiers involved in current payment action.
    
    Returns:
    
    releaseIds All release identifiers involved in current payment action
  - setRmaId
```
public final void setRmaId(java.lang.Long localRmaId)
```
    This method sets the RMA ID involved in current payment action.
    
    Parameters:
    
    localRmaId - The RMA ID to set
  - getRmaId
```
public final java.lang.Long getRmaId()
```
    This method returns the RMA ID involved in current payment action.
    
    Returns:
    
    rmaId The RMA ID involved in current payment action
  - setUpdateRequired
```
public final void setUpdateRequired(boolean localUpdateRequired)
```
    This method sets the flag of if local update is required.
    
    Parameters:
    
    localUpdateRequired - If local update is required
  - isUpdateRequired
```
public final boolean isUpdateRequired()
```
    This method returns if local update is required.
    
    Returns:
    
    A boolean indicating if local update is required
  - toString
```
public java.lang.String toString()
```
    This method returns a human-readable representation of this object.
    
    Overrides:
    
    toString in class ActionData
    
    Returns:
    
    A human-readable representation of this object
  - getAtomicPaymentToDistributeId
```
public java.lang.Long getAtomicPaymentToDistributeId()
```
    This method returns the identifier of atomic payment to distribute.
    
    Returns:
    
    atomicPaymentToDistributeId The identifier of atomic payment to distribute
  - setAtomicPaymentToDistributeId
```
public void setAtomicPaymentToDistributeId(java.lang.Long long1)
```
    This method sets the identifier of atomic payment to distribute.
    
    Parameters:
    
    long1 - The identifier of atomic payment to distribute
  - getErrorKey
```
public java.lang.String getErrorKey()
```
    This method returns the error key of this payment action.
    
    Returns:
    
    errorKey The error key of this payment action
  - setErrorKey
```
public void setErrorKey(java.lang.String string)
```
    This method sets the error key of this payment action.
    
    Parameters:
    
    string - The error key of this payment action
  - getSensitiveInformation
```
public java.util.Map getSensitiveInformation()
```
    This method gets the sensitive information of this payment action.
    
    Returns:
    
    the sensitive information of this payment action
  - setSensitiveInformation
```
public void setSensitiveInformation(java.util.Map localSensitiveInformation)
```
    This method sets the sensitive information of this payment action.
    
    Parameters:
    
    localSensitiveInformation - the sensitive information of this payment action
  - getOrderItems
```
public java.lang.String[] getOrderItems()
```
    This method returns the order items associated with this payment action.
    
    Returns:
    
    the order items associated with this payment action
  - setOrderItems
```
public void setOrderItems(java.lang.String[] localOrderItems)
```
    This method sets the order items associated with this payment action.
    
    Parameters:
    
    localOrderItems - the order items associated with this payment action.

Methods inherited from class com.ibm.commerce.payment.actions.ActionData

Methods inherited from class java.lang.Object

PaymentActionData

setAtomicPaymentId

getAtomicPaymentId

setAtomicPaymentToBeCanceled

isAtomicPaymentToBeCanceled

setBackendPaymentId

getBackendPaymentId

setBackendPiId

getBackendPiId

setNewAtomicPaymentRequired

isNewAtomicPaymentRequired

setOrderId

getOrderId

setProtocolData

getProtocolData

setReleaseIds

getReleaseIds

setRmaId

getRmaId

setUpdateRequired

isUpdateRequired

toString

getAtomicPaymentToDistributeId

setAtomicPaymentToDistributeId

getErrorKey

setErrorKey

getSensitiveInformation

setSensitiveInformation

getOrderItems

setOrderItems