com.highdeal.admin.hci
Class GetStatusResult

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

All Implemented Interfaces:

OperationResult, XMLMarshallable

public class GetStatusResult
extends java.lang.Object
implements OperationResult

This class represents the result of the Get Status operation; It contains a status for the specified server instance.

Implementation in Your Client Application

Use getStatus() to get the resulting status.

Operation Request

GetStatusOp

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="getStatusResult">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="status" minOccurs="1" maxOccurs="1"/>
     </xs:sequence>
   </xs:complexType>
 </xs:element>

Field Summary

static java.lang.String	OPERATION_ID Mapping for the operation ID: "opID"
static java.lang.String	OPERATION_NAME The name of this operation: "getStatusResult"

Constructor Summary

GetStatusResult()

GetStatusResult(StatusModel model)

Method Summary

void	addCharacterData(java.lang.String cData) Adds string data to this operation.
void	addChild(java.lang.String tagName, XMLMarshallable child) Adds a child tag to this operation.
java.lang.String	getName() Returns the name of the operation: "getStatus"
java.lang.String	getOperandReference() Returns the operand reference for audit.
java.lang.String	getOperationID() Gets the operation ID.
StatusModel	getStatus() Gets the server status.
void	marshal(XMLOutputter output) Writes the operation XML data to the given output.
void	setAttributes(XMLAttributes atts) Sets the operation attributes from the XMLAttributes.
void	setOperationID(java.lang.String id) Sets the operation ID.
void	setStatus(StatusModel model) Sets the server status.

Methods inherited from class java.lang.Object

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

Field Detail

OPERATION_NAME

public static final java.lang.String OPERATION_NAME

The name of this operation: "getStatusResult"

See Also:

Constant Field Values

OPERATION_ID

public static final java.lang.String OPERATION_ID

Mapping for the operation ID: "opID"

See Also:

Constant Field Values

Constructor Detail

GetStatusResult

public GetStatusResult()

GetStatusResult

public GetStatusResult(StatusModel model)

Method Detail

setStatus

public void setStatus(StatusModel model)

Sets the server status.

Parameters:

model - The status of the server to be set

getStatus

public StatusModel getStatus()

Gets the server status.

Returns:

The status of the server

getOperationID

public java.lang.String getOperationID()

Gets the operation ID.

Returns:

The operation ID, or null if the operation has no ID

setOperationID

public void setOperationID(java.lang.String id)

Sets the operation ID.

Parameters:

id - The operation identifier

getName

public java.lang.String getName()

Returns the name of the operation: "getStatus"

Returns:

"getStatus"

getOperandReference

public java.lang.String getOperandReference()

Returns the operand reference for audit.

Specified by:

getOperandReference in interface OperationResult

Returns:

null, as this result is not audited

setAttributes

public void setAttributes(XMLAttributes atts)

Sets the operation attributes from the XMLAttributes.

Specified by:

setAttributes in interface XMLMarshallable

Parameters:

atts - The XMLAttributes containing the data

addCharacterData

public void addCharacterData(java.lang.String cData)

Adds string data to this operation.

This data is ignored for this operation.

Specified by:

addCharacterData in interface XMLMarshallable

Parameters:

cData - The character data to add to the operation

addChild

public void addChild(java.lang.String tagName,
                     XMLMarshallable child)

Adds a child tag to this operation.

For this operation, the child must be a StatusModel.

Specified by:

addChild in interface XMLMarshallable

Parameters:

tagName - The name of the tag

child - The XMLMarshallable child to add

marshal

public void marshal(XMLOutputter output)

Writes the operation XML data to the given output.

Specified by:

marshal in interface XMLMarshallable

Parameters:

output - The XMLOutputter to write into