OSID - osid.resource.ResourceSearchSession Service Interface Definition

Interface	osid.resource.ResourceSearchSession
Implements	`osid.resource.ResourceQuerySession`
Description	This session provides methods for searching among `Resource` objects. The search query is constructed using the `ResourceQuery.` `getResourcesByQuery()` is the basic search method and returns a list of `Resources.` A more advanced search may be performed with `getResourcesBySearch().` It accepts an `ResourceSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getResourcesBySearch()` returns an `ResourceSearchResults` that can be used to access the resulting `ResourceList` or be used to perform a search within the result set through `ResourceList.` This session defines views that offer differing behaviors for searching. federated bin view: searches include resources in bins of which this bin is a ancestor in the bin hierarchy isolated bin view: searches are restricted to resources in this bin Resources may have a resource query record indicated by their respective record types. The resource query record is accessed via the `ResourceQuery.`
Method	getResourceSearch
Description	Gets a resource search.
Return	`osid.resource.ResourceSearch`		the resource search
Compliance	`mandatory`		This method must be implemented.
Method	getResourceSearchOrder
Description	Gets a resource search order. The `ResourceSearchOrder` is supplied to a `ResourceSearch` to specify the ordering of results.
Return	`osid.resource.ResourceSearchOrder`		the resource search order
Compliance	`mandatory`		This method must be implemented.
Method	getResourcesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.resource.ResourceQuery`	`resourceQuery`	the resource query
Parameters	`osid.resource.ResourceSearch`	`resourceSearch`	the resource search
Return	`osid.resource.ResourceSearchResults`		the resource search results
Errors	NULL_ARGUMENT		`resourceQuery` or `resourceSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`resourceQuery` or `resourceSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getResourceQueryFromInspector
Description	Gets a resource query from an inspector. The inspector is available from a `ResourceSearchResults.`
Parameters	`osid.resource.ResourceQueryInspector`	`resourceQueryInspector`	a resource query inspector
Return	`osid.resource.ResourceQuery`		the resource query
Errors	NULL_ARGUMENT		`resourceQueryInspector` is `null`
Errors	UNSUPPORTED		`resourceQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.