OSID - osid.calendaring.CommitmentSmartCalendarSession Service Interface Definition

Interface	osid.calendaring.CommitmentSmartCalendarSession
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 `CommitmentQuery` can be retrieved from this session and mapped to this `Calendar` to create a virtual collection of `Commitments`. The entries may be sequenced using the `CommitmentSearchOrder` from this session. This `Calendar` has a default query that matches any commitment and a default search order that specifies no sequencing. The queries may be examined using a `CommitmentQueryInspector`. The query may be modified by converting the inspector back to a `CommitmentQuery`.
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	getCommitmentQuery
Description	Gets a commitment query.
Return	`osid.calendaring.CommitmentQuery`		the commitment query
Compliance	`mandatory`		This method must be implemented.
Method	getCommitmentSearchOrder
Description	Gets a commitment search order.
Return	`osid.calendaring.CommitmentSearchOrder`		the commitment search order
Compliance	`mandatory`		This method must be implemented.
Method	applyCommitmentQuery
Description	Applies a commitment query to this calendar.
Parameters	`osid.calendaring.CommitmentQuery`	`commitmentQuery`	the commitment query
Errors	NULL_ARGUMENT		`commitmentQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`commitmentQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectCommitmentQuery
Description	Gets a commitment query inspector for this calendar.
Return	`osid.calendaring.CommitmentQueryInspector`		the commitment query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyCommitmentSequencing
Description	Applies a commitment search order to this calendar.
Parameters	`osid.calendaring.CommitmentSearchOrder`	`commitmentSearchOrder`	the commitment search order
Errors	NULL_ARGUMENT		`commitmentSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`commitmentSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCommitmentQueryFromInspector
Description	Gets a commitment query from an inspector.
Parameters	`osid.calendaring.CommitmentQueryInspector`	`commitmentQueryInspector`	a commitment query inspector
Return	`osid.calendaring.CommitmentQuery`		the commitment query
Errors	NULL_ARGUMENT		`commitmentQueryInspector` is `null`
Errors	UNSUPPORTED		`commitmentQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.