com.highdeal.rangetable.hci

Class ModifyRangeTableResult

java.lang.Object

com.highdeal.hci.HCIModelAdapter

com.highdeal.hci.OperationResultAdapter

com.highdeal.rangetable.hci.ModifyRangeTableResult

All Implemented Interfaces:

ITagNameProvider, IXMLMarshallable, OperationResult, XMLMapping, XMLMarshallable

public class ModifyRangeTableResult
extends OperationResultAdapter
implements XMLMapping

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

It is composed of the:

• Range Table code
• unique identifier of the result

Operation Request

ModifyRangeTableOp

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="modifyRangeTableResult">
  <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

Fields

Modifier and Type	Field and Description
static String	ID_TAG_NAME
static String	REFERENCE_TAG_NAME
static String	RESULT_NAME The value of this constant represents the XML tag of the modification operation of a RangeTableModel

Constructor Summary

Constructors

Constructor and Description
ModifyRangeTableResult()

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(String cData) Adds character data to the content element.
void	addChild(String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
Class<?>	getClass(String nsUri, String tag, XMLAttributes atts) Returns the Java class for a specified XML tag and its attributes in a namespace.
String	getId() Gets the identifier of the modified range table.
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.
String	getReference()
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(String rangeTableId) Sets the range table identifier.
void	setReference(String reference)

Methods inherited from class com.highdeal.hci.HCIModelAdapter

marshal

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.highdeal.hci.XMLMarshallable

marshal

Field Detail

RESULT_NAME

public static final String RESULT_NAME

The value of this constant represents the XML tag of the modification operation of a RangeTableModel

See Also:

Constant Field Values

ID_TAG_NAME

public static final String ID_TAG_NAME

See Also:

Constant Field Values

REFERENCE_TAG_NAME

public static final String REFERENCE_TAG_NAME

See Also:

Constant Field Values

Constructor Detail

ModifyRangeTableResult

public ModifyRangeTableResult()

Method Detail

getTagName

public 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

getReference

public String getReference()

setReference

public void setReference(String reference)

getId

public String getId()

Gets the identifier of the modified range table.

Returns:

The identifier of the range table that has been modified.

setId

public void setId(String rangeTableId)

Sets the range table identifier.

Parameters:

rangeTableId - The identifier of the modified range table.

getOperandReference

public 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

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

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 Class<?> getClass(String nsUri,
                         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