com.highdeal.admin.hci

Class GetSystemStatusResult

java.lang.Object

com.highdeal.admin.hci.GetSystemStatusResult

All Implemented Interfaces:

OperationResult, XMLMarshallable

public class GetSystemStatusResult
extends Object
implements OperationResult

This class represents the result of the Get System Status operation; It contains an overall system status with the running status (on, off, waiting) of each SAP CC system instance.

See Also:

SystemStatus, InstanceStatus

Operation Request

GetSystemStatusOp

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="getSystemStatusResult">
   <xs:complexType>
     <xs:sequence>
        <xs:element ref="systemStatus" minOccurs="0" maxOccurs="1"/>
     </xs:sequence>
   </xs:complexType>
 </xs:element>

Field Summary

Fields

Modifier and Type	Field and Description
static String	OPERATION_NAME The XML tag name of this operation result: "getSystemStatusResult"

Constructor Summary

Constructors

Constructor and Description
GetSystemStatusResult() Initiliazes a new instance of GetSystemStatusResult.

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(String cData) Adds character data to the content element.
void	addChild(String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
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.
SystemStatus	getSystemStatus() Get the system status associated to the response.
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	setSystemStatus(SystemStatus systemStatus) Set the system status to the response.

Methods inherited from class java.lang.Object

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

Field Detail

OPERATION_NAME

public static final String OPERATION_NAME

The XML tag name of this operation result: "getSystemStatusResult"

See Also:

Constant Field Values

Constructor Detail

GetSystemStatusResult

public GetSystemStatusResult()

Initiliazes a new instance of GetSystemStatusResult.

Method Detail

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

getSystemStatus

public SystemStatus getSystemStatus()

Get the system status associated to the response.

Returns:

The SAP CC system status

setSystemStatus

public void setSystemStatus(SystemStatus systemStatus)

Set the system status to the response.

Parameters:

systemStatus - The system status to set

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