OSID - osid.inventory.ModelSearchSession Service Interface Definition

Interface	osid.inventory.ModelSearchSession
Implements	`osid.inventory.ModelQuerySession`
Description	This session provides methods for searching among `Model` objects. The search query is constructed using the `ModelQuery.` `getModelsByQuery()` is the basic search method and returns a list of `Models.` A more advanced search may be performed with `getModelsBySearch().` It accepts a `ModelSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getModelsBySearch()` returns a `ModelSearchResults` that can be used to access the resulting `ModelList` or be used to perform a search within the result set through `ModelSearch.` This session defines views that offer differing behaviors for searching. federated warehouse view: searches include models in warehouses of which this warehouse is an ancestor in the warehouse hierarchy isolated warehouse view: searches are restricted to models in this warehouse Models may have a query record indicated by their respective record types. The queryrecord is accessed via the `ModelQuery.`
Method	getModelSearch
Description	Gets a model search.
Return	`osid.inventory.ModelSearch`		the model search
Compliance	`mandatory`		This method must be implemented.
Method	getModelSearchOrder
Description	Gets a model search order. The `ModelSearchOrder` is supplied to a `ModelSearch` to specify the ordering of results.
Return	`osid.inventory.ModelSearchOrder`		the model search order
Compliance	`mandatory`		This method must be implemented.
Method	getModelsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.inventory.ModelQuery`	`modelQuery`	the model query
Parameters	`osid.inventory.ModelSearch`	`modelSearch`	the model search
Return	`osid.inventory.ModelSearchResults`		the model search results
Errors	NULL_ARGUMENT		`modelQuery` or `modelSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`modelQuery` or `modelSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getModelQueryFromInspector
Description	Gets a model query from an inspector. The inspector is available from a `ModelSearchResults.`
Parameters	`osid.assessment.ItemQueryInspector`	`modelQueryInspector`	a model query inspector
Return	`osid.inventory.ModelQuery`		the model query
Errors	NULL_ARGUMENT		`modelQueryInspector` is `null`
Errors	UNSUPPORTED		`modelQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.