com.highdeal.hci
Class CreateAuditResult

java.lang.Object
  com.highdeal.hci.CreateAuditResult

All Implemented Interfaces:

OperationResult, XMLMarshallable

public class CreateAuditResult
extends java.lang.Object
implements OperationResult

This class represents the result of the Create Audit operation; It contains the code and the reference of the audit that has been created.

Operation Request

CreateAuditOp

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="createAuditResult">
  <xs:complexType>
   <xs:attribute name="code" type="xs:string"/>
   <xs:attribute name="ref" type="xs:string"/>
  </xs:complexType>
 </xs:element>

Constructor Summary

CreateAuditResult()

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	getCode() Gets the code of audit 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 of the audit that has been created.
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.
void	setCode(java.lang.String code) Sets the code of the audit that has been created.
void	setReference(java.lang.String ref) Sets the reference of the audit that has been created.

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateAuditResult

public CreateAuditResult()

Method Detail

getReference

public java.lang.String getReference()

Gets the reference of the audit that has been created.

Returns:

The reference of the audit that has been created

setReference

public void setReference(java.lang.String ref)

Sets the reference of the audit that has been created.

Parameters:

ref - The reference of the audit that has been created

getCode

public java.lang.String getCode()

Gets the code of audit that has been created.

Returns:

The code of the audit that has been created

setCode

public void setCode(java.lang.String code)

Sets the code of the audit that has been created.

Parameters:

code - The code of audit that has been created

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

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

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

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

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