com.highdeal.mappingtable.hci

Class CreateMappingTableRowResult

java.lang.Object

com.highdeal.hci.HCIModelAdapter

com.highdeal.hci.OperationResultAdapter

com.highdeal.mappingtable.hci.CreateMappingTableRowResult

All Implemented Interfaces:

ITagNameProvider, IXMLMarshallable, OperationResult, XMLMarshallable

public class CreateMappingTableRowResult
extends OperationResultAdapter

This class represents the result of the Create Mapping Table Row operation.

The operation result includes:

• The unique system-generated reference for this data object. This reference is the Object ID (see fields OID) in the database.

• The identifier (ID) of the mapping table class. It is visible in the user interfaces.

Operation Request

CreateMappingTableRowOp

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RESULT_NAME The XML tag name of this operation response: "createMappingTableRowResult"

Constructor Summary

Constructors

Constructor and Description
CreateMappingTableRowResult()

Method Summary

Modifier and Type	Method and Description
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.String	getMappingTableId() Gets the identifier of the Mapping Table Row 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 reference which is the unique identifier defined by the persistence layer Mapping Table Row.
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	setMappingTableId(java.lang.String id) Sets the identifier of the Mapping Table Row created.
void	setReference(java.lang.String reference) Sets the reference which is the unique identifier defined by the persistence layer Mapping Table Row.

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 java.lang.String RESULT_NAME

The XML tag name of this operation response: "createMappingTableRowResult"

See Also:

Constant Field Values

Constructor Detail

CreateMappingTableRowResult

public CreateMappingTableRowResult()

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.

Returns:

The operand reference of the operation result

getReference

public java.lang.String getReference()

Gets the reference which is the unique identifier defined by the persistence layer Mapping Table Row.

Returns:

the reference which is the unique identifier defined by the persistence layer Mapping Table Row.

setReference

public void setReference(java.lang.String reference)

Sets the reference which is the unique identifier defined by the persistence layer Mapping Table Row.

Parameters:

reference - the reference which is the unique identifier defined by the persistence layer Mapping Table Row.

getMappingTableId

public java.lang.String getMappingTableId()

Gets the identifier of the Mapping Table Row that has been created.

Returns:

A String that contains the identifier of the created Mapping Table Row.

setMappingTableId

public void setMappingTableId(java.lang.String id)

Sets the identifier of the Mapping Table Row created.

Parameters:

id - The identifier of the created Mapping Table Row.

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the element being processed.

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.

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.

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.

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.

Parameters:

output - The XML output to marshal the child objects into