com.highdeal.bart.hci
Class SchedulingException

java.lang.Object
  OperationFailureException
      com.highdeal.bart.hci.SchedulingException

public class SchedulingException
extends OperationFailureException

This class implements the methods for the description of a scheduling exception.

XML Schema Fragment

<xs:element name="schedulingFault">
   <xs:complexType>
     <xs:attribute name="reason" type="SchedulingReasonType"/>
     <xs:attribute name="message" type="xs:string"/>
   </xs:complexType>
 </xs:element>

<xs:simpleType name="SchedulingReasonType">
   <xs:restriction base="xs:string">
     <xs:enumeration value="internalError"/>
     <xs:enumeration value="tooManyJobsScheduled"/>
     <xs:enumeration value="nullJob"/>
     <xs:enumeration value="invalidJob"/>
     <xs:enumeration value="doesNotExist"/>
     <xs:enumeration value="invalidScheduling"/>
     <xs:enumeration value="incompatibleChange"/>
     <xs:enumeration value="cannotInitializeJob"/>
   </xs:restriction>
 </xs:simpleType>

Field Summary

static int	CANNOT_INITIALIZE_JOB The job can not be initialized.
static int	INCOMPATIBLE_CHANGE The job can not be modified.
static int	INTERNAL_ERROR Reserved for internal use.
static int	INVALID_JOB The job is not valid.
static int	INVALID_SCHEDULING The given scheduling is not valid.
static int	JOB_DOES_NOT_EXIST This job doesn't exist.
static int	NULL_JOB The job is null.
static int	TOO_MANY_JOBS_SCHEDULED Too many job are scheduled in the same time.

Constructor Summary

SchedulingException()
Builds an empty SchedulingException.

SchedulingException(int reason)
Builds an SchedulingException.

SchedulingException(int reason, java.lang.String operandReference)
Builds an SchedulingException.

Method Summary

void	addCharacterData(java.lang.String cData)
void	addChild(java.lang.String tagName, XMLMarshallable child)
java.lang.String	getMessage() Gets the message.
java.lang.String	getOperandReference()
int	getReason() Returns the reason of the exception.
void	marshal(XMLOutputter output)
void	setAttributes(XMLAttributes atts)
java.lang.String	toString() Returns the reason of the exception in readable format.

Methods inherited from class java.lang.Object

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

Field Detail

INTERNAL_ERROR

public static final int INTERNAL_ERROR

Reserved for internal use.

See Also:

Constant Field Values

TOO_MANY_JOBS_SCHEDULED

public static final int TOO_MANY_JOBS_SCHEDULED

Too many job are scheduled in the same time.

See Also:

Constant Field Values

NULL_JOB

public static final int NULL_JOB

The job is null.

See Also:

Constant Field Values

INVALID_JOB

public static final int INVALID_JOB

The job is not valid.

See Also:

Constant Field Values

JOB_DOES_NOT_EXIST

public static final int JOB_DOES_NOT_EXIST

This job doesn't exist.

See Also:

Constant Field Values

INVALID_SCHEDULING

public static final int INVALID_SCHEDULING

The given scheduling is not valid.

See Also:

Constant Field Values

INCOMPATIBLE_CHANGE

public static final int INCOMPATIBLE_CHANGE

The job can not be modified.

See Also:

Constant Field Values

CANNOT_INITIALIZE_JOB

public static final int CANNOT_INITIALIZE_JOB

The job can not be initialized.

See Also:

Constant Field Values

Constructor Detail

SchedulingException

public SchedulingException()

Builds an empty SchedulingException.

SchedulingException

public SchedulingException(int reason)

Builds an SchedulingException.

Parameters:

reason - the reason of the exception.

SchedulingException

public SchedulingException(int reason,
                           java.lang.String operandReference)

Builds an SchedulingException.

Parameters:

reason - the reason of the exception.

operandReference - an operand reference such as faultly job ID.

Method Detail

getReason

public int getReason()

Returns the reason of the exception.

Returns:

the reason of the exception.

getOperandReference

public java.lang.String getOperandReference()

toString

public java.lang.String toString()

Returns the reason of the exception in readable format.

Returns:

a string describing the reason of the exception.

getMessage

public java.lang.String getMessage()

Gets the message.

Returns:

the message.

setAttributes

public void setAttributes(XMLAttributes atts)

addChild

public void addChild(java.lang.String tagName,
                     XMLMarshallable child)

addCharacterData

public void addCharacterData(java.lang.String cData)

marshal

public void marshal(XMLOutputter output)