EDPPaymentInstruction

java.lang.Object
- com.ibm.commerce.edp.api.EDPPaymentInstruction

All Implemented Interfaces:

java.io.Serializable
```
public class EDPPaymentInstruction
extends java.lang.Object
implements java.io.Serializable
```
This class holds information pertaining to one set of payment instructions for one payment instrument from one customer for one order.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

EDPPaymentInstruction()

Constructors
Constructor and Description
`EDPPaymentInstruction()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.math.BigDecimal`	`getAmount()` This method returns the amount to process of this payment instruction.
`java.lang.String`	`getBackendPIId()` This method returns the back end payment instruction id of this payment instruction.
`java.math.BigDecimal`	`getDepositedAmount()` This method returns the deposited amount of this payment instruction.
`java.math.BigDecimal`	`getDepositingAmount()` This method returns the depositing amount of this payment instruction.
`java.lang.Long`	`getId()` This method returns the id of this payment instruction.
`java.lang.String`	`getOverallPaymentInstructionStatus()` This method returns the overall payment instruction status.
`java.lang.String`	`getPaymentMethod()` This method returns the payment method used in this payment instruction.
`java.lang.Long`	`getPolicyId()` This method returns the policy ID of this payment instruction.
`java.util.HashMap`	`getProtocolData()` This method returns the protocol data of this payment instruction.
`boolean`	`isAmountDirty()` This method returns if the current amount of this payment instruction is dirty.
`boolean`	`isAmountEditable()` This method returns the amount editable flag indicating if the amount is editable or not.
`boolean`	`isCancelFlag()` This method returns the flag indicating if this payment instruction has been cancelled.
`boolean`	`isNewPIFlag()` This method returns the flag indicating if this payment instruction is newly added.
`boolean`	`isPaymentDataDirty()` This method returns the flag indicating if the payment data is dirty.
`boolean`	`isPaymentDataEditable()` This method returns the payment data editable flag indicating if the payment data is editable or not.
`boolean`	`isValid()` This method checks if the payment instruction is valid..
`void`	`setAmount(java.math.BigDecimal localAmount)` This method sets the amount to process of this payment instruction.
`void`	`setAmountDirty(boolean b)` This method sets if the current amount of this payment instruction is dirty.
`void`	`setAmountEditable(boolean b)` This method sets the amount editable flag indicating if the amount is editable or not.
`void`	`setBackendPIId(java.lang.String localBackendPIId)` This method sets the back end payment instruction id of this payment instruction.
`void`	`setCancelFlag(boolean b)` This method sets the flag indicating if this payment instruction has been cancelled.
`void`	`setDepositedAmount(java.math.BigDecimal decimal)` This method sets the deposited amount of this payment instruction.
`void`	`setDepositingAmount(java.math.BigDecimal decimal)` This method sets the depositing amount of this payment instruction.
`void`	`setId(java.lang.Long localId)` This method sets the id.
`void`	`setIdToCancel(java.lang.Long localId)` This is the only way to set `cancelFlag`, along with an Id.
`void`	`setNewPIFlag(boolean b)` This method sets the flag indicating if this payment instruction is newly added.
`void`	`setOverallPaymentInstructionStatus(java.lang.String overallStatus)` This method sets the overall payment instruction status.
`void`	`setPaymentDataDirty(boolean b)` This method sets the flag indicating if the payment data is dirty.
`void`	`setPaymentDataEditable(boolean b)` This method sets the payment data editable flag indicating if the payment data is editable or not.
`void`	`setPaymentMethod(java.lang.String paymentMethodID)` This method sets the payment method used in this payment instruction.
`void`	`setPolicyId(java.lang.Long long1)` This method sets the policy ID of this payment instruction.
`void`	`setProtocolData(java.util.HashMap paymentData)` This method sets the protocol data of this payment instruction.
`void`	`setValid(boolean value)` This method sets if the payment instruction is valid or not.
`java.lang.String`	`toString()` This method converts this payment instruction into a human-readable string

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

