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

Interface	osid.calendaring.rules.OffsetEventEnablerSmartCalendarSession
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. An `OffsetEventEnablerQuery` can be retrieved from this session and mapped to this `Calendar` to create a virtual collection of offset event enablers. The offset event enablers may be sequenced using the `OffsetEventEnablerSearchOrder` from this session. This `Calendar` has a default query that matches any offset event enabler and a default search order that specifies no sequencing. The queries may be examined using an `OffsetEventEnablerQueryInspector`. The query may be modified by converting the inspector back to an `OffsetEventEnablerQuery`.
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	getOffsetEventEnablerQuery
Description	Gets an offset event enabler query.
Return	`osid.calendaring.rules.OffsetEventEnablerQuery`		the offset event enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getOffsetEventEnablerSearchOrder
Description	Gets an offset event enabler search order.
Return	`osid.calendaring.rules.OffsetEventEnablerSearchOrder`		the offset event enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyOffsetEventEnablerQuery
Description	Applies an offset event enabler query to this calendar.
Parameters	`osid.calendaring.rules.OffsetEventEnablerQuery`	`offsetEventEnablerQuery`	the offset event enabler query
Errors	NULL_ARGUMENT		`offsetEventEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`offsetEventEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectOffsetEventEnablerQuery
Description	Gets an offset event enabler query inspector for this calendar.
Return	`osid.calendaring.rules.OffsetEventEnablerQueryInspector`		the offset 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	applyOffsetEventEnablerSequencing
Description	Applies an offset event enabler search order to this calendar.
Parameters	`osid.calendaring.rules.OffsetEventEnablerSearchOrder`	`offsetEventEnablerSearchOrder`	the offset event enabler search order
Errors	NULL_ARGUMENT		`offsetEventEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`offsetEventEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getOffsetEventEnablerQueryFromInspector
Description	Gets an offset event enabler query from an inspector.
Parameters	`osid.calendaring.rules.OffsetEventEnablerQueryInspector`	`offsetEventEnablerQueryInspector`	an offset event enabler query inspector
Return	`osid.calendaring.rules.OffsetEventEnablerQuery`		the offset event enabler query
Errors	NULL_ARGUMENT		`offsetEventEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`offsetEventEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.