com.highdeal.calendar.hci
Class InvalidHolidayException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.highdeal.hci.OperationFailureException
              com.highdeal.calendar.hci.InvalidHolidayException

All Implemented Interfaces:

OperationResult, XMLMarshallable, java.io.Serializable

public class InvalidHolidayException
extends OperationFailureException

Exception thrown when a PublicHolidaysModel or a HolidayModel is invalid.

See Also:

Serialized Form

XML Schema Fragment

<xs:element name="invalidHolidayFault">
   <xs:complexType>
    <xs:attribute name="error" type="InvalidHolidayFaultErrorType"/>
    <xs:attribute name="message" type="xs:string"/>
   </xs:complexType>
  </xs:element>

<xs:simpleType name="InvalidHolidayFaultErrorType">
   <xs:restriction base="xs:string">
      <xs:enumeration value="nullHolidayCode"/>
      <xs:enumeration value="invalidHolidayConfiguration"/>
      <xs:enumeration value="invalidHolidayGroupDescription"/>
      <xs:enumeration value="duplicatedHolidayCode"/>
      <xs:enumeration value="duplicatedHolidayGroup"/>
   </xs:restriction>
 </xs:simpleType>

Field Summary

static int	DUPLICATED_HOLIDAY_CODE Reason used when a HolidayModel code appears twice or more in a PublicHolidaysModel object.
static int	DUPLICATED_HOLIDAY_GROUP Reason used when a holiday group code appears twice or more in a PublicHolidaysModel object.
static int	INVALID_HOLIDAY_CONFIGURATION Reason used when a HolidayModel is not properly configured.
static int	INVALID_HOLIDAY_GROUP_DESCRIPTION Reason used when a holiday group desfription is not properly configured.
static int	NULL_HOLIDAY_CODE Reason used when a HolidayModel has no code.

Constructor Summary

InvalidHolidayException()
Constructs an empty exception.

InvalidHolidayException(int error, java.lang.String message)
Constructs an exception with an error code and 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 objects, the child represents the marshallable object to be added into the content tree.
int	getError() Returns the reason why the holiday is invalid.
java.lang.String	getMessage() Returns the detailed message explaining why the holiday is invalid.
void	marshal(XMLOutputter output) Gives an XML representation of this object, and of its children.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the tag beeing 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

NULL_HOLIDAY_CODE

public static final int NULL_HOLIDAY_CODE

Reason used when a HolidayModel has no code.

See Also:

Constant Field Values

INVALID_HOLIDAY_CONFIGURATION

public static final int INVALID_HOLIDAY_CONFIGURATION

Reason used when a HolidayModel is not properly configured.

See Also:

Constant Field Values

DUPLICATED_HOLIDAY_CODE

public static final int DUPLICATED_HOLIDAY_CODE

Reason used when a HolidayModel code appears twice or more in a PublicHolidaysModel object.

See Also:

Constant Field Values

DUPLICATED_HOLIDAY_GROUP

public static final int DUPLICATED_HOLIDAY_GROUP

Reason used when a holiday group code appears twice or more in a PublicHolidaysModel object.

See Also:

Constant Field Values

INVALID_HOLIDAY_GROUP_DESCRIPTION

public static final int INVALID_HOLIDAY_GROUP_DESCRIPTION

Reason used when a holiday group desfription is not properly configured.

See Also:

Constant Field Values

Constructor Detail

InvalidHolidayException

public InvalidHolidayException()

Constructs an empty exception.

InvalidHolidayException

public InvalidHolidayException(int error,
                               java.lang.String message)

Constructs an exception with an error code and a message. The message contains a human readable text.

Parameters:

message - the message.

error - the error.

Method Detail

getError

public int getError()

Returns the reason why the holiday is invalid.

Returns:

the error code.

See Also:

NULL_HOLIDAY_CODE, INVALID_HOLIDAY_CONFIGURATION, DUPLICATED_HOLIDAY_CODE, DUPLICATED_HOLIDAY_GROUP, INVALID_HOLIDAY_GROUP_DESCRIPTION

getMessage

public java.lang.String getMessage()

Returns the detailed message explaining why the holiday is invalid.

Overrides:

getMessage in class java.lang.Throwable

Returns:

the detailed message.

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the tag beeing processed.

Parameters:

atts - the XML attributes of the current tag.

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 objects, the child represents the marshallable object to be added into the content tree.

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, and of its children.

Parameters:

output - the XML output to marshall the object into.