- Constructor Detail
  - EDPPaymentInstruction
```
public EDPPaymentInstruction()
```
- Method Detail
  - setBackendPIId
```
public void setBackendPIId(java.lang.String localBackendPIId)
```
    This method sets the back end payment instruction id of this payment instruction.
    
    Parameters:
    
    localBackendPIId - The back end payment instruction id to set
  - getBackendPIId
```
public java.lang.String getBackendPIId()
```
    This method returns the back end payment instruction id of this payment instruction.
    
    Returns:
    
    The back end payment instruction id of this payment instruction
  - setAmount
```
public void setAmount(java.math.BigDecimal localAmount)
```
    This method sets the amount to process of this payment instruction.
    
    Parameters:
    
    localAmount - The amount to set
  - getAmount
```
public java.math.BigDecimal getAmount()
```
    This method returns the amount to process of this payment instruction.
    
    Returns:
    
    The amount to process of this payment instruction
  - setAmountDirty
```
public void setAmountDirty(boolean b)
```
    This method sets if the current amount of this payment instruction is dirty.
    
    Parameters:
    
    b - The flag indicating if the current amount of this payment instruction is dirty
  - isAmountDirty
```
public boolean isAmountDirty()
```
    This method returns if the current amount of this payment instruction is dirty.
    
    Returns:
    
    boolean The flag indicating if the current amount of this payment instruction is dirty
  - setAmountEditable
```
public void setAmountEditable(boolean b)
```
    This method sets the amount editable flag indicating if the amount is editable or not. True by default.
    
    Parameters:
    
    b - Indicates if the amount is editable or not
  - isAmountEditable
```
public boolean isAmountEditable()
```
    This method returns the amount editable flag indicating if the amount is editable or not.
    
    Returns:
    
    The flag indicating if the amount is editable
  - setCancelFlag
```
public void setCancelFlag(boolean b)
```
    This method sets the flag indicating if this payment instruction has been cancelled.
    
    Parameters:
    
    b - The flag indicating if this payment instruction has been cancelled
  - isCancelFlag
```
public boolean isCancelFlag()
```
    This method returns the flag indicating if this payment instruction has been cancelled.
    
    Returns:
    
    boolean The flag indicating if this payment instruction has been cancelled
  - setId
```
public void setId(java.lang.Long localId)
```
    This method sets the id. Anytime the ID field is set, it means the action is on an existing PI.
    
    Parameters:
    
    localId - The id to set
  - getId
```
public java.lang.Long getId()
```
    This method returns the id of this payment instruction.
    
    Returns:
    
    Long The id of this payment instruction
  - setIdToCancel
```
public void setIdToCancel(java.lang.Long localId)
```
    This is the only way to set cancelFlag, along with an Id. This way, we avoid having conflicting newPIFlag and cancelFlag.
    
    Parameters:
    
    localId - The id of this payment instruction
  - setNewPIFlag
```
public void setNewPIFlag(boolean b)
```
    This method sets the flag indicating if this payment instruction is newly added.
    
    Parameters:
    
    b - The flag indicating if this payment instruction is newly added
  - isNewPIFlag
```
public boolean isNewPIFlag()
```
    This method returns the flag indicating if this payment instruction is newly added.
    
    Returns:
    
    boolean The flag indicating if this payment instruction is newly added
  - setOverallPaymentInstructionStatus
```
public void setOverallPaymentInstructionStatus(java.lang.String overallStatus)
```
    This method sets the overall payment instruction status.
    
    Parameters:
    
    overallStatus - The overall payment instruction status
  - getOverallPaymentInstructionStatus
```
public java.lang.String getOverallPaymentInstructionStatus()
```
    This method returns the overall payment instruction status.
    
    Returns:
    
    overallPaymentInstructionStatus The overall payment instruction status
  - setPaymentDataDirty
```
public void setPaymentDataDirty(boolean b)
```
    This method sets the flag indicating if the payment data is dirty.
    
    Parameters:
    
    b - The flag indicating if the payment data is dirty
  - isPaymentDataDirty
