OSID - osid.calendaring.cycle.TimePeriodCyclicTimePeriodLookupSession Service Interface Definition

Interface	osid.calendaring.cycle.TimePeriodCyclicTimePeriodLookupSession
Implements	`osid.OsidSession`
Used By	`osid.calendaring.cycle.CalendaringCycleManager`
Used By	`osid.calendaring.cycle.CalendaringCycleProxyManager`
Description	This session provides methods to retrieve `CyclicTimePeriod` to `TimePeriod` mappings. A `TimePeriod` may be mapped to multiple `CyclicTimePeriods` explicitly or through a rule-based generation. This lookup session defines two views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated calendar view: All cyclic time period methods in this session operate, retrieve and pertain to cyclic time periods defined explicitly in the current calendar. federated calendar view: All cyclic time period methods in this session operate, retrieve and pertain to all cyclic time periods defined in this calendar and any other calendars implicitly available in this calendar through calendar inheritence.
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	canLookupTimePeriodCyclicTimePeriodMappings
Description	Tests if this user can perform lookups of tiem period/cyclic time period mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeCalendarView
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	usePlenaryCalendarView
Description	A complete view of the `CyclicTimePeriod` and `TmePeriod` 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 cyclic 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	getTimePeriodIdsByCyclicTimePeriod
Description	Gets the list of `TimePeriod` `Ids` associated with a `CyclicTimePeriod`.
Parameters	`osid.id.Id`	`cyclicTimePeriodId`	`Id` of the `CyclicTimePeriod`
Return	`osid.id.IdList`		list of related time period `Ids`
Errors	NOT_FOUND		`cyclicTimePeriodId` is not found
	NULL_ARGUMENT		`cyclicTimePeriodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTimePeriodsByCyclicTimePeriod
Description	Gets the list of `TimePeriods` associated with a `CyclicTimePeriod`.
Parameters	`osid.id.Id`	`cyclicTimePeriodId`	`Id` of the `CyclicTimePeriod`
Return	`osid.calendaring.TimePeriodList`		list of related time periods
Errors	NOT_FOUND		`cyclicTimePeriodId` is not found
	NULL_ARGUMENT		`cyclicTimePeriodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTimePeriodIdsByCyclicTimePeriodAndDate
Description	Gets the list of `TimePeriod` `Ids` between the given date range included associated with a `CyclicTimePeriod`.
Parameters	`osid.id.Id`	`cyclicTimePeriodId`	`Id` of the `CyclicTimePeriod`
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.id.IdList`		list of related time period `Ids`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NOT_FOUND		`cyclicTimePeriodId` is not found
	NULL_ARGUMENT		`cyclicTimePeriodId, from`, or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTimePeriodsByCyclicTimePeriodAndDate
Description	Gets the list of `TimePeriods` between the given date range included associated with a `CyclicTimePeriod`.
Parameters	`osid.id.Id`	`cyclicTimePeriodId`	`Id` of the `CyclicTimePeriod`
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.calendaring.TimePeriodList`		list of related cyclic time periods
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NOT_FOUND		`cyclicTimePeriodId` is not found
	NULL_ARGUMENT		`cyclicTimePeriodId, from`, or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCyclicTimePeriodIdsByTimePeriod
Description	Gets the list of `CyclicTimePeriodIds` mapped to a `TimePeriod`.
Parameters	`osid.id.Id`	`timePeriodId`	`Id` of a `TimePeriod`
Return	`osid.id.IdList`		list of cyclic time period `Ids`
Errors	NOT_FOUND		`timePeriodId` is not found
	NULL_ARGUMENT		`timePeriodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCyclicTimePeriodsByTimePeriod
Description	Gets the list of `CyclicTimePeriods` mapped to a `TimePeriod`.
Parameters	`osid.id.Id`	`timePeriodId`	`Id` of a `TimePeriod`
Return	`osid.calendaring.cycle.CyclicTimePeriodList`		list of cyclic time periods
Errors	NOT_FOUND		`timePeriodId` is not found
	NULL_ARGUMENT		`timePeriodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.