OSID - osid.calendaring.EventSmartCalendarSession Service Interface Definition

Interface	osid.calendaring.EventSmartCalendarSession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. An `EventQuery` can be retrieved from this session and mapped to this `Calendar` to create a virtual collection of `Events.` The entries may be sequenced using the `EventSearchOrder` 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 an `EventQueryInspector.` The query may be modified by converting the inspector back to an `EventQuery.`
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	getEventQuery
Description	Gets an event query.
Return	`osid.calendaring.EventQuery`		the event query
Compliance	`mandatory`		This method must be implemented.
Method	getEventSearchOrder
Description	Gets an event search order.
Return	`osid.calendaring.EventSearchOrder`		the event search order
Compliance	`mandatory`		This method must be implemented.
Method	applyEventQuery
Description	Applies an event query to this calendar.
Parameters	`osid.calendaring.EventQuery`	`eventQuery`	the event query
Errors	NULL_ARGUMENT		`eventQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`eventQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectEventQuery
Description	Gets an event query inspector for this calendar.
Return	`osid.calendaring.EventQueryInspector`		the 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 an event search order to this calendar.
Parameters	`osid.calendaring.EventSearchOrder`	`eventSearchOrder`	the event search order
Errors	NULL_ARGUMENT		`eventSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`eventSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getEventQueryFromInspector
Description	Gets an event query from an inspector.
Parameters	`osid.calendaring.EventQueryInspector`	`eventQueryInspector`	an event query inspector
Return	`osid.calendaring.EventQuery`		the event query
Errors	NULL_ARGUMENT		`eventQueryInspector` is `null`
Errors	UNSUPPORTED		`eventQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.