OSID - osid.calendaring.EventQuerySession Service Interface Definition

Interface	osid.calendaring.EventQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.calendaring.EventSearchSession`
Used By	`osid.calendaring.CalendaringManager`
Used By	`osid.calendaring.CalendaringProxyManager`
Description	This session provides methods for searching `Event` objects. The search query is constructed using the `EventQuery`. The event record `Type` also specifies the record for the event query. This session defines views that offer differing behaviors for searching. federated calendar view: searches include 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 denormalized event view: recurring events are expanded into a series of non-recurring events normalized event view: a series of recurring events is represented by a single `Event` sequestered event viiew: All event methods suppress sequestered events. unsequestered event view: All event methods return all events. Events may have a query record indicated by their respective record types. The query record is accessed via the `EventQuery`.
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	canSearchEvents
Description	Tests if this user can perform `Events` 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 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	useNormalizedEventView
Description	A normalized view uses a single `Event` to represent a set of recurring events.
Compliance	`mandatory`		This method is must be implemented.
Method	useDenormalizedEventView
Description	A denormalized view expands recurring events into a series of `Events`.
Compliance	`mandatory`		This method is must be implemented.
Method	useSequesteredEventView
Description	The returns from the search methods omit sequestered events.
Compliance	`mandatory`		This method is must be implemented.
Method	useUnsequesteredEventView
Description	All replies are returned including sequestered events.
Compliance	`mandatory`		This method is must be implemented.
Method	getEventQuery
Description	Gets an event query.
Return	`osid.calendaring.EventQuery`		the event query
Compliance	`mandatory`		This method must be implemented.
Method	getEventsByQuery
Description	Gets a list of `Events` matching the given event query.
Parameters	`osid.calendaring.EventQuery`	`eventQuery`	the event query
Return	`osid.calendaring.EventList`		the returned `EventList`
Errors	NULL_ARGUMENT		`eventQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`eventQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.