Package com.highdeal.admin.hci

Class CleanupAllResult

java.lang.Object
com.highdeal.admin.hci.CleanupAllResult
All Implemented Interfaces:
OperationResult, XMLMarshallable
public class CleanupAllResult extends Object implements OperationResult
This class represents the operation result of the Cleanup All operation; It includes an overall execution status.

Operation Request

CleanupAllOp

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="cleanupAllResult">
   <xs:complexType>
     <xs:attribute name="cleanupCount" type="xs:integer" use="required"/> <!-- This is the count of visited subscriber accounts -->
     <xs:attribute name="executionStatus" type="CleanupAllExcStatusType" use="required"/>
   </xs:complexType>
 </xs:element>
<xs:simpleType name="CleanupAllExcStatusType">
   <xs:restriction base="xs:string">
     <xs:enumeration value="performed"/> <!-- each rater has received the activation/cleanup order and each rater has performed its activation/cleanup -->
     <xs:enumeration value="stopped"/> <!-- the global activation/cleanup process has been stopped by the user -->
     <xs:enumeration value="incomplete"/> <!-- some rater instances did not confirm that they have received the activation/cleanup order from the updater -->
   </xs:restriction>
 </xs:simpleType>

  • Field Details

  • Constructor Details

    • CleanupAllResult

      public CleanupAllResult()
      Builds an empty cleanup 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 execution status of the full cleanup operation.
      Parameters:
      val - The new status value

    • getCleanupCount

      public int getCleanupCount()
      Gets the total count of cleaned subscriber accounts.
      Returns:
      The number of cleaned subscriber accounts

    • setCleanupCount

      public void setCleanupCount(int val)

    • 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

    • setCleanupDate

      public void setCleanupDate(Date cleanupDate)