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

Interface	osid.calendaring.cycle.CyclicEventQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.calendaring.cycle.CyclicEventSearchSession`
Used By	`osid.calendaring.cycle.CalendaringCycleManager`
Used By	`osid.calendaring.cycle.CalendaringCycleProxyManager`
Description	This session provides methods for searching `CyclicEvents`. The search query is constructed using the `CyclicEventQuery`. The cyclic event record `Type` also specifies the record for the cyclic event query. This session defines views that offer differing behaviors for searching. federated calendar view: searches include cyclic events in calendars of which this calendar is an ancestor in the calendar hierarchy isolated calendar view: searches are restricted to events in this calendar Cyclic events may have a query record indicated by their respective record types. The query record is accessed via the `CyclicEventQuery`.
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	canSearchCyclicEvents
Description	Tests if this user can perform `CyclicEvent` 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 events 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	getCyclicEventQuery
Description	Gets a cyclic event query.
Return	`osid.calendaring.cycle.CyclicEventQuery`		the cyclic event query
Compliance	`mandatory`		This method must be implemented.
Method	getCyclicEventsByQuery
Description	Gets a list of `CyclicEvents` matching the given cyclic event query.
Parameters	`osid.calendaring.cycle.CyclicEventQuery`	`cyclicEventQuery`	the cyclic event query
Return	`osid.calendaring.cycle.CyclicEventList`		the returned `EventList`
Errors	NULL_ARGUMENT		`cyclicEventQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`cyclicEventQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.