com.highdeal.admin.hci
Class PingResult

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

All Implemented Interfaces:

OperationResult, XMLMarshallable

public class PingResult
extends java.lang.Object
implements OperationResult

This class represents the result of the Ping operation; It contains a status set to true if the distant instance of the SAP CC system is alive, false otherwise.

Implementation in Your Client Application

Use getStatus() to get the resulting status.

Operation Request

PingOp

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="pingResult">
   <xs:complexType>
     <xs:attribute name="status" type="xs:boolean"/>
   </xs:complexType>
 </xs:element>

Field Summary

static java.lang.String	OPERATION_NAME The XML name of this operation: "pingResult"
static java.lang.String	STATUS Mapping for the ping status: "status"

Constructor Summary

PingResult()

PingResult(boolean status)

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: "ping"
java.lang.String	getOperandReference() Gets the operand reference for auditing purpose.
boolean	getStatus() Returns the ping status of the ping request
void	marshal(XMLOutputter output) Writes the operation XML data to the given output.
void	setAttributes(XMLAttributes atts) Sets the operation attributes from the XMLAttributes.

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 XML name of this operation: "pingResult"

See Also:

Constant Field Values

STATUS

public static final java.lang.String STATUS

Mapping for the ping status: "status"

See Also:

Constant Field Values

Constructor Detail

PingResult

public PingResult()

PingResult

public PingResult(boolean status)

Method Detail

getName

public java.lang.String getName()

Returns the name of the operation: "ping"

Returns:

"ping"

getStatus

public boolean getStatus()

Returns the ping status of the ping request

Returns:

The ping status: true if server is alive, else false.

getOperandReference

public java.lang.String getOperandReference()

Gets the operand reference for auditing purpose.

Specified by:

getOperandReference in interface OperationResult

Returns:

null, as this operation 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.

This tag is ignored for this operation.

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