OSID - osid.calendaring.ScheduleSlotSmartCalendarSession Service Interface Definition

Interface	osid.calendaring.ScheduleSlotSmartCalendarSession
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 `ScheduleSlotQuery` can be retrieved from this session and mapped to this `Calendar` to create a virtual collection of `ScheduleSlots`. The entries may be sequenced using the `ScheduleSlotSearchOrder` from this session. This `Calendar` has a default query that matches any schedule slot and a default search order that specifies no sequencing. The queries may be examined using a `ScheduleSlotQueryInspector`. The query may be modified by converting the inspector back to a `ScheduleSlotQuery`.
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	getScheduleSlotQuery
Description	Gets a schedule slot query.
Return	`osid.calendaring.ScheduleSlotQuery`		the schedule slot query
Compliance	`mandatory`		This method must be implemented.
Method	getScheduleSlotSearchOrder
Description	Gets a schedule slot search order.
Return	`osid.calendaring.ScheduleSlotSearchOrder`		the schedule slot search order
Compliance	`mandatory`		This method must be implemented.
Method	applyScheduleSlotQuery
Description	Applies a schedule slot query to this calendar.
Parameters	`osid.calendaring.ScheduleSlotQuery`	`scheduleSlotQuery`	the schedule slot query
Errors	NULL_ARGUMENT		`scheduleSlotQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`scheduleSlotQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectScheduleSlotQuery
Description	Gets a schedule slot query inspector for this calendar.
Return	`osid.calendaring.ScheduleSlotQueryInspector`		the schedule slot query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyScheduleSlotSequencing
Description	Applies a schedule slot search order to this calendar.
Parameters	`osid.calendaring.ScheduleSlotSearchOrder`	`scheduleSlotSearchOrder`	the schedule slot search order
Errors	NULL_ARGUMENT		`scheduleSlotSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`scheduleSlotSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getScheduleSlotQueryFromInspector
Description	Gets a schedule slot query from an inspector.
Parameters	`osid.calendaring.ScheduleSlotQueryInspector`	`scheduleSlotQueryInspector`	a schedule slot query inspector
Return	`osid.calendaring.ScheduleSlotQuery`		the schedule slot query
Errors	NULL_ARGUMENT		`scheduleSlotQueryInspector` is `null`
Errors	UNSUPPORTED		`scheduleSlotQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.