Class OnClientModel

java.lang.Object
com.highdeal.hci.OnClientModel
All Implemented Interfaces:
XMLMarshallable

public class OnClientModel extends Object implements XMLMarshallable
Represents an explicit client scope on the HCI originator.

When present on the originator, the request is scoped to the assignment matching the specified client number.

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="onClient">
  <xs:complexType>
    <xs:attribute name="number" type="xs:integer" use="required"/>
  </xs:complexType>
</xs:element>

  • Field Details

  • Constructor Details

    • OnClientModel

      public OnClientModel()
  • Method Details

    • getNumber

      public int getNumber()
      Gets the client number.
      Returns:
      the client number
    • setNumber

      public void setNumber(int number)
      Sets the client number.
      Parameters:
      number - the client number
    • 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