OSID - osid.calendaring.ScheduleQuerySession Service Interface Definition

Interface	osid.calendaring.ScheduleQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.calendaring.ScheduleSearchSession`
Used By	`osid.calendaring.CalendaringManager`
Used By	`osid.calendaring.CalendaringProxyManager`
Description	This session provides methods for searching `Schedule` objects. The search query is constructed using the `ScheduleQuery`. The schedule record `Type` also specifies the record for the schedule query. This session defines views that offer differing behaviors for searching. federated calendar view: searches include schedules in calendars of which this calendar is an ancestor in the calendar hierarchy isolated calendar view: searches are restricted to schedules in this calendar Schedules may have a query record indicated by their respective record types. The query record is accessed via the `ScheduleQuery`.
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	canSearchSchedules
Description	Tests if this user can perform `Schedules` 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 schedules 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	getScheduleQuery
Description	Gets a schedule query.
Return	`osid.calendaring.ScheduleQuery`		the schedule query
Compliance	`mandatory`		This method must be implemented.
Method	getSchedulesByQuery
Description	Gets a list of `Schedules` matching the given schedle query.
Parameters	`osid.calendaring.ScheduleQuery`	`scheduleQuery`	the schedule query
Return	`osid.calendaring.ScheduleList`		the returned `ScheduleList`
Errors	NULL_ARGUMENT		`scheduleQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`scheduleQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.