Package com.highdeal.admin.hci

Class PingResult

java.lang.Object
com.highdeal.admin.hci.PingResult
All Implemented Interfaces:
OperationResult, XMLMarshallable
public class PingResult extends 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 Details

  • Constructor Details

    • PingResult

      public PingResult()

    • PingResult

      public PingResult(boolean status)

  • Method Details

    • getName

      public 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 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(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(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