OSID - osid.calendaring.TimePeriodLookupSession Service Interface Definition

Interface	osid.calendaring.TimePeriodLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `TimePeriod` objects. The `TimePeriod` represents a period of time in which to manage recurring events. This session defines views that offer differing behaviors when retrieving multiple objects. comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition isolated calendar view: All time period methods in this session operate, retrieve and pertain to time periods defined explicitly in the current calendar. Using an isolated view is useful for managing time periods with the `TimePeriodAdminSession.` federated calendar view: All time period methods in this session operate, retrieve and pertain to all time periods defined in this calendar and any other calendars implicitly available in this calendar through calendar inheritence. Time periods may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the `TimePeriod.`
Method	getCalendarId
Description	Gets the `Calendar` `Id` associated with this session.
Return	`osid.id.Id`		the `Calendar Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCalendar
Description	Gets the `Calendar` associated with this session.
Return	`osid.calendaring.Calendar`		the `Calendar` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupTimePeriods
Description	Tests if this user can perform `TimePeriod` lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeTimePeriodView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryTimePeriodView
Description	A complete view of the `TimePeriod` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	useFederatedCalendarView
Description	Federates the view for methods in this session. A federated view will include time periods in calendars which are children of this calendar in the calendar hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCalendarView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this calendar only.
Compliance	`mandatory`		This method is must be implemented.
Method	getTimePeriod
Description	Gets the `TimePeriod` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `TimePeriod` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `TimePeriod` and retained for compatibility.
Parameters	`osid.id.Id`	`timePeriodId`	`Id` of the `TimePeriod`
Return	`osid.calendaring.TimePeriod`		the time period
Errors	NOT_FOUND		`timePeriodId` not found
	NULL_ARGUMENT		`timePeriodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getTimePeriodsByIds
Description	Gets a `TimePeriodList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the time periods specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `TimePeriods` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`timePeriodIds`	the list of `Ids` to retrieve
Return	`osid.calendaring.TimePeriodList`		the returned `TimePeriod` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`rimePeriodIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTimePeriodsByGenusType
Description	Gets a `TimePeriodList` corresponding to the given time period genus `Type` which does not include time periods of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known time periods or an error results. Otherwise, the returned list may contain only those time periods that are accessible through this session.
Parameters	`osid.type.Type`	`timePeriodGenusType`	a time period genus type
Return	`osid.calendaring.TimePeriodList`		the returned `TimePeriod` list
Errors	NULL_ARGUMENT		`timePeriodGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTimePeriodsByParentGenusType
Description	Gets a `TimePeriodList` corresponding to the given time period genus `Type` and include any additional time periods with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known time periods or an error results. Otherwise, the returned list may contain only those time periods that are accessible through this session.
Parameters	`osid.type.Type`	`timePeriodGenusType`	a time period genus type
Return	`osid.calendaring.TimePeriodList`		the returned `TimePeriod` list
Errors	NULL_ARGUMENT		`timePeriodGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTimePeriodsByRecordType
Description	Gets a `TimePeriodList` containing the given time period record `Type.` In plenary mode, the returned list contains all known time periods or an error results. Otherwise, the returned list may contain only those time periods that are accessible through this session.
Parameters	`osid.type.Type`	`timePeriodRecordType`	a time period record type
Return	`osid.calendaring.TimePeriodList`		the returned `TimePeriod` list
Errors	NULL_ARGUMENT		`timePeriodRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTimePeriodsByDate
Description	Gets a `TimePeriodList` containing the given `DateTime.` Time periods containing the given date are matched. In plenary mode, the returned list contains all of the time periods specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `TimePeriods` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.calendaring.DateTime`	`datetime`	a date
Return	`osid.calendaring.TimePeriodList`		the returned `TimePeriod` list
Errors	NULL_ARGUMENT		`datetime` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTimePeriodsInDateRange
Description	Gets a `TimePeriodList` corresponding to the given `DateTime.` Time periods whose start end end times are included in the given date range are matched.In plenary mode, the returned list contains all of the time periods specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `TimePeriods` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.calendaring.DateTime`	`start`	start of daterange
Parameters	`osid.calendaring.DateTime`	`end`	end of date range
Return	`osid.calendaring.TimePeriodList`		the returned `TimePeriod` list
Errors	INVALID_ARGUMENT		`end` is less than `start`
	NULL_ARGUMENT		`start` or `end` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTimePeriods
Description	Gets all `TimePeriods.` In plenary mode, the returned list contains all known time periods or an error results. Otherwise, the returned list may contain only those time periods that are accessible through this session.
Return	`osid.calendaring.TimePeriodList`		a `TimePeriodList`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.