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

Interface	osid.calendaring.cycle.CyclicTimePeriodQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.calendaring.cycle.CyclicTimePeriodSearchSession`
Used By	`osid.calendaring.cycle.CalendaringCycleManager`
Used By	`osid.calendaring.cycle.CalendaringCycleProxyManager`
Description	This session provides methods for searching `CyclicTimePeriods`. The search query is constructed using the `CyclicTimePeriodQuery`. The cyclic time period record `Type` also specifies the record for the cyclic time period query. Cyclic time periods may have a query record indicated by their respective record types. The query record is accessed via the `CyclicTimePeriodQuery`.
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	canSearchCyclicTimePeriods
Description	Tests if this user can perform `CyclicTimePeriod` searches. 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 search operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method 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 searches to this calendar only.
Compliance	`mandatory`		This method is must be implemented.
Method	getCyclicTimePeriodQuery
Description	Gets a cyclic time period query.
Return	`osid.calendaring.cycle.CyclicTimePeriodQuery`		the cyclic time period query
Compliance	`mandatory`		This method must be implemented.
Method	getCyclicTimePeriodsByQuery
Description	Gets a list of `CyclicTimePeriods` matching the given query.
Parameters	`osid.calendaring.cycle.CyclicTimePeriodQuery`	`cyclicTimePeriodQuery`	the cyclic time period query
Return	`osid.calendaring.cycle.CyclicTimePeriodList`		the returned `CyclicTimePeriodList`
Errors	NULL_ARGUMENT		`cyclicTimePeriodQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`cyclicTimePeriodQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.