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 public holiday or a holiday is invalid.

Reasons

See the Field Summary section for more information about the available reasons.

Exception and Error Handling

Depending on your business requirements, design and develop the relevant error handling functions in your client application.

See Also:

Serialized Form

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD 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

Fields

Modifier and Type	Field and Description
static int	DUPLICATED_HOLIDAY_CODE 2: Reason used when a HolidayModel code appears twice or more in a PublicHolidaysModel object.
static int	DUPLICATED_HOLIDAY_GROUP 3: Reason used when a holiday group code appears twice or more in a PublicHolidaysModel object.
static int	INVALID_HOLIDAY_CONFIGURATION 1: Reason used when a HolidayModel is not properly configured.
static int	INVALID_HOLIDAY_GROUP_DESCRIPTION 4: Reason used when a holiday group description is not properly configured.
static int	NULL_HOLIDAY_CODE 0: Reason used when a HolidayModel has no code.

Constructor Summary

Constructors

Constructor and Description
InvalidHolidayException() Constructs an empty exception.
InvalidHolidayException(int error, java.lang.String message) Constructs an exception with an error code and a message.

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.
int	getError() Returns the reason why the holiday is invalid.
java.lang.String	getMessage() Returns the comprehensive message explaining why the holiday is invalid.
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

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

NULL_HOLIDAY_CODE

public static final int NULL_HOLIDAY_CODE

0: Reason used when a HolidayModel has no code.

See Also:

Constant Field Values

INVALID_HOLIDAY_CONFIGURATION

public static final int INVALID_HOLIDAY_CONFIGURATION

1: Reason used when a HolidayModel is not properly configured.

See Also:

Constant Field Values

DUPLICATED_HOLIDAY_CODE

public static final int DUPLICATED_HOLIDAY_CODE

2: 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

3: 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

4: Reason used when a holiday group description 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 comprehensive 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 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