Package com.highdeal.admin.hci

Class SystemStatus

java.lang.Object
com.highdeal.admin.hci.SystemStatus
All Implemented Interfaces:
XMLMarshallable
public class SystemStatus extends Object implements XMLMarshallable
This Java class represents the system status that is a list of statuses for each instance in the connected SAP CC system.
See Also:

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="systemStatus">
   <xs:complexType>
     <xs:sequence>
        <xs:element ref="instanceStatus" minOccurs="0" maxOccurs="unbounded"/>
     </xs:sequence>
     <xs:attribute name="maintenance" type="xs:boolean"/>
   </xs:complexType>
 </xs:element>

  • Field Details

    • TAG_NAME

      public static final String TAG_NAME
      The XML tag name of this class: "systemStatus"
      See Also:

    • MAINTENANCE_MODE

      public static final String MAINTENANCE_MODE
      The XML attribute name of the status: "maintenanceMode"
      See Also:

  • Constructor Details

    • SystemStatus

      public SystemStatus()
      Initializes a new instance of SystemStatus.

  • Method Details

    • addInstanceStatus

      public void addInstanceStatus(InstanceStatus instanceStatus)
      Add an instance status to the system status.
      Parameters:
      instanceStatus - The instance status to add

    • getInstanceStatus

      public InstanceStatus getInstanceStatus(InstanceId instanceId)
      Get the instance status of the given instance ID.
      Parameters:
      instanceId - The given instance ID
      Returns:
      The instance status of the given instance ID or null

    • getInstancesStatus

      public List<InstanceStatus> getInstancesStatus()
      Get the list of instance status.
      Returns:
      The list of instance status

    • getInstancesStatus

      public List<InstanceStatus> getInstancesStatus(InstanceType instanceType)
      Get the sub-list of instance status on the specified instance type.
      Parameters:
      instanceType - The given instance type
      Returns:
      The sub-list of instance status on the given instance type

    • getInstancesStatus

      public List<InstanceStatus> getInstancesStatus(InstanceType instanceType, ServerStatus... status)
      Get the sub-list of instance status on the specified instance type and status.
      Parameters:
      instanceType - The given instance type
      status - The status list to filter
      Returns:
      The sub-list of instance status on the given instance type

    • setMaintenanceMode

      public void setMaintenanceMode(boolean maintenance)
      Sets whether the system is in maintenance mode.
      Parameters:
      maintenance - true if the system is in maintenance mode, false otherwise

    • isMaintenanceMode

      public boolean isMaintenanceMode()
      Gets whether the system is in maintenance mode.
      Returns:
      true if the system is in maintenance mode, false otherwise

    • 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