com.highdeal.admin.hci

Class StandbyException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.highdeal.hci.OperationFailureException

com.highdeal.admin.hci.StandbyException

All Implemented Interfaces:

OperationResult, XMLMarshallable, java.io.Serializable

public class StandbyException
extends OperationFailureException

Exception thrown when an error occurs during the execution of the SetStandbyStatusOp operation.

See Also:

Serialized Form

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="standbyFault">
  <xs:complexType>
     <xs:attribute name="reason" type="StandbyFaultReasonType" use="required"/>
     <xs:attribute name="instanceId" type="xs:string"/>
   </xs:complexType>
 </xs:element>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StandbyException.StandbyExceptionReason This enumeration lists the possible reasons for StandbyException.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EXCEPTION_NAME The XML element name for the exception.
static java.lang.String	INSTANCE_ID The XML attribute name for the instance identifier.
static java.lang.String	REASON The XML attribute name for the exception reason.

Constructor Summary

Constructors

Constructor and Description
StandbyException() Creates an exception.
StandbyException(StandbyException.StandbyExceptionReason reason, java.lang.String instanceId) Creates an exception with a reason and an optional instance identifier.

Method Summary

Modifier and Type	Method and Description
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	getInstanceId() Gets the instance identifier associated to the exception.
java.lang.String	getMessage()
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.
StandbyException.StandbyExceptionReason	getReason() Gets the reason for 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

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EXCEPTION_NAME

public static final java.lang.String EXCEPTION_NAME

The XML element name for the exception.

See Also:

Constant Field Values

REASON

public static final java.lang.String REASON

The XML attribute name for the exception reason.

See Also:

Constant Field Values

INSTANCE_ID

public static final java.lang.String INSTANCE_ID

The XML attribute name for the instance identifier.

See Also:

Constant Field Values

Constructor Detail

StandbyException

public StandbyException()

Creates an exception.

StandbyException

public StandbyException(StandbyException.StandbyExceptionReason reason,
                        java.lang.String instanceId)

Creates an exception with a reason and an optional instance identifier.

Parameters:

reason - the reason for the exception

instanceId - an instance identifier (can be null)

Method Detail

getInstanceId

public java.lang.String getInstanceId()

Gets the instance identifier associated to the exception.

Returns:

the instance identifier associated to the exception (can be null)

getReason

public StandbyException.StandbyExceptionReason getReason()

Gets the reason for the exception.

Returns:

the reason for the exception

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

getMessage

public java.lang.String getMessage()

Overrides:

getMessage in class java.lang.Throwable

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