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

java.lang.Object
- com.highdeal.admin.hci.PurgeAllowancesResult

All Implemented Interfaces:: OperationResult, XMLMarshallable

public class PurgeAllowancesResult
extends Object
implements OperationResult

FOR INTERNAL USE ONLY - This class represents the result of the Purge Allowances operation; It contains an overall execution status (see PERFORMED_STATUS, #INCOMPLETE_STATUS, or #STOPPED_STATUS) and the total count of processed provider contracts.

Operation Request

PurgeAllowancesOp

Other Related Operation

Consider the Stop Purge Allowances operation

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="purgeAllowancesResult">
   <xs:complexType>
     <xs:attribute name="processedCount" type="xs:integer" use="required"/>
     <xs:attribute name="processedFailed" type="xs:integer" use="required"/>
     <xs:attribute name="visited" type="xs:integer" use="required"/>
     <xs:attribute name="purged" type="xs:integer" use="required"/>
     <xs:attribute name="cannotPurgeAfter" type="xs:date" use="required"/>
     <xs:attribute name="purgeDate" type="xs:date" use="required"/>
     <xs:attribute name="executionStatus" type="PurgeExcStatusType" use="required"/>
   </xs:complexType>
 </xs:element>

<xs:simpleType name="PurgeExcStatusType">
   <xs:restriction base="xs:string">
     <xs:enumeration value="performed"/>   <!-- each rater instance has received the purge allowances order and each rater has performed its purge allowances -->
     <xs:enumeration value="stopped"/>     <!-- the global purge allowances process has been stopped by the user -->
     <xs:enumeration value="incomplete"/>  <!-- some rater instances did not confirm that they have received the purge allowances order from the updater -->
   </xs:restriction>
 </xs:simpleType>

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`INCOMPLETE_STATUS` 0: Constant for the overall execution status when the processing was incomplete
`static String`	`OPERATION_NAME` The XML tag name of this operation result: "purgeAllowancesResult"
`static int`	`PERFORMED_STATUS` 1: Constant for the overall execution status when the processing was completed
`static int`	`STOPPED_STATUS` 2: Constant for the overall execution status when the processing was stopped

Constructor Summary

Constructors
Constructor and Description

PurgeAllowancesResult()
Builds an empty purge allowances result.

Constructors
Constructor and Description
`PurgeAllowancesResult()` Builds an empty purge allowances result.

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.
`Date`	`getCannotPurgeAfter()`
`int`	`getExecutionStatus()` Gets the execution status of the stop purge allowances operation.
`String`	`getExecutionStatusAsString()` Gets the execution status of the stop purge allowances operation as String.
`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`	`getProcessedCount()` Gets the total count of processed provider contracts.
`int`	`getProcessedFailed()`
`int`	`getPurged()`
`Date`	`getPurgeDate()`
`int`	`getVisited()`
`void`	`marshal(XMLOutputter output)` Gives an XML representation of this object, including its children.
`void`	`setAttributes(XMLAttributes atts)` Sets the attributes of the XML representation of the element being processed.
`void`	`setCannotPurgeAfter(Date cannotPurgeAfter)`
`void`	`setExecutionStatus(int val)` Sets the execution status of the purge allowances operation.
`void`	`setProcessedCount(int val)`
`void`	`setProcessedFailed(int failed)`
`void`	`setPurged(int purged)`
`void`	`setPurgeDate(Date purgeDate)`
`void`	`setVisited(int visited)`

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

- Field Detail
  - INCOMPLETE_STATUS
```
public static final int INCOMPLETE_STATUS
```
    0: Constant for the overall execution status when the processing was incomplete
    
    See Also:
    
    Constant Field Values
  - PERFORMED_STATUS
```
public static final int PERFORMED_STATUS
```
    1: Constant for the overall execution status when the processing was completed
    
    See Also:
    
    Constant Field Values
  - STOPPED_STATUS
```
public static final int STOPPED_STATUS
```
    2: Constant for the overall execution status when the processing was stopped
    
    See Also:
    
    Constant Field Values
  - OPERATION_NAME
```
public static final String OPERATION_NAME
```
    The XML tag name of this operation result: "purgeAllowancesResult"
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PurgeAllowancesResult
```
public PurgeAllowancesResult()
```
    Builds an empty purge allowances result.
- Method Detail
  - getExecutionStatus
```
public int getExecutionStatus()
```
    Gets the execution status of the stop purge allowances operation.
    
    Returns:
    
    The status of the stop purge allowances operation
  - getExecutionStatusAsString
```
public String getExecutionStatusAsString()
```
    Gets the execution status of the stop purge allowances operation as String.
    
    Returns:
    
    The status of the stop purge allowances operation
  - setExecutionStatus
```
public void setExecutionStatus(int val)
```
    Sets the execution status of the purge allowances operation.
    
    Parameters:
    
    val - The new status value
  - getProcessedCount
```
public int getProcessedCount()
```
    Gets the total count of processed provider contracts.
    
    Returns:
    
    The number of processed provider contracts
  - setProcessedCount
```
public void setProcessedCount(int val)
```
  - getVisited
```
public int getVisited()
```
  - getPurged
```
public int getPurged()
```
  - getProcessedFailed
```
public int getProcessedFailed()
```
  - setVisited
```
public void setVisited(int visited)
```
  - setPurged
```
public void setPurged(int purged)
```
  - setProcessedFailed
```
public void setProcessedFailed(int failed)
```
  - getCannotPurgeAfter
```
public Date getCannotPurgeAfter()
```
  - setCannotPurgeAfter
```
public void setCannotPurgeAfter(Date cannotPurgeAfter)
```
  - 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
  - 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
  - setPurgeDate
```
public void setPurgeDate(Date purgeDate)
```
  - getPurgeDate
```
public Date getPurgeDate()
```

Class PurgeAllowancesResult

Operation Request

Other Related Operation

XML API for HCI

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INCOMPLETE_STATUS

PERFORMED_STATUS

STOPPED_STATUS

OPERATION_NAME

Constructor Detail

PurgeAllowancesResult

Method Detail

getExecutionStatus

getExecutionStatusAsString

setExecutionStatus

getProcessedCount

setProcessedCount

getVisited

getPurged

getProcessedFailed

setVisited

setPurged

setProcessedFailed

getCannotPurgeAfter

setCannotPurgeAfter

getOperandReference

setAttributes

addChild

addCharacterData

marshal

setPurgeDate

getPurgeDate