com.highdeal.admin.hci
Class ExpirationAlertException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.highdeal.hci.OperationFailureException
              com.highdeal.admin.hci.ExpirationAlertException

All Implemented Interfaces:

OperationResult, XMLMarshallable, java.io.Serializable

public class ExpirationAlertException
extends OperationFailureException

Exception thrown when the activation operation is invoked with invalid arguments.

See Also:

Serialized Form

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="expirationAlertFault">
  <xs:complexType>
      <xs:attribute name="reason" type="ExpirationAlertFaultReasonType"/>
      <xs:attribute name="message" type="xs:string"/>
  </xs:complexType>
 </xs:element>
 <xs:simpleType name="ExpirationAlertFaultReasonType">
  <xs:restriction base="xs:string">
    <xs:enumeration value="invalidToDate"/>
    <xs:enumeration value="processAlreadyRunning"/>
    <xs:enumeration value="dispatcherCommunicationFailed"/>
    <xs:enumeration value="unknown"/>
  </xs:restriction>
 </xs:simpleType>

Field Summary

static int	DISPATCHER_COMMUNICATION_FAILED 2: Constant for dispatcherCommunicationFailed error
static int	INVALID_TO_DATE 0: Constant for invalidToDate error
static java.lang.String	OPERATION_NAME The XML tag name: expirationAlertFault
static int	PROCESS_ALREADY_RUNNING 1: Constant for activationProcesssAlreadyRunning error.
static int	UNKNOWN -1: Constant for unknown error

Constructor Summary

ExpirationAlertException()
Constructs an empty exception.

ExpirationAlertException(int reason, java.lang.String message)
Constructs an exception with a 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()
int	getReason()
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 com.highdeal.hci.OperationFailureException

getOperandReference

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

OPERATION_NAME

public static final java.lang.String OPERATION_NAME

The XML tag name: expirationAlertFault

See Also:

Constant Field Values

INVALID_TO_DATE

public static final int INVALID_TO_DATE

0: Constant for invalidToDate error

See Also:

Constant Field Values

PROCESS_ALREADY_RUNNING

public static final int PROCESS_ALREADY_RUNNING

1: Constant for activationProcesssAlreadyRunning error. An activation process is still running.

See Also:

Constant Field Values

DISPATCHER_COMMUNICATION_FAILED

public static final int DISPATCHER_COMMUNICATION_FAILED

2: Constant for dispatcherCommunicationFailed error

See Also:

Constant Field Values

UNKNOWN

public static final int UNKNOWN

-1: Constant for unknown error

See Also:

Constant Field Values

Constructor Detail

ExpirationAlertException

public ExpirationAlertException()

Constructs an empty exception.

ExpirationAlertException

public ExpirationAlertException(int reason,
                                java.lang.String message)

Constructs an exception with a message. It contains a comprehensive text.

Parameters:

reason - The reason

message - The message

See Also:

INVALID_TO_DATE, PROCESS_ALREADY_RUNNING, DISPATCHER_COMMUNICATION_FAILED, UNKNOWN

Method Detail

getReason

public int getReason()

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