OSID - osid.resource.BinSearchSession Service Interface Definition

Interface	osid.resource.BinSearchSession
Implements	`osid.resource.BinQuerySession`
Description	This session provides methods for searching among `Bin` objects. The search query is constructed using the `BinQuery.` `getBinsByQuery()` is the basic search method and returns a list of `Bin` objects.A more advanced search may be performed with `getBinsBySearch().` It accepts a `BinSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getBinsBySearch()` returns a `BinSearchResults` that can be used to access the resulting `BinList` or be used to perform a search within the result set through `BinSearch.` Bins may have a bin query record indicated by their respective record types. The bin query record is accessed via the `BinQuery.`
Method	getBinSearch
Description	Gets a bin search.
Return	`osid.resource.BinSearch`		the bin search
Compliance	`mandatory`		This method must be implemented.
Method	getBinSearchOrder
Description	Gets a bin search order. The `BinSearchOrder` is supplied to a `BinSearch` to specify the ordering of results.
Return	`osid.resource.BinSearchOrder`		the bin search order
Compliance	`mandatory`		This method must be implemented.
Method	getBinsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.resource.BinQuery`	`binQuery`	the bin query
Parameters	`osid.resource.BinSearch`	`binSearch`	the bin search
Return	`osid.resource.BinSearchResults`		the bin search results
Errors	NULL_ARGUMENT		`binQuery` or `binSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`binQuery` or `binSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getBinQueryFromInspector
Description	Gets a bin query from an inspector. The inspector is available from a `BinSearchResults.`
Parameters	`osid.resource.BinQueryInspector`	`binQueryInspector`	a bin query inspector
Return	`osid.resource.BinQuery`		the bin query
Errors	NULL_ARGUMENT		`binQueryInspector` is `null`
Errors	UNSUPPORTED		`binQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.