com.highdeal.mappingtable.hci
Class MaintainMappingTableRowResult

java.lang.Object
  com.highdeal.hci.HCIModelAdapter
      com.highdeal.hci.OperationResultAdapter
          com.highdeal.mappingtable.hci.MaintainMappingTableRowResult

All Implemented Interfaces:

ITagNameProvider, IXMLMarshallable, OperationResult, XMLMarshallable

public class MaintainMappingTableRowResult
extends OperationResultAdapter

This class is the result of a maintain operation of Mapping Table.

It is composed of the:

• Mapping Table code
• unique identifier of the maintain operation

Operation Request

MaintainMappingTableRowOp

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

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

static java.lang.String	DEPRECATED_RESULT_NAME The value of this constant represents the previously used XML tag of the result of the maintain operation of a MappingTable. Backward compatibility - BacklogItem : 131 (Multiple table transaction)
static java.lang.String	RESULT_NAME The value of this constant represents the XML tag of the result of the maintain operation of a MappingTable

Constructor Summary

MaintainMappingTableRowResult()

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.String	getMappingTableId() Gets the Mapping Table identifier that owns the maintained rows.
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.
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	setCompatibilityMode() Sets the compatibilityResultName to true.
void	setMappingTableId(java.lang.String mappingTableId) Sets the identifier of the modified Mapping Table that contains all the maintained rows.
void	setReference(java.lang.String reference) Sets the reference which is the unique identifier defined by the persistence layer Mapping Table.

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 the maintain operation of a MappingTable

See Also:

Constant Field Values

DEPRECATED_RESULT_NAME

public static final java.lang.String DEPRECATED_RESULT_NAME

The value of this constant represents the previously used XML tag of the result of the maintain operation of a MappingTable.
Backward compatibility - BacklogItem : 131 (Multiple table transaction)

See Also:

Constant Field Values

Constructor Detail

MaintainMappingTableRowResult

public MaintainMappingTableRowResult()

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

getMappingTableId

public java.lang.String getMappingTableId()

Gets the Mapping Table identifier that owns the maintained rows.

Returns:

The identifier of the modified Mapping Table that contains the maintained rows.

setMappingTableId

public void setMappingTableId(java.lang.String mappingTableId)

Sets the identifier of the modified Mapping Table that contains all the maintained rows.

Parameters:

mappingTableId - The identifier of the modified Mapping Table that owns the row maintained.

getReference

public java.lang.String getReference()

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

Returns:

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

setReference

public void setReference(java.lang.String reference)

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

Parameters:

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

setCompatibilityMode

public void setCompatibilityMode()

Sets the compatibilityResultName to true. This update will change the RESULT_NAME to a DEPRECATED_RESULT_NAME for backward compatibility with clients.

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