Package 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
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
FieldsModifier and TypeFieldDescriptionstatic final StringThe XML tag name of this operation response: "createMappingTableRowResult" -
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.Gets the identifier of the Mapping Table Row that has been created.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 isnull.Gets thereferencewhich is the unique identifier defined by the persistence layer Mapping Table Row.Gets the XML tag name of theHCI operation result.voidmarshalAttributes(XMLOutputter output) Gives an XML representation of the attributes of an object.voidmarshalChildren(XMLOutputter output) Gives an XML representation of the child objects of an object.voidsetAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.voidSets the identifier of the Mapping Table Row created.voidsetReference(String reference) Sets thereferencewhich is the unique identifier defined by the persistence layer Mapping Table Row.Methods inherited from class com.highdeal.hci.HCIModelAdapter
marshal
-
Field Details
-
RESULT_NAME
The XML tag name of this operation response: "createMappingTableRowResult"- See Also:
-
-
Constructor Details
-
CreateMappingTableRowResult
public CreateMappingTableRowResult()
-
-
Method Details
-
getTagName
Description copied from class:OperationResultAdapterGets the XML tag name of theHCI operation result.- Specified by:
getTagNamein interfaceITagNameProvider- Specified by:
getTagNamein classOperationResultAdapter- Returns:
- The XML tag name
-
getOperandReference
Description copied from interface:OperationResultGets 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 isnull.- Returns:
- The operand reference of the operation result
-
getReference
Gets thereferencewhich is the unique identifier defined by the persistence layer Mapping Table Row.- Returns:
- the
referencewhich is the unique identifier defined by the persistence layer Mapping Table Row.
-
setReference
Sets thereferencewhich is the unique identifier defined by the persistence layer Mapping Table Row.- Parameters:
reference- thereferencewhich is the unique identifier defined by the persistence layer Mapping Table Row.
-
getMappingTableId
Gets the identifier of the Mapping Table Row that has been created.- Returns:
- A
Stringthat contains the identifier of the created Mapping Table Row.
-
setMappingTableId
Sets the identifier of the Mapping Table Row created.- Parameters:
id- The identifier of the created Mapping Table Row.
-
setAttributes
Description copied from interface:XMLMarshallableSets the attributes of the XML representation of the element being processed.- 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.- 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.- Parameters:
cData- The character data to be added
-
marshalAttributes
Description copied from interface:IXMLMarshallableGives an XML representation of the attributes of an object.- Parameters:
output- TheXML outputto marshal the object attributes into
-
marshalChildren
Description copied from interface:IXMLMarshallableGives an XML representation of the child objects of an object.- Parameters:
output- TheXML outputto marshal the child objects into
-