OSID - osid.calendaring.RecurringEventSmartCalendarSession Service Interface Definition

Interface	osid.calendaring.RecurringEventSmartCalendarSession
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 `RecurringEventQuery` can be retrieved from this session and mapped to this `Calendar` to create a virtual collection of `RecurringEvents`. The entries may be sequenced using the `RecurringEventSearchOrder` from this session. This `Calendar` has a default query that matches any recurring event and a default search order that specifies no sequencing. The queries may be examined using a `RecurringEventQueryInspector`. The query may be modified by converting the inspector back to a `RecurringEventQuery`.
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	getRecurringEventQuery
Description	Gets a recurring event query.
Return	`osid.calendaring.RecurringEventQuery`		the recurring event query
Compliance	`mandatory`		This method must be implemented.
Method	getRecurringEventSearchOrder
Description	Gets a recurring event search order.
Return	`osid.calendaring.RecurringEventSearchOrder`		the recurring event search order
Compliance	`mandatory`		This method must be implemented.
Method	applyRecurringEventQuery
Description	Applies a recurring event query to this calendar.
Parameters	`osid.calendaring.RecurringEventQuery`	`recurringEventQuery`	the recurring event query
Errors	NULL_ARGUMENT		`recurringEventQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`recurringEventQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectRecurringEventQuery
Description	Gets a recurring event query inspector for this calendar.
Return	`osid.calendaring.RecurringEventQueryInspector`		the recruring event query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyRecurringEventSequencing
Description	Applies a recurring event search order to this calendar.
Parameters	`osid.calendaring.RecurringEventSearchOrder`	`recurringEventSearchOrder`	the recurring event search order
Errors	NULL_ARGUMENT		`recurringEventSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`recurringEventSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRecurringEventQueryFromInspector
Description	Gets a recurring event query from an inspector.
Parameters	`osid.calendaring.RecurringEventQueryInspector`	`recurringEventQueryInspector`	a recurring event query inspector
Return	`osid.calendaring.RecurringEventQuery`		the recurring event query
Errors	NULL_ARGUMENT		`recruringEventQueryInspector` is `null`
Errors	UNSUPPORTED		`recurringEventQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.