OSID - osid.calendaring.rules.CommitmentEnablerSmartCalendarSession Service Interface Definition

Interface	osid.calendaring.rules.CommitmentEnablerSmartCalendarSession
Implements	`osid.OsidSession`
Used By	`osid.calendaring.rules.CalendaringRulesManager`
Used By	`osid.calendaring.rules.CalendaringRulesProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic calendars. A `CommitmentEnablerQuery` can be retrieved from this session and mapped to this `Calendar` to create a virtual collection of commitment enablers. The commitment enablers may be sequenced using the `CommitmentEnablerSearchOrder` from this session. This `Calendar` has a default query that matches any commitment enabler and a default search order that specifies no sequencing. The queries may be examined using a `CommitmentEnablerQueryInspector`. The query may be modified by converting the inspector back to a `CommitmentEnablerQuery`.
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
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 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 operations to unauthorized users.
Return	`boolean`		`false` if smart calendar management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCommitmentEnablerQuery
Description	Gets a commitment enabler query.
Return	`osid.calendaring.rules.CommitmentEnablerQuery`		the commitment enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getCommitmentEnablerSearchOrder
Description	Gets a commitment enabler search order.
Return	`osid.calendaring.rules.CommitmentEnablerSearchOrder`		the commitment enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyCommitmentEnablerQuery
Description	Applies a commitment enabler query to this calendar.
Parameters	`osid.calendaring.rules.CommitmentEnablerQuery`	`commitmentEnablerQuery`	the commitment enabler query
Errors	NULL_ARGUMENT		`commitmentEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`commitmentEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectCommitmentEnablerQuery
Description	Gets a commitment enabler query inspector for this calendar.
Return	`osid.calendaring.rules.CommitmentEnablerQueryInspector`		the commitment enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyCommitmentEnablerSequencing
Description	Applies a commitment enabler search order to this calendar.
Parameters	`osid.calendaring.rules.CommitmentEnablerSearchOrder`	`commitmentEnablerSearchOrder`	the commitment enabler search order
Errors	NULL_ARGUMENT		`commitmentEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`commitmentEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCommitmentEnablerQueryFromInspector
Description	Gets a commitment enabler query from an inspector.
Parameters	`osid.calendaring.rules.CommitmentEnablerQueryInspector`	`commitmentEnablerQueryInspector`	a commitment enabler query inspector
Return	`osid.calendaring.rules.CommitmentEnablerQuery`		the commitment enabler query
Errors	NULL_ARGUMENT		`commitmentEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`commitmentEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.