PurchaseOrder (SAP CC 4.1 Java APIs (Core Library))

java.lang.Object
- com.highdeal.pnr.hci.PurchaseOrder

All Implemented Interfaces:

OperationResult, XMLMarshallable
```
public class PurchaseOrder
extends Object
implements OperationResult
```
This class contains the transactional data which is returned to your Java-based client application by the connected SAP CC system. The transactional data results from the processing of the charging operation requests (event-based, session-based, batch).

Depending on the options of the charging operation request, the purchase order may include:
- A list of rated transactions computed by the SAP CC system.
- A list of charging results containing details about the charging operation.
The purchase order may include notifications related to user alerts generated during the charging process. Depending on the options of the charging operation request, these notifications may be located in:
- The related rated transaction
- The related charging result
Note

Allowances do not generate transactions and are not available in charging results. However, notifications generated by allowances are available in other transactions:
- Notifications generated when processing allowance events are available in the transaction related to the logic which triggered the allowance event.
- Notifications generated when processing allowance creation oneshot rates are available in the master transaction related to the logic which created the allowance.
Notifications generated by allowances are always available using the notification framework.
See Also:

StatefulServiceClient, AsyncStatefulServiceClient, BatchServiceClient, AsyncBatchServiceClient

XML API for HCI
The XML APIs specify the following XSD fragment:
XSD Fragment
```
<xs:simpleType name="OrderState">
   <xs:restriction base="xs:string">
      <xs:enumeration value="paid"/>
      <xs:enumeration value="free"/>
   </xs:restriction>
 </xs:simpleType>
  <xs:element name="order">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="transac" minOccurs="0" maxOccurs="unbounded"/>
       <xs:element ref="chargingResult" minOccurs="0" maxOccurs="unbounded"/>
     </xs:sequence>
    <xs:attribute name="status" type="OrderState"/>
    <xs:attribute name="amount" type="xs:string"/>
    <xs:attribute name="snapshotId" type="xs:int"/>
   </xs:complexType>
  </xs:element>
```

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`FREE` Indicates that the purchase is free for the customer.
`static int`	`NO_SNAPSHOT_ID` Constant used when no snapshot identifier is available during event rating.
`static int`	`PAID` Indicates that the purchase is already paid.

Constructor Summary

Constructors
Constructor and Description
`PurchaseOrder()` Builds an empty purchase order
`PurchaseOrder(int state, Money amount, AbstractList<ChargingResult> chargingResults)` Builds a purchase order with a state, an amount and a list of `charged transaction sets`.
`PurchaseOrder(int state, Money amount, int snapshotId)` Builds a purchase order with a state, an amount and a snapshot identifier
`PurchaseOrder(int state, Money amount, int snapshotId, AbstractList<ChargingResult> chargingResults)` Builds a purchase order with a state, an amount, a snapshot identifier and a list of `charging results`.
`PurchaseOrder(int state, Money amount, int snapshotId, Vector<Transaction> transactions)` Builds a purchase order with a state, an amount, a snapshot identifier and a list of `rated transactions` dynamically priced by the SAP CC system
`PurchaseOrder(int state, Money amount, Vector<Transaction> transactions)` Builds a purchase order with a state, an amount and a list of `rated transactions` dynamically priced by the SAP CC system

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCharacterData(String cData)` Adds character data to the content element.
`void`	`addChild(String tagName, XMLMarshallable child)` Adds a child to the object, the `child` representing the marshallable object which must be added to the element.
`Money`	`getAmount()` Returns the total amount of the purchase order.
`int`	`getChargedSnapshotId()` Gets the snapshot identifier used to rate event.
`List<ChargingResult>`	`getChargingResults()` Gets the list of charging results included in the purchase order.
`String`	`getOperandReference()` Gets the code or the reference (if no code exists) that identifies the operand of the operation request; If the operation is not auditable, the operand reference is `null`.
`int`	`getState()`
`Vector<Transaction>`	`getTransactions()` Gets the list of returned transactions.
`AbstractList<Transaction>`	`getUnsynchronizedTransactions()` Gets the list of returned transactions.
`void`	`marshal(XMLOutputter output)` Gives an XML representation of this object, including its children.
`void`	`setAmount(Money price)` Sets the amount of the purchase order.
`void`	`setAttributes(XMLAttributes atts)` Sets the attributes of the XML representation of the element being processed.
`void`	`setChargedSnapshotId(int snapshotId)` Sets the snapshot identifier used to rate event.
`void`	`setState(int s)` Sets the state.

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

- Field Detail
  - PAID
```
public static final int PAID
```
    Indicates that the purchase is already paid. With this state value, the client app can deliver the service.
    
    See Also:
    
    Constant Field Values
  - FREE
```
public static final int FREE
```
    Indicates that the purchase is free for the customer. With this state value, the client app can deliver the service.
    
    See Also:
    
    Constant Field Values
  - NO_SNAPSHOT_ID
```
public static final int NO_SNAPSHOT_ID
```
    Constant used when no snapshot identifier is available during event rating.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PurchaseOrder
```
public PurchaseOrder()
```
    Builds an empty purchase order
  - PurchaseOrder
```
public PurchaseOrder(int state,
                     Money amount,
                     int snapshotId)
```
    Builds a purchase order with a state, an amount and a snapshot identifier
    
    Parameters:
    
    state - The state of the purchase order
    
    amount - The total amount of the order
    
    snapshotId - The snapshot identifier used to rate the event
  - PurchaseOrder
```
public PurchaseOrder(int state,
                     Money amount,
                     Vector<Transaction> transactions)
