ActionData

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

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

PaymentActionData, RefundActionData
```
public class ActionData
extends java.lang.Object
implements java.io.Serializable
```
This class defines common data to all payment/refund actions.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

ActionData()
This method is the constructor for this class.

Constructors
Constructor and Description
`ActionData()` This method is the constructor for this class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getActionName()` This method returns the current action name.
`java.math.BigDecimal`	`getAmount()` This method returns the amount of this action.
`java.lang.String`	`getCurrency()` This method returns the currency of this action.
`java.lang.Long`	`getEDPPaymentInstructionId()` This method returns the payment instruction ID in Payment Rules.
`int`	`getIndex()` This method gets the index of this action in the action list.
`java.lang.String`	`getOperationResult()` This method returns the operation result of the action being executed, which could be Success, Failure or Pending.
`java.lang.String`	`getPaymentSystem()` This method returns the payment system name.
`java.lang.Integer`	`getPhase()` This method gets the phase when the action is performed.
`java.lang.Long`	`getPolicyId()` This method returns the current policy id the action would use.
`java.lang.String`	`getReadableStatus()` This method returns the human-readable result of the action being executed, which would be Success, Failure or Pending.
`java.lang.Integer`	`getStoreId()` This method returns the current store ID.
`boolean`	`isHasExecuted()` This method returns if the current action has been executed.
`boolean`	`isMaskSensitiveData()` This method returns if the sensitive data should be masked.
`void`	`setActionName(java.lang.String string)` This method sets the current action name.
`void`	`setAmount(java.math.BigDecimal localAmount)` This method sets the amount of this action.
`void`	`setCurrency(java.lang.String localCurrency)` This method sets the currency of this action.
`void`	`setEDPPaymentInstructionId(java.lang.Long localPaymentInstructionId)` This method sets the payment instruction ID in Payment Rules.
`void`	`setHasExecuted(boolean b)` This method sets if the current action has been executed.
`void`	`setIndex(int index)` This method sets the index of this action in the action list.
`void`	`setMaskSensitiveData(boolean b)` This method sets if the sensitive data should be masked.
`void`	`setOperationResult(java.lang.String string)` This method sets the operation result of the action being executed, which could be Success, Failure or Pending.
`void`	`setPaymentSystem(java.lang.String paymentSystemName)` This method sets the payment system name.
`void`	`setPhase(java.lang.Integer localPhase)` This method sets the phase when the action is performed.
`void`	`setPolicyId(java.lang.Long long1)` This method sets the policy id the action would use
`void`	`setReadableStatus(java.lang.String string)` This method sets the human-readable result of the action being executed, which would be Success, Failure or Pending.
`void`	`setStoreId(java.lang.Integer localStoreId)` This method sets the current store ID.
`java.lang.String`	`toString()` This method gets a human-readable representation of this object.

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

- Constructor Detail
  - ActionData
```
public ActionData()
```
    This method is the constructor for this class.
- Method Detail
  - setAmount
```
public void setAmount(java.math.BigDecimal localAmount)
```
    This method sets the amount of this action.
    
    Parameters:
    
    localAmount - The amount to set
  - getAmount
```
public java.math.BigDecimal getAmount()
```
    This method returns the amount of this action.
    
    Returns:
    
    BigDecimal The returned amount of this action
  - setCurrency
```
public void setCurrency(java.lang.String localCurrency)
```
    This method sets the currency of this action.
    
    Parameters:
    
    localCurrency - The currency to set
  - getCurrency
```
public java.lang.String getCurrency()
```
    This method returns the currency of this action.
    
    Returns:
    
    String The returned currency of this action
  - setPaymentSystem
```
public void setPaymentSystem(java.lang.String paymentSystemName)
```
    This method sets the payment system name.
    
    Parameters:
    
    paymentSystemName - The payment system name to set
  - getPaymentSystem
```
public java.lang.String getPaymentSystem()
```
    This method returns the payment system name.
    
    Returns:
    
    String The returned payment system name
  - setStoreId
```
public void setStoreId(java.lang.Integer localStoreId)
```
    This method sets the current store ID.
    
    Parameters:
    
    localStoreId - The storeId to set
  - getStoreId
```
public java.lang.Integer getStoreId()
```
    This method returns the current store ID.
    
    Returns:
    
    Integer The returned store ID
  - setEDPPaymentInstructionId
```
public final void setEDPPaymentInstructionId(java.lang.Long localPaymentInstructionId)
```
    This method sets the payment instruction ID in Payment Rules.
    
    Parameters:
    
    localPaymentInstructionId - The payment instruction ID in Payment Rules to set
  - getEDPPaymentInstructionId
```
public final java.lang.Long getEDPPaymentInstructionId()
```
    This method returns the payment instruction ID in Payment Rules.
    
    Returns:
    
    EDPPaymentInstructionId The payment instruction ID in Payment Rules to set
  - getActionName
```
public java.lang.String getActionName()
```
    This method returns the current action name.
    
    Returns:
    
    actionName The current action name
  - setActionName
```
public void setActionName(java.lang.String string)
```
    This method sets the current action name.
    
    Parameters:
    
    string - The current action name
  - isHasExecuted
```
public boolean isHasExecuted()
```
    This method returns if the current action has been executed.
    
    Returns:
    
    hasExecuted If the current action has been executed
  - setHasExecuted
```
public void setHasExecuted(boolean b)
```
    This method sets if the current action has been executed.
    
    Parameters:
    
    b - If the current action has been executed
  - toString
```
public java.lang.String toString()
```
    This method gets a human-readable representation of this object.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A human-readable representation of this object
  - isMaskSensitiveData
```
public boolean isMaskSensitiveData()
```
    This method returns if the sensitive data should be masked.
    
    Returns:
    
    maskSensitiveData If the sensitive data should be masked
  - setMaskSensitiveData
```
public void setMaskSensitiveData(boolean b)
```
    This method sets if the sensitive data should be masked.
    
    Parameters:
    
    b - If the sensitive data should be masked
  - getPolicyId
```
public java.lang.Long getPolicyId()
```
    This method returns the current policy id the action would use.
    
    Returns:
    
    The current policy id the action would use
  - setPolicyId
```
public void setPolicyId(java.lang.Long long1)
```
    This method sets the policy id the action would use
    
    Parameters:
    
    long1 - The policy id to set
  - getOperationResult
```
public java.lang.String getOperationResult()
```
    This method returns the operation result of the action being executed, which could be Success, Failure or Pending.
    
    Returns:
    
    operationResult The operation result of the action being executed
  - getReadableStatus
```
public java.lang.String getReadableStatus()
```
    This method returns the human-readable result of the action being executed, which would be Success, Failure or Pending.
    
    Returns:
    
    readableStatus The human-readable result of the action being executed
  - setOperationResult
```
public void setOperationResult(java.lang.String string)
```
    This method sets the operation result of the action being executed, which could be Success, Failure or Pending.
    
    Parameters:
    
    string - The operation result of the action being executed
  - setReadableStatus
```
public void setReadableStatus(java.lang.String string)
```
    This method sets the human-readable result of the action being executed, which would be Success, Failure or Pending.
    
    Parameters:
    
    string - The human-readable result of the action being executed
  - getIndex
```
public int getIndex()
```
    This method gets the index of this action in the action list. This index is set when composing the payment event data for the action list. And this method is called when decomposing the action list from the payment event data.
    
    Returns:
    
    Returns the index.
  - setIndex
```
public void setIndex(int index)
```
    This method sets the index of this action in the action list. This index is set when composing the payment event data for the action list. And this index is used to make sure the action list has the same action sequence as the action list before composing the payment event data.
    
    Parameters:
    
    index - The index to set.
  - getPhase
```
public java.lang.Integer getPhase()
```
    This method gets the phase when the action is performed.
    
    Returns:
    
    Returns the phase.
  - setPhase
```
public void setPhase(java.lang.Integer localPhase)
```
    This method sets the phase when the action is performed.
    
    Parameters:
    
    localPhase - The phase to set.

Methods inherited from class java.lang.Object

ActionData

setAmount

getAmount

setCurrency

getCurrency

setPaymentSystem

getPaymentSystem

setStoreId

getStoreId

setEDPPaymentInstructionId

getEDPPaymentInstructionId

getActionName

setActionName

isHasExecuted

setHasExecuted

toString

isMaskSensitiveData

setMaskSensitiveData

getPolicyId

setPolicyId

getOperationResult

getReadableStatus

setOperationResult

setReadableStatus

getIndex

setIndex

getPhase

setPhase