com.highdeal.admin.hci
Class StopCleanupResult

java.lang.Object
  com.highdeal.admin.hci.StopCleanupResult

All Implemented Interfaces:

OperationResult, XMLMarshallable

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

static int	INCOMPLETE_STATUS
static int	NO_RUNNING_PROCESS_STATUS
static java.lang.String	OPERATION_NAME
static int	PERFORMED_STATUS
static int	UNKNOWN_STATUS

Constructor Summary

StopCleanupResult()
Builds an empty stopCleanup result.

Method Summary

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	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	setExecutionStatus(int val) Sets the value of the stop cleanup operation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PERFORMED_STATUS

public static final int PERFORMED_STATUS

See Also:

Constant Field Values

INCOMPLETE_STATUS

public static final int INCOMPLETE_STATUS

See Also:

Constant Field Values

NO_RUNNING_PROCESS_STATUS

public static final int NO_RUNNING_PROCESS_STATUS

See Also:

Constant Field Values

UNKNOWN_STATUS

public static final int UNKNOWN_STATUS

See Also:

Constant Field Values

OPERATION_NAME

public static final java.lang.String OPERATION_NAME

See Also:

Constant Field Values

Constructor Detail

StopCleanupResult

public StopCleanupResult()

Builds an empty stopCleanup 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 value of the stop cleanup operation.

Parameters:

val - The execution status of the stop cleanup operation

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