com.highdeal.rangetable.hci
Class CreateRangeTableResult

java.lang.Object
  com.highdeal.hci.HCIModelAdapter
      com.highdeal.hci.OperationResultAdapter
          com.highdeal.rangetable.hci.CreateRangeTableResult

All Implemented Interfaces:

ITagNameProvider, IXMLMarshallable, OperationResult, XMLMapping, XMLMarshallable

public class CreateRangeTableResult
extends OperationResultAdapter
implements XMLMapping

This class is the result of a creation operation of Range Table.

It is composed of the:

• Range Table code
• unique identifier of the result

Operation Request

CreateRangeTableOp

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="createRangeTableResult">
  <xs:complexType>
     <xs:attribute name="reference" type="xs:string" use="required"/>
     <xs:attribute name="id" type="xs:string" use="required"/>
  </xs:complexType>
 </xs:element>

Field Summary

static java.lang.String	RANGE_TABLE_ID_TAG_NAME
static java.lang.String	REFERENCE_TAG_NAME
static java.lang.String	RESULT_NAME The value of this constant represents the XML tag of the result of a creation operation of a RangeTable

Constructor Summary

CreateRangeTableResult()

Method Summary

void	addCharacterData(java.lang.String cData) Adds character data to the content element.
void	addChild(java.lang.String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
java.lang.Class<?>	getClass(java.lang.String nsUri, java.lang.String tag, XMLAttributes atts) Returns the Java class for a specified XML tag and its attributes in a namespace.
java.lang.String	getId() Gets the identifier of the Range table that has been created.
java.lang.String	getOperandReference() Gets the code or the reference (if no code exists) that identifies the operand of the operation request; If the operation is not auditable, the operand reference is null.
java.lang.String	getReference() Gets the unique reference of the creation operation.
java.lang.String	getTagName() Gets the XML tag name of the HCI operation result.
void	marshalAttributes(XMLOutputter output) Gives an XML representation of the attributes of an object.
void	marshalChildren(XMLOutputter output) Gives an XML representation of the child objects of an object.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setId(java.lang.String id) Sets the identifier of the created Range Table.
void	setReference(java.lang.String reference) Sets the creation operation reference.

Methods inherited from class com.highdeal.hci.HCIModelAdapter

marshal

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.highdeal.hci.XMLMarshallable

marshal

Field Detail

RESULT_NAME

public static final java.lang.String RESULT_NAME

The value of this constant represents the XML tag of the result of a creation operation of a RangeTable

See Also:

Constant Field Values

RANGE_TABLE_ID_TAG_NAME

public static final java.lang.String RANGE_TABLE_ID_TAG_NAME

See Also:

Constant Field Values

REFERENCE_TAG_NAME

public static final java.lang.String REFERENCE_TAG_NAME

See Also:

Constant Field Values

Constructor Detail

CreateRangeTableResult

public CreateRangeTableResult()

Method Detail

getTagName

public java.lang.String getTagName()

Description copied from class: OperationResultAdapter

Gets the XML tag name of the HCI operation result.

Specified by:

getTagName in interface ITagNameProvider

Specified by:

getTagName in class OperationResultAdapter

Returns:

The XML tag name

getOperandReference

public java.lang.String getOperandReference()

Description copied from interface: OperationResult

Gets the code or the reference (if no code exists) that identifies the operand of the operation request; If the operation is not auditable, the operand reference is null.

Specified by:

getOperandReference in interface OperationResult

Returns:

The operand reference of the operation result

getReference

public java.lang.String getReference()

Gets the unique reference of the creation operation. This reference is used to identify an operation.

Returns:

A String that contains the reference of the operation.

setReference

public void setReference(java.lang.String reference)

Sets the creation operation reference.

Parameters:

reference - The reference of the operation.

getId

public java.lang.String getId()

Gets the identifier of the Range table that has been created.

Returns:

The identifier of the created Range Table.

setId

public void setId(java.lang.String id)

Sets the identifier of the created Range Table.

Parameters:

id - The Range Table identifier that has been created.

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(java.lang.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(java.lang.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

marshalAttributes

public void marshalAttributes(XMLOutputter output)

Description copied from interface: IXMLMarshallable

Gives an XML representation of the attributes of an object.

Specified by:

marshalAttributes in interface IXMLMarshallable

Parameters:

output - The XML output to marshal the object attributes into

marshalChildren

public void marshalChildren(XMLOutputter output)

Description copied from interface: IXMLMarshallable

Gives an XML representation of the child objects of an object.

Specified by:

marshalChildren in interface IXMLMarshallable

Parameters:

output - The XML output to marshal the child objects into

getClass

public java.lang.Class<?> getClass(java.lang.String nsUri,
                                   java.lang.String tag,
                                   XMLAttributes atts)

Description copied from interface: XMLMapping

Returns the Java class for a specified XML tag and its attributes in a namespace.

Specified by:

getClass in interface XMLMapping

Parameters:

nsUri - The unique resource identifier of the namespace of the XML tag

tag - The local part of the XML tag

atts - The attributes of the XML tag

Returns:

A Java class with a default constructor