Package com.highdeal.admin.hci

Class StopPurgeAllowancesResult

java.lang.Object
com.highdeal.admin.hci.StopPurgeAllowancesResult
All Implemented Interfaces:
OperationResult, XMLMarshallable
public class StopPurgeAllowancesResult extends Object implements OperationResult
FOR INTERNAL USE ONLY - This class represents the result of the Stop Purge Allowances operation; It contains an overall execution status and the total count of checked provider contracts.

Operation Request

StopPurgeAllowancesOp

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="stopPurgeAllowancesResult">
   <xs:complexType>
     <xs:attribute name="executionStatus" type="StopAAExcStatusType" use="required"/>
   </xs:complexType>
 </xs:element>

 <xs:simpleType name="StopAAExcStatusType">
   <xs:restriction base="xs:string">
     <xs:enumeration value="performed"/>  <!-- each rater has received the stop order and each rater has stopped its purge allowances -->
     <xs:enumeration value="incomplete"/>  <!-- if the stop order cannot be transmitted to all raters -->
     <xs:enumeration value="stopped"/>  <!-- if it exists no running purge allowances process -->
     <xs:enumeration value="unknown"/>
   </xs:restriction>
 </xs:simpleType>

  • Field Details

  • Constructor Details

    • StopPurgeAllowancesResult

      public StopPurgeAllowancesResult()
      Builds an empty purge allowances result.

  • Method Details

    • 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 value of the stop purge allowances operation.
      Parameters:
      val - The execution status of the stop purge allowances operation

    • 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