OSID - osid.calendaring.TimePeriodSmartCalendarSession Service Interface Definition

Interface	osid.calendaring.TimePeriodSmartCalendarSession
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 `TimePeriodQuery` 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 `TimePeriodSearchOrder` from this session. This `Calendar` has a default query that matches any time period and a default search order that specifies no sequencing. The queries may be examined using a `TimePeriodQueryInspector`. The query may be modified by converting the inspector back to a `TimePeriodQuery`.
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	getTimePeriodQuery
Description	Gets a time period query.
Return	`osid.calendaring.TimePeriodQuery`		the time period query
Compliance	`mandatory`		This method must be implemented.
Method	getTimePeriodSearchOrder
Description	Gets a time period search order.
Return	`osid.calendaring.TimePeriodSearchOrder`		the time period search order
Compliance	`mandatory`		This method must be implemented.
Method	applyTimePeriodQuery
Description	Applies a time period query to this calendar.
Parameters	`osid.calendaring.TimePeriodQuery`	`timePeriodQuery`	the time period query
Errors	NULL_ARGUMENT		`timePeriodQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`timePeriodQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectTimePeriodQuery
Description	Gets a time period query inspector for this calendar.
Return	`osid.calendaring.TimePeriodQueryInspector`		the 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	applyTimePeriodSequencing
Description	Applies a time period search order to this calendar.
Parameters	`osid.calendaring.TimePeriodSearchOrder`	`timePeriodSearchOrder`	the time period search order
Errors	NULL_ARGUMENT		`timePeriodSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`timePeriodSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getTimePeriodQueryFromInspector
Description	Gets a time period query from an inspector.
Parameters	`osid.calendaring.TimePeriodQueryInspector`	`timePeriodQueryInspector`	a time period query inspector
Return	`osid.calendaring.TimePeriodQuery`		the time period query interface
Errors	NULL_ARGUMENT		`timePeriodQueryInspector` is `null`
Errors	UNSUPPORTED		`timePeriodQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.