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

Interface	osid.calendaring.rules.CommitmentEnablerQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.calendaring.rules.CommitmentEnablerSearchSession`
Used By	`osid.calendaring.rules.CalendaringRulesManager`
Used By	`osid.calendaring.rules.CalendaringRulesProxyManager`
Description	This session provides methods for searching among `CommitmentEnabler` objects. The search query is constructed using the `CommitmentEnablerQuery`. This session defines views that offer differing behaviors for searching. federated calendar view: searches include commitment enablers in calendars of which this calendar is an ancestor in the calendar hierarchy isolated calendar view: searches are restricted to commitment enablers in this calendar Commitment enablers may have a query record indicated by their respective record types. The query record is accessed via the `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	canSearchCommitmentEnablers
Description	Tests if this user can perform `CommitmentEnabler` lookups. 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 not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedCalendarView
Description	Federates the view for methods in this session. A federated view will include commitment enablers in calendars which are children of this broker in the calendar hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCalendarView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this calendar only.
Compliance	`mandatory`		This method is 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	getCommitmentEnablersByQuery
Description	Gets a list of `CommitmentEnablers` matching the given commitment enabler query.
Parameters	`osid.calendaring.rules.CommitmentEnablerQuery`	`commitmentEnablerQuery`	the commitment enabler query
Return	`osid.calendaring.rules.CommitmentEnablerList`		the returned `CommitmentEnablerList`
Errors	NULL_ARGUMENT		`commitmentEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`commitmentEnablerQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.