com.highdeal.hci
Class InvalidExportException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.highdeal.hci.OperationFailureException
              com.highdeal.hci.InvalidExportException

All Implemented Interfaces:

OperationResult, XMLMarshallable, java.io.Serializable

public class InvalidExportException
extends OperationFailureException

Generic exception thrown when there is an attempt to export something which is not valid.

See Also:

Serialized Form

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="invalidExportFault">
  <xs:complexType>
    <xs:attribute name="reason" type="ReasonType"/>
    <xs:attribute name="objectCode" type="xs:string" use="optional"/>
    <xs:attribute name="objectType" type="xs:string" use="optional"/>
    <xs:attribute name="message" type="xs:string" use="required"/>
  </xs:complexType>
 </xs:element>

 <xs:simpleType name="ReasonType">
   <xs:restriction base="xs:string">
      <xs:enumeration value="does_not_exist"/>
      <xs:enumeration value="invalid"/>
   </xs:restriction>
 </xs:simpleType>

Field Summary

static int	DOES_NOT_EXIST Constant for a does not exist exception reason.
static int	INVALID Constant for a invalid exception reason.

Constructor Summary

InvalidExportException()
Constructs an empty exception.

InvalidExportException(int reason, java.lang.String objectCode, java.lang.String objectType, java.lang.String message)
Constructs an exception with the reason of the exception, the type and the code of the object which we tried to export, and the specified detail message.

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	getMessage() Returns the message of the exception.
java.lang.String	getObjectCode() Returns the code of the object.
java.lang.String	getObjectType() Returns the type of the object.
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.
int	getReason() Returns the reason of the exception.
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.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

DOES_NOT_EXIST

public static final int DOES_NOT_EXIST

Constant for a does not exist exception reason.

See Also:

Constant Field Values

INVALID

public static final int INVALID

Constant for a invalid exception reason.

See Also:

Constant Field Values

Constructor Detail

InvalidExportException

public InvalidExportException()

Constructs an empty exception.

InvalidExportException

public InvalidExportException(int reason,
                              java.lang.String objectCode,
                              java.lang.String objectType,
                              java.lang.String message)

Constructs an exception with the reason of the exception, the type and the code of the object which we tried to export, and the specified detail message.

Parameters:

reason - The reason of the exception.

objectCode - The code of the object which we tried to export.

objectType - The type of the object which we tried to export.

message - The detail message.

Method Detail

getReason

public int getReason()

Returns the reason of the exception.

Returns:

The reason of the exception.

getObjectType

public java.lang.String getObjectType()

Returns the type of the object.

Returns:

The type of the object.

getObjectCode

public java.lang.String getObjectCode()

Returns the code of the object.

Returns:

The code of the object.

getMessage

public java.lang.String getMessage()

Returns the message of the exception.

Overrides:

getMessage in class java.lang.Throwable

Returns:

The message of the exception.

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

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

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

marshal

public void marshal(XMLOutputter output)

Description copied from interface: XMLMarshallable

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

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

Overrides:

getOperandReference in class OperationFailureException

Returns:

The operand reference of the operation result