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

Interface	osid.calendaring.rules.CommitmentEnablerSearchSession
Implements	`osid.calendaring.rules.CommitmentEnablerQuerySession`
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`. `getCommitmentEnablersByQuery()` is the basic search method and returns a list of `CommitmentEnablers`. A more advanced search may be performed with `getCommitmentEnablersBySearch()`. It accepts a `CommitmentEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getCommitmentEnablersBySearch()` returns a `CommitmentEnablerSearchResults` that can be used to access the resulting `CommitmentEnablerList` or be used to perform a search within the result set through `CommitmentEnablerSearch`. 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 `CommitmentEnablers` may have a query record indicated by their respective record types. The query record is accessed via the `CommitmentEnablerQuery`.
Method	getCommitmentEnablerSearch
Description	Gets a commitment enabler search.
Return	`osid.calendaring.rules.CommitmentEnablerSearch`		the commitment enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getCommitmentEnablerSearchOrder
Description	Gets a commitment enabler search order. The `CommitmentEnablerSearchOrder` is supplied to a `CommitmentEnablerSearch` to specify the ordering of results.
Return	`osid.calendaring.rules.CommitmentEnablerSearchOrder`		the commitment enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getCommitmentEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.calendaring.rules.CommitmentEnablerQuery`	`commitmentEnablerQuery`	the commitment enabler query
Parameters	`osid.calendaring.rules.CommitmentEnablerSearch`	`commitmentEnablerSearch`	the commitment enabler search
Return	`osid.calendaring.rules.CommitmentEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`commitmentEnablerQuery` or `commitmentEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`commitmentEnablerQuery` or `commitmentEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCommitmentEnablerQueryFromInspector
Description	Gets a commitment enabler query from an inspector. The inspector is available from a `CommitmentEnablerSearchResults`.
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.