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

Interface	osid.calendaring.rules.RecurringEventEnablerSmartCalendarSession
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 `RecurringEventEnablerQuery` can be retrieved from this session and mapped to this `Calendar` to create a virtual collection of recurring event enablers. The recurring event enablers may be sequenced using the `RecurringEventEnablerSearchOrder` from this session. This `Calendar` has a default query that matches any recurring event enabler and a default search order that specifies no sequencing. The queries may be examined using a `RecurringEventEnablerQueryInspector`. The query may be modified by converting the inspector back to a `RecurringEventEnablerQuery`.
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	getRecurringEventEnablerQuery
Description	Gets a recurring event enabler query.
Return	`osid.calendaring.rules.RecurringEventEnablerQuery`		the recurring event enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getRecurringEventEnablerSearchOrder
Description	Gets a recurring event enabler search order.
Return	`osid.calendaring.rules.RecurringEventEnablerSearchOrder`		the recurring event enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyRecurringEventEnablerQuery
Description	Applies a recurring event enabler query to this calendar.
Parameters	`osid.calendaring.rules.RecurringEventEnablerQuery`	`recurringEventEnablerQuery`	the recurring event enabler query
Errors	NULL_ARGUMENT		`recurringEventEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`recurringEventEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectRecurringEventEnablerQuery
Description	Gets a recurring event enabler query inspector for this calendar.
Return	`osid.calendaring.rules.RecurringEventEnablerQueryInspector`		the recurring 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	applyRecurringEventEnablerSequencing
Description	Applies a recurring event enabler search order to this calendar.
Parameters	`osid.calendaring.rules.RecurringEventEnablerSearchOrder`	`recurringEventEnablerSearchOrder`	the recurring event enabler search order
Errors	NULL_ARGUMENT		`recurringEventEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`recurringEventEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRecurringEventEnablerQueryFromInspector
Description	Gets a recurring event enabler query from an inspector.
Parameters	`osid.calendaring.rules.RecurringEventEnablerQueryInspector`	`recurringEventEnablerQueryInspector`	a recurring event enabler query inspector
Return	`osid.calendaring.rules.RecurringEventEnablerQuery`		the recurring event enabler query
Errors	NULL_ARGUMENT		`recurringEventEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`recurringEventEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.