OSID - osid.calendaring.SupersedingEventSmartCalendarSession Service Interface Definition

Interface	osid.calendaring.SupersedingEventSmartCalendarSession
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 `SupersedingEventQuery` can be retrieved from this session and mapped to this `Calendar` to create a virtual collection of `SupersedingEvents`. The entries may be sequenced using the `SupersedingEventSearchOrder` from this session. This `Calendar` has a default query that matches any superseding event and a default search order that specifies no sequencing. The queries may be examined using a `SupersedingEventQueryInspector`. The query may be modified by converting the inspector back to a `SupersedingEventQuery`.
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	getSupersedingEventQuery
Description	Gets a superseding event query.
Return	`osid.calendaring.SupersedingEventQuery`		the superseding event query
Compliance	`mandatory`		This method must be implemented.
Method	getSupersedingEventSearchOrder
Description	Gets a superseding event search order.
Return	`osid.calendaring.SupersedingEventSearchOrder`		the superseding event search order
Compliance	`mandatory`		This method must be implemented.
Method	applySupersedingEventQuery
Description	Applies a superseding event query to this calendar.
Parameters	`osid.calendaring.SupersedingEventQuery`	`supersedingEventQuery`	the superseding event query
Errors	NULL_ARGUMENT		`supersedingEventQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`supersedingEventQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectSupersedingEventQuery
Description	Gets a superseding event query inspector for this calendar.
Return	`osid.calendaring.SupersedingEventQueryInspector`		the superseding event query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applySupersedingEventSequencing
Description	Applies a superseding event search order to this calendar.
Parameters	`osid.calendaring.SupersedingEventSearchOrder`	`supersedingEventSearchOrder`	the superseding event search order
Errors	NULL_ARGUMENT		`supersedingEventSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`supersedingEventSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getSupersedingEventQueryFromInspector
Description	Gets a superseding event query from an inspector.
Parameters	`osid.calendaring.SupersedingEventQueryInspector`	`supersedingEventQueryInspector`	a superseding event query inspector
Return	`osid.calendaring.SupersedingEventQuery`		the superseding event query
Errors	NULL_ARGUMENT		`supersedingEventQueryInspector` is `null`
Errors	UNSUPPORTED		`supersedingEventQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.