com.highdeal.admin.hci

Class CleanupAllResult

java.lang.Object

com.highdeal.admin.hci.CleanupAllResult

All Implemented Interfaces:

OperationResult, XMLMarshallable

public class CleanupAllResult
extends java.lang.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 Summary

Fields

Modifier and Type	Field and Description
static int	INCOMPLETE_STATUS
static java.lang.String	OPERATION_NAME The XML tag name of the operation result: "cleanupAllResult"
static int	PERFORMED_STATUS
static int	STOPPED_STATUS

Constructor Summary

Constructors

Constructor and Description
CleanupAllResult() Builds an empty cleanup result.

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(java.lang.String cData) Adds character data to the content element.
void	addChild(java.lang.String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
int	getCleanupCount() Gets the total count of cleaned subscriber accounts.
int	getExecutionStatus() Gets the execution status of the stop cleanup operation.
java.lang.String	getExecutionStatusAsString() Gets the execution status of the stop cleanup operation as String.
java.lang.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.
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	setCleanupCount(int val)
void	setCleanupDate(java.util.Date cleanupDate)
void	setExecutionStatus(int val) Sets the execution status of the full cleanup operation.

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

See Also:

Constant Field Values

PERFORMED_STATUS

public static final int PERFORMED_STATUS

See Also:

Constant Field Values

STOPPED_STATUS

public static final int STOPPED_STATUS

See Also:

Constant Field Values

OPERATION_NAME

public static final java.lang.String OPERATION_NAME

The XML tag name of the operation result: "cleanupAllResult"

See Also:

Constant Field Values

Constructor Detail

CleanupAllResult

public CleanupAllResult()

Builds an empty cleanup result.

Method Detail

getExecutionStatus

public int getExecutionStatus()

Gets the execution status of the stop cleanup operation.

Returns:

The status of the stop cleanup operation

getExecutionStatusAsString

public java.lang.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 java.lang.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(java.lang.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(java.lang.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(java.util.Date cleanupDate)