Package com.highdeal.bart.hci

Class SchedulingException

java.lang.Object
java.lang.Throwable
java.lang.Exception
com.highdeal.hci.OperationFailureException
com.highdeal.bart.hci.SchedulingException
All Implemented Interfaces:
com.highdeal.hci.OperationResult, XMLMarshallable, Serializable
public class SchedulingException extends com.highdeal.hci.OperationFailureException
Exception thrown when an error occurs during the creation of a schedulable job. This class implements the methods for the description of a scheduling exception.
See Also:

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD 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 Details

    • INTERNAL_ERROR

      public static final int INTERNAL_ERROR
      Reserved for internal use.
      See Also:

    • TOO_MANY_JOBS_SCHEDULED

      public static final int TOO_MANY_JOBS_SCHEDULED
      Too many job are scheduled in the same time.
      See Also:

    • NULL_JOB

      public static final int NULL_JOB
      The job is null.
      See Also:

    • INVALID_JOB

      public static final int INVALID_JOB
      The job is not valid.
      See Also:

    • JOB_DOES_NOT_EXIST

      public static final int JOB_DOES_NOT_EXIST
      This job doesn't exist.
      See Also:

    • INVALID_SCHEDULING

      public static final int INVALID_SCHEDULING
      The given scheduling is not valid.
      See Also:

    • INCOMPATIBLE_CHANGE

      public static final int INCOMPATIBLE_CHANGE
      The job can not be modified.
      See Also:

    • CANNOT_INITIALIZE_JOB

      public static final int CANNOT_INITIALIZE_JOB
      The job can not be initialized.
      See Also:

  • Constructor Details

    • 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, String operandReference)
      Builds an SchedulingException.
      Parameters:
      reason - The reason of the exception
      operandReference - An operand reference such as faultly job ID

  • Method Details

    • getReason

      public int getReason()
      Returns the reason of the exception.
      Returns:
      The reason of the exception

    • getOperandReference

      public String getOperandReference()
      Specified by:
      getOperandReference in interface com.highdeal.hci.OperationResult
      Overrides:
      getOperandReference in class com.highdeal.hci.OperationFailureException

    • toString

      public String toString()
      Returns the reason of the exception in readable format.
      Overrides:
      toString in class Throwable
      Returns:
      A string describing the reason of the exception

    • getMessage

      public String getMessage()
      Gets the message.
      Overrides:
      getMessage in class Throwable
      Returns:
      The message

    • 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

    • addChild

      public void addChild(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

    • addCharacterData

      public void addCharacterData(String cData)
      Description copied from interface: XMLMarshallable
      Adds character data to the content element.
      Parameters:
      cData - The character data 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