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

Interface	osid.calendaring.cycle.CyclicTimePeriodSmartCalendarSession
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 `CyclicTimePeriodQuery` can be retrieved from this session and mapped to this `Calendar` to create a virtual collection of `TomePeriods`. The entries may be sequenced using the `CyclicTimePeriodSearchOrder` from this session. This `Calendar` has a default query that matches any cyclic time period and a default search order that specifies no sequencing. The queries may be examined using a `CyclicTimePeriodQueryInspector`. The query may be modified by converting the inspector back to a `CyclicTimePeriodQuery`.
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	getCyclicTimePeriodQuery
Description	Gets a cyclic time period query.
Return	`osid.calendaring.cycle.CyclicTimePeriodQuery`		the cyclic time period query
Compliance	`mandatory`		This method must be implemented.
Method	getCyclicTimePeriodSearchOrder
Description	Gets a cyclic time period search order.
Return	`osid.calendaring.cycle.CyclicTimePeriodSearchOrder`		the cyclic time period search order
Compliance	`mandatory`		This method must be implemented.
Method	applyCyclicTimePeriodQuery
Description	Applies a cyclic time period query to this calendar.
Parameters	`osid.calendaring.cycle.CyclicTimePeriodQuery`	`cyclicTimePeriodQuery`	the cyclic time period query
Errors	NULL_ARGUMENT		`cyclicTimePeriodQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`cyclicTimePeriodQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectCyclicTimePeriodQuery
Description	Gets a cyclic time period query inspector for this calendar.
Return	`osid.calendaring.cycle.CyclicTimePeriodQueryInspector`		the cyclic time period query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyCyclicTimePeriodSequencing
Description	Applies a cyclic time period search order to this calendar.
Parameters	`osid.calendaring.cycle.CyclicTimePeriodSearchOrder`	`cyclicTimePeriodSearchOrder`	the cyclic time period search order
Errors	NULL_ARGUMENT		`cyclicTimePeriodSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`cyclicTimePeriodSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCyclicTimePeriodQueryFromInspector
Description	Gets a cyclic time period query from an inspector.
Parameters	`osid.calendaring.cycle.CyclicTimePeriodQueryInspector`	`cyclicTimePeriodQueryInspector`	a cyclic time period query inspector
Return	`osid.calendaring.cycle.CyclicTimePeriodQuery`		the cyclic time period query interface
Errors	NULL_ARGUMENT		`cyclicTimePeriodQueryInspector` is `null`
Errors	UNSUPPORTED		`cyclicTimePeriodQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.