HistoryPaymentInformation

java.lang.Object
- com.ibm.commerce.order.history.HistoryPaymentInformation

All Implemented Interfaces:

XMLRecordable
```
public class HistoryPaymentInformation
extends java.lang.Object
implements XMLRecordable
```
This class is used to track payment history information. It can be used to get the XML element from an com.ibm.commerce.edp.api.EDPPaymentInstruction or get HistoryPaymentInformation from the XML.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
The IBM Copyright statement.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` The IBM Copyright statement.

Constructor Summary

Constructors
Constructor and Description

HistoryPaymentInformation()

Constructors
Constructor and Description
`HistoryPaymentInformation()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`fieldsToXML()` This method converts only this object's fields into an XML format representation.
`java.math.BigDecimal`	`getAmount()` Gets amount
`java.lang.Boolean`	`getCancelFlag()` Gets cancel Flag
`java.math.BigDecimal`	`getDepositedAmount()` Gets deposited Amount
`java.math.BigDecimal`	`getDepositingAmount()` Gets depositing Amount
`java.lang.String`	`getOverallPaymentInstructionStatus()` Gets overall Payment Instruction Status
`java.lang.Long`	`getPaymentInstructionId()` Gets payment Instruction Id
`java.lang.String`	`getPaymentMethodName()` Gets payment Method Name
`java.util.HashMap`	`getProtocolDataMap()` Gets protocolData Map
`java.lang.Boolean`	`getValid()` Gets valid
`void`	`setAmount(java.math.BigDecimal decimal)` Sets amount
`void`	`setCancelFlag(java.lang.Boolean boolean1)` Sets cancelFlag
`void`	`setDepositedAmount(java.math.BigDecimal decimal)` Sets deposited Amount
`void`	`setDepositingAmount(java.math.BigDecimal decimal)` Sets depositing Amount
`void`	`setOverallPaymentInstructionStatus(java.lang.String string)` Sets overall Payment Instruction Status
`void`	`setPaymentInstruction(EDPPaymentInstruction pi)` This method sets `EDP` Payment Instruction.
`void`	`setPaymentInstructionId(java.lang.Long long1)` Sets payment Instruction Id
`void`	`setPaymentMethodName(java.lang.String string)` Sets payment Method Name
`void`	`setProtocolDataMap(java.util.HashMap map)` Sets protocolData Map
`void`	`setValid(java.lang.Boolean boolean1)` Sets valid
`XMLRecordable`	`toFields(org.w3c.dom.Node xmlNode)` This method transforms an XML node into a real Object's field.
`XMLRecordable`	`toObject(org.w3c.dom.Node xmlNode)` This method transforms an XML node into a real Object.
`java.lang.String`	`toXML()` This method converts this object into an XML format representation.

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

- Field Detail
  - COPYRIGHT
```
public static final java.lang.String COPYRIGHT
```
    The IBM Copyright statement.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HistoryPaymentInformation
```
public HistoryPaymentInformation()
```
- Method Detail
  - toObject
```
public XMLRecordable toObject(org.w3c.dom.Node xmlNode)
```
    This method transforms an XML node into a real Object.
    
    Specified by:
    
    toObject in interface XMLRecordable
    
    Parameters:
    
    xmlNode - the XML string to be converted to an object.
    
    Returns:
    
    the object the XML string represents.
    
    See Also:
    
    XMLRecordable.toObject(org.w3c.dom.Node)
  - toXML
```
public java.lang.String toXML()
```
    This method converts this object into an XML format representation.
    
    Specified by:
    
    toXML in interface XMLRecordable
    
    Returns:
    
    the XML string represents this object.
    
    See Also:
    
    XMLRecordable.toXML()
  - fieldsToXML
```
public java.lang.String fieldsToXML()
```
    This method converts only this object's fields into an XML format representation.
    
    Specified by:
    
    fieldsToXML in interface XMLRecordable
    
    Returns:
    
    the XML string just represents this objects's fields.
    
    See Also:
    
    XMLRecordable.fieldsToXML()
  - getAmount
```
public java.math.BigDecimal getAmount()
```
    Gets amount
    
    Returns:
    
    amount
  - getDepositedAmount
