com.highdeal.admin.hci
Class GetInstanceMapResult

java.lang.Object
  com.highdeal.admin.hci.GetInstanceMapResult

All Implemented Interfaces:

OperationResult, XMLMarshallable

public class GetInstanceMapResult
extends java.lang.Object
implements OperationResult

This class represents the result of the Get Instance Map operation; It contains an instance map.

Operation Request

GetInstanceMapOp

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="getInstanceMapResult">
   <xs:complexType>
     <xs:sequence>
        <xs:element ref="instanceMap" minOccurs="0" maxOccurs="1"/>
     </xs:sequence>
   </xs:complexType>
 </xs:element>

Field Summary

static java.lang.String

OPERATION_NAME The name of this operation: "getInstanceMapResult"

Constructor Summary

GetInstanceMapResult()
Initiliazes a new instance of GetInstanceMapResult.

GetInstanceMapResult(InstanceMap instanceMap)
Initiliazes a new instance of GetInstanceMapResult with an instance map.

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.
InstanceMap	getInstanceMap() Returns the instance map.
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.
void	marshal(XMLOutputter output) Gives an XML representation of this object, including its children.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.

Methods inherited from class java.lang.Object

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

Field Detail

OPERATION_NAME

public static final java.lang.String OPERATION_NAME

The name of this operation: "getInstanceMapResult"

See Also:

Constant Field Values

Constructor Detail

GetInstanceMapResult

public GetInstanceMapResult()

Initiliazes a new instance of GetInstanceMapResult.

GetInstanceMapResult

public GetInstanceMapResult(InstanceMap instanceMap)

Initiliazes a new instance of GetInstanceMapResult with an instance map.

Parameters:

instanceMap - An instance map

Method Detail

getInstanceMap

public InstanceMap getInstanceMap()

Returns the instance map.

Returns:

The instance map

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

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

marshal

public void marshal(XMLOutputter output)

Description copied from interface: XMLMarshallable

Gives an XML representation of this object, including its children.

Specified by:

marshal in interface XMLMarshallable

Parameters:

output - The XML output to marshal the object into