OSID - osid.repository.CompositionSearchSession Service Interface Definition

Interface	osid.repository.CompositionSearchSession
Implements	`osid.repository.CompositionQuerySession`
Description	This session provides methods for searching among `Composition` objects. The search query is constructed using the `CompositionQuery.` `getCompositionsByQuery()` is the basic search method and returns a list of `Compositions.` A more advanced search may be performed with `getCompositionsBySearch().` It accepts an `Composition` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getCompositionsBySearch()` returns an `CompositionSearchResults` that can be used to access the resulting `Composition` or be used to perform a search within the result set through `CompositionSearch.` This session defines views that offer differing behaviors when searching. federated repository view: searches include compositions in repositories of which this repository is an ancestor in the repository hierarchy isolated repository view: searches are restricted to subjects in this repository Compositions may have a query record indicated by their respective record types. The query record is accessed via the `CompositionQuery.`
Method	getCompositionSearch
Description	Gets a composition search.
Return	`osid.repository.CompositionSearch`		the composition search
Compliance	`mandatory`		This method must be implemented.
Method	getCompositionSearchOrder
Description	Gets a composition search order. The `CompositionSearchOrder` is supplied to an `CompositionSearch` to specify the ordering of results.
Return	`osid.repository.CompositionSearchOrder`		the composition search order
Compliance	`mandatory`		This method must be implemented.
Method	getCompositionsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.repository.CompositionQuery`	`compositionQuery`	the composition query
Parameters	`osid.repository.CompositionSearch`	`compositionSearch`	the composition search
Return	`osid.repository.CompositionSearchResults`		the composition search results
Errors	NULL_ARGUMENT		`compositionQuery` or `compositionSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`compositionQuery` or `compositionSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCompositionQueryFromInspector
Description	Gets a composition query from an inspector. The inspector is available from a `CompositionSearchResults.`
Parameters	`osid.repository.CompositionQueryInspector`	`compositionQueryInspector`	a composition query inspector
Return	`osid.repository.CompositionQuery`		the composition query
Errors	NULL_ARGUMENT		`compositionQueryInspector` is `null`
Errors	UNSUPPORTED		`compositionQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.