Package com.highdeal.admin.hci

Class StopCleanupResult

java.lang.Object
com.highdeal.admin.hci.StopCleanupResult
All Implemented Interfaces:
OperationResult, XMLMarshallable
public class StopCleanupResult extends Object implements OperationResult
This class represents the result of the Stop Cleanup operation.

Operation Request

StopCleanupOp

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="stopCleanupResult">
   <xs:complexType>
     <xs:attribute name="executionStatus" type="StopCExcStatusType" use="required"/>
   </xs:complexType>
 </xs:element>

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

  • Field Details

  • Constructor Details

    • StopCleanupResult

      public StopCleanupResult()
      Builds an empty stopCleanup result.

  • Method Details

    • getExecutionStatus

      public int getExecutionStatus()
      Gets the execution status of the stop cleanup operation.
      Returns:
      The status of the stop cleanup operation

    • getExecutionStatusAsString

      public String getExecutionStatusAsString()
      Gets the execution status of the stop cleanup operation as String.
      Returns:
      The status of the stop cleanup operation

    • setExecutionStatus

      public void setExecutionStatus(int val)
      Sets the value of the stop cleanup operation.
      Parameters:
      val - The execution status of the stop cleanup 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