OSID - osid.repository.AssetSearchSession Service Interface Definition

Interface	osid.repository.AssetSearchSession
Implements	`osid.repository.AssetQuerySession`
Description	This session provides methods for searching among `Asset` objects. The search query is constructed using the `AssetQuery.` `getAssetsByQuery()` is the basic search method and returns a list of `Assets.` A more advanced search may be performed with `getAssetsBySearch().` It accepts an `AssetSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getAssetsBySearch()` returns an `AssetSearchResults` that can be used to access the resulting `AssetList` or be used to perform a search within the result set through `AssetList.` This session defines views that offer differing behaviors for searching. federated repository view: searches include assets in repositories of which this repository is a ancestor in the repository hierarchy isolated repository view: searches are restricted to assets in this repository Assets may have a query record indicated by their respective record types. The query record is accessed via the `AssetQuery.`
Method	getAssetSearch
Description	Gets an asset search.
Return	`osid.repository.AssetSearch`		the asset search
Compliance	`mandatory`		This method must be implemented.
Method	getAssetSearchOrder
Description	Gets an asset search order. The `AssetSearchOrder` is supplied to an `AssetSearch` to specify the ordering of results.
Return	`osid.repository.AssetSearchOrder`		the asset search order
Compliance	`mandatory`		This method must be implemented.
Method	getAssetsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.repository.AssetQuery`	`assetQuery`	the asset query
Parameters	`osid.repository.AssetSearch`	`assetSearch`	the asset search
Return	`osid.repository.AssetSearchResults`		the asset search results
Errors	NULL_ARGUMENT		`assetQuery` or `assetSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`assetQuery` or `assetSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getAssetQueryFromInspector
Description	Gets an asset query from an inspector. The inspector is available from a `AssetSearchResults.`
Parameters	`osid.repository.AssetQueryInspector`	`assetQueryInspector`	an asset query inspector
Return	`osid.repository.AssetQuery`		the asset query
Errors	NULL_ARGUMENT		`assetQueryInspector` is `null`
Errors	UNSUPPORTED		`assetQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.