Index

Code Index:

package Date::Holidays::Adapter::AU
- holidays
- is_holiday
__END__
EOF

NAME

Date::Holidays::Adapter::AU - an adapter class for Date::Holidays::AU

VERSION

This POD describes version 0.01 of Date::Holidays::Adapter::AU

DESCRIPTION

The is the SUPER adapter class. All of the adapters in the distribution of Date::Holidays are subclasses of this particular class. Date::Holidays

SUBROUTINES/METHODS

new

The constructor, takes a single named argument, countrycode

is_holiday

The holidays method, takes 3 named arguments, year, month and day

Returns an indication of whether the day is a holiday in the calendar of the country referenced by countrycode in the call to the constructor new.

holidays

The holidays method, takes a single named argument, year

Returns a reference to a hash holding the calendar of the country referenced by countrycode in the call to the constructor new.

The calendar will spand for a year and the keys consist of month and day concatenated.

DIAGNOSTICS

* Date::Holidays::Exception::AdapterLoad

This exception is thrown when Date::Holidays::Adapter attempts to load an actual adapter implementation. This exception is recoverable to the extend that is caught and handled internally.

When caught the SUPER adapter is attempted loaded, Date::Holidays::Adapter if this however fails Date::Holidays::Exception::SuperAdapterLoad it thrown see below.

* Date::Holidays::Exception::AdapterInitialization

This exception is thrown when in was not possible to load either a implementation of a given adapter, or the SUPER adapter Date::Holidays::Adapter.

* Date::Holidays::Exception::NoCountrySpecified

The exception is thrown if a country code is provided, which is not listed in Locale::Country, which lists ISO 3166 codes, which is the unique 2 character strings assigned to each country in the world.

* Date::Holidays::Exception::UnsupportedMethod

Exception thrown in the case where the loaded and initialized module does not support the called method. (SEE: METHODS/SUBROUTINES).

DEPENDENCIES

* Date::Holidays::AU
* Date::Holidays::Adapter
* Date::Holidays::Exception::UnsupportedMethod
* Date::Holidays::Exception::InvalidCountryCode
* Date::Holidays::Exception::NoCountrySpecified
* Date::Holidays::Exception::UnsupportedMethod
* Error
* UNIVERSAL

INCOMPATIBILITIES

Please refer to INCOMPATIBILITIES in Date::Holidays

BUGS AND LIMITATIONS

Currently we have an exception for the Date::Holidays::AU module, so the additional parameter of state is defaulting to 'VIC', please refer to the POD for Date::Holidays::AU for documentation on this.

BUG REPORTING

Please report issues via CPAN RT:

  http://rt.cpan.org/NoAuth/Bugs.html?Dist=Date-Holidays

or by sending mail to

  bug-Date-Holidays@rt.cpan.org

AUTHOR

Jonas B. Nielsen, (jonasbn) - <jonasbn@cpan.org>

LICENSE AND COPYRIGHT

Date::Holidays and related modules are (C) by Jonas B. Nielsen, (jonasbn) 2004-2007

Date::Holidays and related modules are released under the artistic license

The distribution is licensed under the Artistic License, as specified by the Artistic file in the standard perl distribution (http://www.perl.com/language/misc/Artistic.html).