OSID - osid.calendaring.rules.SupersedingEventEnablerSmartCalendarSession Service Interface Definition

Interface	osid.calendaring.rules.SupersedingEventEnablerSmartCalendarSession
Implements	`osid.OsidSession`
Used By	`osid.calendaring.rules.CalendaringRulesManager`
Used By	`osid.calendaring.rules.CalendaringRulesProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic calendars. A `SupersedingEventEnablerQuery` can be retrieved from this session and mapped to this `Calendar` to create a virtual collection of superseding event enablers. The superseding event enablers may be sequenced using the `SupersedingEventEnablerSearchOrder` from this session. This `Calendar` has a default query that matches any superseding event enabler and a default search order that specifies no sequencing. The queries may be examined using a `SupersedingEventEnablerQueryInspector`. The query may be modified by converting the inspector back to a `SupersedingEventEnablerQuery`.
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
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 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 operations to unauthorized users.
Return	`boolean`		`false` if smart calendar management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSupersedingEventEnablerQuery
Description	Gets a superseding event enabler query.
Return	`osid.calendaring.rules.SupersedingEventEnablerQuery`		the superseding event enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getSupersedingEventEnablerSearchOrder
Description	Gets a superseding event enabler search order.
Return	`osid.calendaring.rules.SupersedingEventEnablerSearchOrder`		the superseding event enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applySupersedingEventEnablerQuery
Description	Applies a superseding event enabler query to this calendar.
Parameters	`osid.calendaring.rules.SupersedingEventEnablerQuery`	`calendarEnablerQuery`	the superseding event enabler query
Errors	NULL_ARGUMENT		`calendarEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`calendarEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectSupersedingEventEnablerQuery
Description	Gets a superseding event enabler query inspector for this calendar.
Return	`osid.calendaring.rules.SupersedingEventEnablerQueryInspector`		the superseding event enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applySupersedingEventEnablerSequencing
Description	Applies a superseding event enabler search order to this calendar.
Parameters	`osid.calendaring.rules.SupersedingEventEnablerSearchOrder`	`calendarEnablerSearchOrder`	the superseding event enabler search order
Errors	NULL_ARGUMENT		`calendarEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`calendarEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getSupersedingEventEnablerQueryFromInspector
Description	Gets a superseding event enabler query from an inspector.
Parameters	`osid.calendaring.rules.SupersedingEventEnablerQueryInspector`	`calendarEnablerQueryInspector`	a superseding event enabler query inspector
Return	`osid.calendaring.rules.SupersedingEventEnablerQuery`		the superseding event enabler query
Errors	NULL_ARGUMENT		`calendarEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`calendarEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.