```
    Builds a purchase order with a state, an amount and a list of rated transactions dynamically priced by the SAP CC system
    
    Parameters:
    
    state - The state of the purchase order
    
    amount - The total amount of the order
    
    transactions - The rated transactions computed by the rating process
  - PurchaseOrder
```
public PurchaseOrder(int state,
                     Money amount,
                     int snapshotId,
                     Vector<Transaction> transactions)
```
    Builds a purchase order with a state, an amount, a snapshot identifier and a list of rated transactions dynamically priced by the SAP CC system
    
    Parameters:
    
    state - The state of the purchase order
    
    amount - The total amount of the order
    
    snapshotId - The snapshot identifier used to rate the event
    
    transactions - The rated transactions computed by the rating process
  - PurchaseOrder
```
public PurchaseOrder(int state,
                     Money amount,
                     AbstractList<ChargingResult> chargingResults)
```
    Builds a purchase order with a state, an amount and a list of charged transaction sets.
    
    Parameters:
    
    state - the state of the purchase order
    
    amount - the total amount of the order
    
    chargingResults - the charging results computed by the charging process
  - PurchaseOrder
```
public PurchaseOrder(int state,
                     Money amount,
                     int snapshotId,
                     AbstractList<ChargingResult> chargingResults)
```
    Builds a purchase order with a state, an amount, a snapshot identifier and a list of charging results.
    
    Parameters:
    
    state - the state of the purchase order
    
    amount - the total amount of the order
    
    snapshotId - the snapshot identifier used to rate the event
    
    chargingResults - the charging results computed by the charging process
- Method Detail
  - getOperandReference
```
public String getOperandReference()
```
    Description copied from interface: OperationResult
    
    Gets the code or the reference (if no code exists) that identifies the operand of the operation request; If the operation is not auditable, the operand reference is null.
    
    Specified by:
    
    getOperandReference in interface OperationResult
    
    Returns:
    
    The operand reference of the operation result
  - getState
```
public int getState()
```
    Returns:
    the purchaseOrder state which can be :
    
    PAID
    
    FREE
  - setState
```
public void setState(int s)
```
    Sets the state.
    Parameters:
    s - the state which can be :
    
    PAID
    
    FREE
  - getAmount
```
public Money getAmount()
```
    Returns the total amount of the purchase order.
    
    Returns:
    
    the amount of the purchase order.
  - setAmount
```
public void setAmount(Money price)
```
    Sets the amount of the purchase order.
    
    Parameters:
    
    price - the amount of the purchase order.
  - getChargedSnapshotId
```
public int getChargedSnapshotId()
```
    Gets the snapshot identifier used to rate event.
    
    Returns:
    
    the snapshot identifier that uses format YYYYMMDD
  - setChargedSnapshotId
```
public void setChargedSnapshotId(int snapshotId)
```
    Sets the snapshot identifier used to rate event.
    
    Parameters:
    
    snapshotId - the snapshot identifier that uses format YYYYMMDD
  - getTransactions
```
public Vector<Transaction> getTransactions()
```
    Gets the list of returned transactions.
    
    Returns:
    
    the list of transaction
  - getUnsynchronizedTransactions
```
public AbstractList<Transaction> getUnsynchronizedTransactions()
```
    Gets the list of returned transactions.
    
    Returns:
    
    the list of transaction
  - getChargingResults
```
public List<ChargingResult> getChargingResults()
```
    Gets the list of charging results included in the purchase order.
    This method returns a not-empty list only when called on the result of the method BatchServiceClient.charge(ChargeableItem, String, String, java.util.Date, String, ChargeExecutionContext).
    
    Returns:
    
    the list of charging results
  - setAttributes
```
public void setAttributes(XMLAttributes atts)
```
    Description copied from interface: XMLMarshallable
    
    Sets the attributes of the XML representation of the element being processed.
    
    Specified by:
    
    setAttributes in interface XMLMarshallable
    
    Parameters:
    
    atts - The XML attributes of the current element
  - addChild
```
public void addChild(String tagName,
                     XMLMarshallable child)
```
    Description copied from interface: XMLMarshallable
    
    Adds a child to the object, the child representing the marshallable object which must be added to the element.
    
    Specified by:
    
    addChild in interface XMLMarshallable
    
    Parameters:
    
    tagName - The name of tag for the child
    
    child - The child to be added
  - addCharacterData
```
public void addCharacterData(String cData)
```
    Description copied from interface: XMLMarshallable
    
    Adds character data to the content element.
    
    Specified by:
    
    addCharacterData in interface XMLMarshallable
    
    Parameters:
    
    cData - The character data to be added
  - marshal
```
public void marshal(XMLOutputter output)
```
    Description copied from interface: XMLMarshallable
    
    Gives an XML representation of this object, including its children.
    
    Specified by:
    
    marshal in interface XMLMarshallable
    
    Parameters:
    
    output - The XML output to marshal the object into

Class PurchaseOrder

XML API for HCI

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PAID

FREE

NO_SNAPSHOT_ID

Constructor Detail

PurchaseOrder

PurchaseOrder

PurchaseOrder

PurchaseOrder

PurchaseOrder

PurchaseOrder

Method Detail

getOperandReference

getState

setState

getAmount

setAmount

getChargedSnapshotId

setChargedSnapshotId

getTransactions

getUnsynchronizedTransactions

getChargingResults

setAttributes

addChild

addCharacterData

marshal