Package com.highdeal.admin.hci

Class StandbyInstance

java.lang.Object
com.highdeal.admin.hci.StandbyInstance
All Implemented Interfaces:
XMLMarshallable
public class StandbyInstance extends Object implements XMLMarshallable
This model represents an instance identifier and the related standby status.

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="standbyInstance">
   <xs:complexType>
     <xs:attribute name="instanceId" use="required">
       <xs:simpleType>
         <xs:restriction base="xs:string">
           <xs:pattern value="((rater|guider)#\d+)"/>
         </xs:restriction>
       </xs:simpleType>
     </xs:attribute>
     <xs:attribute name="isStandby" type="xs:boolean" use="required"/>
   </xs:complexType>
 </xs:element>

  • Field Details

  • Constructor Details

    • StandbyInstance

      public StandbyInstance()
      Creates a model.

    • StandbyInstance

      public StandbyInstance(String instanceId, boolean isStandby)
      Creates a model.
      Parameters:
      instanceId - the instance identifier
      isStandby - the standby status

  • Method Details

    • getInstanceId

      public String getInstanceId()
      Gets the instance identifier.
      Returns:
      the instance identifier

    • setInstanceId

      public void setInstanceId(String instanceId)
      Sets the instance identifier.
      Parameters:
      instanceId - the instance identifier

    • isStandby

      public boolean isStandby()
      Gets the standby status.
      Returns:
      the standby status

    • setStandby

      public void setStandby(boolean isStandby)
      Sets the standby status.
      Parameters:
      isStandby - the standby status

    • 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

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • unmarshal

      public static final StandbyInstance unmarshal(com.highdeal.hmi.IDataBuffer buffer) throws BufferUnderflowException, MalformedInputException
      Reads a model from a data buffer.
      Parameters:
      buffer - the data buffer to read from
      Returns:
      the model read from the buffer
      Throws:
      BufferUnderflowException - if the value cannot be read from the data buffer specified
      MalformedInputException - if the value cannot be read from the data buffer specified

    • marshal

      public static final void marshal(StandbyInstance standbyInstance, com.highdeal.hmi.DataBuffer buffer) throws com.highdeal.util.NullArgumentException, BufferOverflowException
      Writes a model into a data buffer.s
      Parameters:
      standbyInstance - the model to write into the buffer
      buffer - the data buffer to write into
      Throws:
      com.highdeal.util.NullArgumentException
      BufferOverflowException - if the value cannot be written to the data buffer specified