OSID - osid.calendaring.ScheduleSmartCalendarSession Service Interface Definition

Interface	osid.calendaring.ScheduleSmartCalendarSession
Implements	`osid.OsidSession`
Used By	`osid.calendaring.CalendaringManager`
Used By	`osid.calendaring.CalendaringProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `ScheduleQuery` can be retrieved from this session and mapped to this `Calendar` to create a virtual collection of `Schedules`. The entries may be sequenced using the `ScheduleSearchOrder` from this session. This `Calendar` has a default query that matches any schedule and a default search order that specifies no sequencing. The queries may be examined using a `ScheduleQueryInspector`. The query may be modified by converting the inspector back to a `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	canManageSmartCalendars
Description	Tests if this user can manage smart calendars. 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 smart operations.
Return	`boolean`		`false` if smart calendar methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method 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	getScheduleSearchOrder
Description	Gets a schedule search order.
Return	`osid.calendaring.ScheduleSearchOrder`		the schedule search order
Compliance	`mandatory`		This method must be implemented.
Method	applyScheduleQuery
Description	Applies a schedule query to this calendar.
Parameters	`osid.calendaring.ScheduleQuery`	`scheduleQuery`	the schedule query
Errors	NULL_ARGUMENT		`scheduleQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`scheduleQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectScheduleQuery
Description	Gets a schedule query inspector for this calendar.
Return	`osid.calendaring.ScheduleQueryInspector`		the schedule query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyScheduleSequencing
Description	Applies a schedule search order to this calendar.
Parameters	`osid.calendaring.ScheduleSearchOrder`	`scheduleSearchOrder`	the schedule search order
Errors	NULL_ARGUMENT		`scheduleSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`scheduleSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getScheduleQueryFromInspector
Description	Gets a schedule query from an inspector.
Parameters	`osid.calendaring.ScheduleQueryInspector`	`scheduleQueryInspector`	a schedule query inspector
Return	`osid.calendaring.ScheduleQuery`		the schedule query
Errors	NULL_ARGUMENT		`scheduleQueryInspector` is `null`
Errors	UNSUPPORTED		`scheduleQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.