OSID - osid.repository.rules.CompositionEnablerSearchSession Service Interface Definition

Interface	osid.repository.rules.CompositionEnablerSearchSession
Implements	`osid.repository.rules.CompositionEnablerQuerySession`
Used By	`osid.repository.rules.RepositoryRulesManager`
Used By	`osid.repository.rules.RepositoryRulesProxyManager`
Description	This session provides methods for searching among `CompositionEnabler` objects. The search query is constructed using the `CompositionEnableryQuery`. `getCompositionEnablersByQuery()` is the basic search method and returns a list of `CompositionEnablers`. A more advanced search may be performed with `getCompositionEnablersBySearch()`. It accepts a `CompositionEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getCompositionEnablersBySearch()` returns a `CompositionEnablerSearchResults` that can be used to access the resulting `CompositionEnablerList` or be used to perform a search within the result set through `CompositionEnablerSearch`. This session defines views that offer differing behaviors for searching. federated composition view: searches include composition enablers in compositions of which this composition is an ancestor in the composition hierarchy isolated composition view: searches are restricted to composition enablers in this composition `CompositionEnablers` may have a query record indicated by their respective record types. The query record is accessed via the `CompositionEnablerQuery`.
Method	getCompositionEnablerSearch
Description	Gets a composition enabler search.
Return	`osid.repository.rules.CompositionEnablerSearch`		the composition enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getCompositionEnablerSearchOrder
Description	Gets a composition enabler search order. The `CompositionEnablerSearchOrder` is supplied to a `CompositionEnablerSearch` to specify the ordering of results.
Return	`osid.repository.rules.CompositionEnablerSearchOrder`		the composition enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getCompositionEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.repository.rules.CompositionEnablerQuery`	`compositionEnablerQuery`	the composition enabler query
Parameters	`osid.repository.rules.CompositionEnablerSearch`	`compositionEnablerSearch`	the composition enabler search
Return	`osid.repository.rules.CompositionEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`compositionEnablerQuery` or `compositionEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`compositionEnablerQuery` or `compositionEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCompositionEnablerQueryFromInspector
Description	Gets a composition enabler query from an inspector. The inspector is available from a `CompositionEnablerSearchResults`.
Parameters	`osid.repository.rules.CompositionEnablerQueryInspector`	`compositionEnablerQueryInspector`	a composition enabler query inspector
Return	`osid.repository.rules.CompositionEnablerQuery`		the composition enabler query
Errors	NULL_ARGUMENT		`compositionEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`compositionEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.