Class OnClientModel
java.lang.Object
com.highdeal.hci.OnClientModel
- All Implemented Interfaces:
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 Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddCharacterData(String cData) Adds character data to the content element.voidaddChild(String tagName, XMLMarshallable child) Adds a child to the object, thechildrepresenting the marshallable object which must be added to the element.intGets the client number.voidmarshal(XMLOutputter output) Gives an XML representation of this object, including its children.voidsetAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.voidsetNumber(int number) Sets the client number.
-
Field Details
-
TAG_NAME
-
-
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
Description copied from interface:XMLMarshallableSets the attributes of the XML representation of the element being processed.- Specified by:
setAttributesin interfaceXMLMarshallable- Parameters:
atts- TheXML attributesof the current element
-
addChild
Description copied from interface:XMLMarshallableAdds a child to the object, thechildrepresenting the marshallable object which must be added to the element.- Specified by:
addChildin interfaceXMLMarshallable- Parameters:
tagName- The name of tag for the childchild- The child to be added
-
addCharacterData
Description copied from interface:XMLMarshallableAdds character data to the content element.- Specified by:
addCharacterDatain interfaceXMLMarshallable- Parameters:
cData- The character data to be added
-
marshal
Description copied from interface:XMLMarshallableGives an XML representation of this object, including its children.- Specified by:
marshalin interfaceXMLMarshallable- Parameters:
output- TheXML outputto marshal the object into
-