OSID - osid.locale.CalendarInfo Service Interface Definition

Interface	osid.locale.CalendarInfo
Used By	`osid.locale.CalendarInfoSession`
Description	This interface defines methods to examine a calendar. A calendar is organized into "years," "months," and "days." A calendar system may offer a diffreent designation for these divisions which may or may not vary in duration.
Method	getCalendarType
Description	Gets the calendar type.
Return	`osid.type.Type`		the calendar type
Compliance	`mandatory`		This method must be implemented.
Method	getDisplayName
Description	Gets the display name for this calendar.
Return	`osid.locale.DisplayText`		the display name
Compliance	`mandatory`		This method must be implemented.
Method	getDescription
Description	Gets a description of this calendar.
Return	`osid.locale.DisplayText`		the description
Compliance	`mandatory`		This method must be implemented.
Method	getCommonEraName
Description	Gets the string for the common era in which years are positive.
Return	`osid.locale.DisplayText`		the common era label
Compliance	`mandatory`		This method must be implemented.
Method	getCommonEraAbbrev
Description	Gets the abbreviation for the common era in which years are positive.
Return	`osid.locale.DisplayText`		the common era label
Compliance	`mandatory`		This method must be implemented.
Method	getBeforeCommonEraName
Description	Gets the string for before the common era in which years are negative.
Return	`osid.locale.DisplayText`		the before common era label
Compliance	`mandatory`		This method must be implemented.
Method	getBeforeCommonEraAbbrev
Description	Gets the abbreviation for before the common era in which years are negative.
Return	`osid.locale.DisplayText`		the before common era label
Compliance	`mandatory`		This method must be implemented.
Method	getFirstYearInCommonEra
Description	Gets the year number for the first year.
Return	`integer`		the first year
Compliance	`mandatory`		This method must be implemented.
Method	getLastYearBeforeCommonEra
Description	Gets the year number for the year before the common era.
Return	`integer`		the last bce year
Compliance	`mandatory`		This method must be implemented.
Method	getYearName
Description	Gets the display name for a calendar "year."
Return	`osid.locale.DisplayText`		the name
Compliance	`mandatory`		This method must be implemented.
Method	getMonthName
Description	Gets the display name for a calendar "month."
Return	`osid.locale.DisplayText`		the name
Compliance	`mandatory`		This method must be implemented.
Method	hasVariableMonths
Description	Tests if this calendar has a variable number of months in a year.
Return	`boolean`		`true` if the number of months varies, `false` if the number of months is constant
Compliance	`mandatory`		This method must be implemented.
Method	getNumMonths
Description	Gets the number of months of the year. For a variable month calendar, the number of all defined months are returned. If there are no "months" in this calendar system then this value may be zero.
Return	`cardinal`		the number of months
Compliance	`mandatory`		This method must be implemented.
Method	getNumMonthsForYear
Description	Gets the number of months in the given year.
Parameters	`integer`	`year`	a year
Return	`cardinal`		the number of months
Errors	ILLEGAL_STATE		`year` is greater than `getLastYearBeforeCommonEra()` and less then `getFirstYearInCommonEra()`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getMonths
Description	Gets the months of the year in order of the calendar. For a variable month calendar, all defined months are returned. If there are no "months" in this calendar system then the list may be empty.
Return	`osid.locale.CalendarUnit[]`		the months
Compliance	`mandatory`		This method must be implemented.
Method	getMonthsForYear
Description	Gets the months of the year in order of the calendar.
Parameters	`integer`	`year`	a year
Return	`osid.locale.CalendarUnit[]`		the months
Errors	ILLEGAL_STATE		`year` is greater than `getLastYearBeforeCommonEra()` and less then `getFirstYearInCommonEra()`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getDayName
Description	Gets the display name for a calendar "day."
Return	`osid.locale.DisplayText`		the name
Compliance	`mandatory`		This method must be implemented.
Method	hasVariableDays
Description	Tests if this calendar has a variable number of days in a month.
Return	`boolean`		`true` if the number of days per month varies, `false` if the number of days is constant
Compliance	`mandatory`		This method must be implemented.
Method	getNumDays
Description	Gets the number of days in a year. For a variable day calendar, the number of all defined days are returned. If there are no "days" in this calendar system then this value may be zero. If there are no "months" defined then the number of days is the number of days in a year.
Return	`cardinal`		the number of days
Compliance	`mandatory`		This method must be implemented.
Method	getNumDaysForMonth
Description	Gets the number of days in the given month.
Parameters	`integer`	`year`	a year
Parameters	`cardinal`	`month`	a `DateTime` month code
Return	`cardinal`		the number of days
Errors	ILLEGAL_STATE		`year` is greater than `getLastYearBeforeCommonEra()` and less then `getFirstYearInCommonEra()`, or `month` is greater than `getMonthsForYear(year)`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getDays
Description	Gets the days of the month in order of the calendar. For a variable day calendar, all defined days are returned. If there are no "days" in this time system then this value may be zero. If there are no "months" defined then the number of days applies to the entire year.
Return	`osid.locale.CalendarUnit[]`		the days
Compliance	`mandatory`		This method must be implemented.
Method	getDaysForMonth
Description	Gets the days of the given month in order of the calendar.
Parameters	`integer`	`year`	a year
Parameters	`cardinal`	`month`	a `DateTime` month code
Return	`osid.locale.CalendarUnit[]`		the days
Errors	ILLEGAL_STATE		`year` is greater than `getLastYearBeforeCommonEra()` and less then `getFirstYearInCommonEra()`, or `month` is greater than or equal to than `getMonthsForYear(year)`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getFirstDayOfYear
Description	Gets the first day of the calendar year.
Return	`osid.calendaring.DateTime`		the first day of the year
Compliance	`mandatory`		This method must be implemented.
Method	getEndOfDaysName
Description	Gets the display name for the end of the calendar.
Return	`osid.locale.DisplayText`		the name
Compliance	`mandatory`		This method must be implemented.
Method	getOrigin
Description	Gets the start of the "common era" for this calendar.
Return	`osid.calendaring.DateTime`		start of the calendar
Compliance	`mandatory`		This method must be implemented.
Method	getEndOfDays
Description	Gets the end of the world as specified by this calendar.
Return	`osid.calendaring.DateTime`		end of days
Compliance	`mandatory`		This method must be implemented.
Method	getWeekdays
Description	Gets the days of the week in order of the calendar.
Return	`osid.locale.CalendarUnit[]`		the week days
Compliance	`mandatory`		This method must be implemented.