```
public java.math.BigDecimal getDepositedAmount()
```
    Gets deposited Amount
    
    Returns:
    
    deposited Amount
  - getDepositingAmount
```
public java.math.BigDecimal getDepositingAmount()
```
    Gets depositing Amount
    
    Returns:
    
    depositing Amount
  - getOverallPaymentInstructionStatus
```
public java.lang.String getOverallPaymentInstructionStatus()
```
    Gets overall Payment Instruction Status
    
    Returns:
    
    overall Payment Instruction Status
  - getPaymentInstructionId
```
public java.lang.Long getPaymentInstructionId()
```
    Gets payment Instruction Id
    
    Returns:
    
    payment Instruction Id
  - getPaymentMethodName
```
public java.lang.String getPaymentMethodName()
```
    Gets payment Method Name
    
    Returns:
    
    paymentMethodName
  - getProtocolDataMap
```
public java.util.HashMap getProtocolDataMap()
```
    Gets protocolData Map
    
    Returns:
    
    protocolDataMap
  - setAmount
```
public void setAmount(java.math.BigDecimal decimal)
```
    Sets amount
    
    Parameters:
    
    decimal - amount
  - setDepositedAmount
```
public void setDepositedAmount(java.math.BigDecimal decimal)
```
    Sets deposited Amount
    
    Parameters:
    
    decimal - depositedAmount
  - setDepositingAmount
```
public void setDepositingAmount(java.math.BigDecimal decimal)
```
    Sets depositing Amount
    
    Parameters:
    
    decimal - depositingAmount
  - setOverallPaymentInstructionStatus
```
public void setOverallPaymentInstructionStatus(java.lang.String string)
```
    Sets overall Payment Instruction Status
    
    Parameters:
    
    string - overall Payment Instruction Status
  - setPaymentInstructionId
```
public void setPaymentInstructionId(java.lang.Long long1)
```
    Sets payment Instruction Id
    
    Parameters:
    
    long1 - payment Instruction Id
  - setPaymentMethodName
```
public void setPaymentMethodName(java.lang.String string)
```
    Sets payment Method Name
    
    Parameters:
    
    string - paymentMethodName
  - setProtocolDataMap
```
public void setProtocolDataMap(java.util.HashMap map)
```
    Sets protocolData Map
    
    Parameters:
    
    map - protocolDataMap
  - getCancelFlag
```
public java.lang.Boolean getCancelFlag()
```
    Gets cancel Flag
    
    Returns:
    
    cancel Flag
  - getValid
```
public java.lang.Boolean getValid()
```
    Gets valid
    
    Returns:
    
    valid
  - setCancelFlag
```
public void setCancelFlag(java.lang.Boolean boolean1)
```
    Sets cancelFlag
    
    Parameters:
    
    boolean1 - cancelFlag
  - setValid
```
public void setValid(java.lang.Boolean boolean1)
```
    Sets valid
    
    Parameters:
    
    boolean1 - valid
  - toFields
```
public XMLRecordable toFields(org.w3c.dom.Node xmlNode)
```
    This method transforms an XML node into a real Object's field.
    
    Specified by:
    
    toFields in interface XMLRecordable
    
    Parameters:
    
    xmlNode - the XML node contains the fields to be converted.
    
    Returns:
    
    the object whose fields from the XML node passed in.
    
    See Also:
    
    XMLRecordable.toFields(org.w3c.dom.Node)
  - setPaymentInstruction
```
public void setPaymentInstruction(EDPPaymentInstruction pi)
```
    This method sets EDP Payment Instruction.
    
    Parameters:
    
    pi - EDPPaymentInstruction.

Methods inherited from class java.lang.Object

COPYRIGHT

HistoryPaymentInformation

toObject

toXML

fieldsToXML

getAmount

getDepositedAmount

getDepositingAmount

getOverallPaymentInstructionStatus

getPaymentInstructionId

getPaymentMethodName

getProtocolDataMap

setAmount

setDepositedAmount

setDepositingAmount

setOverallPaymentInstructionStatus

setPaymentInstructionId

setPaymentMethodName

setProtocolDataMap

getCancelFlag

getValid

setCancelFlag

setValid

toFields

setPaymentInstruction