OSID - osid.calendaring.cycle.CyclicEventSmartCalendarSession Service Interface Definition

Interface	osid.calendaring.cycle.CyclicEventSmartCalendarSession
Implements	`osid.OsidSession`
Used By	`osid.calendaring.cycle.CalendaringCycleManager`
Used By	`osid.calendaring.cycle.CalendaringCycleProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `CyclicEventQuery` can be retrieved from this session and mapped to this `Calendar` to create a virtual collection of `CyclicEvents`. The entries may be sequenced using the `CyclicEventSearchOrder` from this session. This `Calendar` has a default query that matches any event and a default search order that specifies no sequencing. The queries may be examined using a `CyclicEventQueryInspector`. The query may be modified by converting the inspector back to a `CyclicEventQuery`.
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	getCyclicEventQuery
Description	Gets a cyclic event query.
Return	`osid.calendaring.cycle.CyclicEventQuery`		the cyclic event query
Compliance	`mandatory`		This method must be implemented.
Method	getCyclicEventSearchOrder
Description	Gets a cyclic event search order.
Return	`osid.calendaring.cycle.CyclicEventSearchOrder`		the cyclic event search order
Compliance	`mandatory`		This method must be implemented.
Method	applyEventQuery
Description	Applies a cyclic event query to this calendar.
Parameters	`osid.calendaring.cycle.CyclicEventQuery`	`cyclicEventQuery`	the cyclic event query
Errors	NULL_ARGUMENT		`cyclicEventQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`cyclicEventQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectEventQuery
Description	Gets a cyclic event query inspector for this calendar.
Return	`osid.calendaring.cycle.CyclicEventQueryInspector`		the cyclic event query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyEventSequencing
Description	Applies a cyclic event search order to this calendar.
Parameters	`osid.calendaring.cycle.CyclicEventSearchOrder`	`cyclicEventSearchOrder`	the cyclic event search order
Errors	NULL_ARGUMENT		`cyclicEventSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`cyclicEventSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCyclicEventQueryFromInspector
Description	Gets a cyclic event query from an inspector.
Parameters	`osid.calendaring.cycle.CyclicEventQueryInspector`	`cyclicEventQueryInspector`	a cyclic event query inspector
Return	`osid.calendaring.cycle.CyclicEventQuery`		the cyclic event query
Errors	NULL_ARGUMENT		`cyclicEventQueryInspector` is `null`
Errors	UNSUPPORTED		`cyclicEventQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.