```
public boolean isPaymentDataDirty()
```
    This method returns the flag indicating if the payment data is dirty.
    
    Returns:
    
    The flag indicating if the payment data is dirty
  - setPaymentDataEditable
```
public void setPaymentDataEditable(boolean b)
```
    This method sets the payment data editable flag indicating if the payment data is editable or not. True by default.
    
    Parameters:
    
    b - Indicates if the payment data is editable or not
  - isPaymentDataEditable
```
public boolean isPaymentDataEditable()
```
    This method returns the payment data editable flag indicating if the payment data is editable or not.
    
    Returns:
    
    The payment data editable flag
  - setPaymentMethod
```
public void setPaymentMethod(java.lang.String paymentMethodID)
```
    This method sets the payment method used in this payment instruction.
    
    Parameters:
    
    paymentMethodID - The payment method ID to set
  - getPaymentMethod
```
public java.lang.String getPaymentMethod()
```
    This method returns the payment method used in this payment instruction.
    
    Returns:
    
    paymentMethodID The payment method used in this payment instruction
  - setProtocolData
```
public void setProtocolData(java.util.HashMap paymentData)
```
    This method sets the protocol data of this payment instruction.
    
    Parameters:
    
    paymentData - The protocol data to set
  - getProtocolData
```
public java.util.HashMap getProtocolData()
```
    This method returns the protocol data of this payment instruction.
    
    Returns:
    
    The protocol data of this payment instruction
  - setValid
```
public void setValid(boolean value)
```
    This method sets if the payment instruction is valid or not.
    
    Parameters:
    
    value - If the payment instruction is valid or not
  - isValid
```
public boolean isValid()
```
    This method checks if the payment instruction is valid..
    
    Returns:
    
    If the payment instruction is valid or not
  - getDepositedAmount
```
public java.math.BigDecimal getDepositedAmount()
```
    This method returns the deposited amount of this payment instruction.
    
    Returns:
    
    depositedAmount The deposited amount of this payment instruction
  - getDepositingAmount
```
public java.math.BigDecimal getDepositingAmount()
```
    This method returns the depositing amount of this payment instruction.
    
    Returns:
    
    depositedAmount The depositing amount of this payment instruction
  - setDepositedAmount
```
public void setDepositedAmount(java.math.BigDecimal decimal)
```
    This method sets the deposited amount of this payment instruction.
    
    Parameters:
    
    depositedAmount - The deposited amount to set
  - setDepositingAmount
```
public void setDepositingAmount(java.math.BigDecimal decimal)
```
    This method sets the depositing amount of this payment instruction.
    
    Parameters:
    
    depositingAmount - The depositing amount to set
  - toString
```
public java.lang.String toString()
```
    This method converts this payment instruction into a human-readable string
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    The human-readable representation of this object
  - getPolicyId
```
public java.lang.Long getPolicyId()
```
    This method returns the policy ID of this payment instruction.
    
    Returns:
    
    The policy ID of this payment instruction
  - setPolicyId
```
public void setPolicyId(java.lang.Long long1)
```
    This method sets the policy ID of this payment instruction.
    
    Parameters:
    
    long1 - The policy ID to set

Methods inherited from class java.lang.Object

EDPPaymentInstruction

setBackendPIId

getBackendPIId

setAmount

getAmount

setAmountDirty

isAmountDirty

setAmountEditable

isAmountEditable

setCancelFlag

isCancelFlag

setId

getId

setIdToCancel

setNewPIFlag

isNewPIFlag

setOverallPaymentInstructionStatus

getOverallPaymentInstructionStatus

setPaymentDataDirty

isPaymentDataDirty

setPaymentDataEditable

isPaymentDataEditable

setPaymentMethod

getPaymentMethod

setProtocolData

getProtocolData

setValid

isValid

getDepositedAmount

getDepositingAmount

setDepositedAmount

setDepositingAmount

toString

getPolicyId

setPolicyId