com.highdeal.admin.hci

Class GetSystemStatusOp

java.lang.Object

com.highdeal.admin.hci.GetSystemStatusOp

All Implemented Interfaces:

MessageOperation, XMLMarshallable

public class GetSystemStatusOp
extends java.lang.Object
implements MessageOperation

This operation allows you to retrieve the statuses (on, off, waiting) of each instance in the connected SAP CC system; The operation result is available in an overall system status.

See Also:

InstanceStatus, SystemStatus

Operation Result

GetSystemStatusResult

Operation Failure Exception

ServerFailureException

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="getSystemStatus">
   <xs:complexType>
     <xs:attribute name="version" type="xs:string" />
   </xs:complexType>
 </xs:element>

Operation Availability

You can send this operation request in HCI messages to the following final target types of instances in the connected SAP CC system:

Edition	Final Target Instances
	rater	updater	guider	bulkLoader	taxer	dispatcher
charge	No	No	No	No	No	Yes

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OPERATION_NAME The XML tag name of this service operation: "getSystemStatus"

Constructor Summary

Constructors

Constructor and Description
GetSystemStatusOp()

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.
java.lang.String	getName() Returns the name of the operation: "getSystemStatus"
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.

Methods inherited from class java.lang.Object

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

Field Detail

OPERATION_NAME

public static final java.lang.String OPERATION_NAME

The XML tag name of this service operation: "getSystemStatus"

See Also:

Constant Field Values

Constructor Detail

GetSystemStatusOp

public GetSystemStatusOp()

Method Detail

getName

public java.lang.String getName()

Returns the name of the operation: "getSystemStatus"

Specified by:

getName in interface MessageOperation

Returns:

"getSystemStatus"

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