OSID - osid.lexicon.IdiomSearchSession Service Interface Definition

Interface	osid.lexicon.IdiomSearchSession
Implements	`osid.lexicon.IdiomQuerySession`
Used By	`osid.lexicon.LexiconManager`
Used By	`osid.lexicon.LexiconProxyManager`
Description	This session provides methods for searching among `Idioms` . The search query is constructed using the `IdiomQuery` . `getIdiomsByQuery()` is the basic search method and returns a list of `Idioms` . A more advanced search may be performed with `getIdiomsBySearch()` . It accepts an `IdiomSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getIdiomsBySearch()` returns an `IdiomSearchResults` that can be used to access the resulting `IdiomList` or be used to perform a search within the result set through `IdiomSearch` . This session defines views that offer differing behaviors for searching. federated press view: searches include idioms in presses of which this idiom is an ancestor in the press hierarchy isolated press view: searches are restricted to idioms in this press Idioms may have a query record indicated by their respective record types. The query record is accessed via the `IdiomQuery` .
Method	getIdiomSearch
Description	Gets an idiom search.
Return	`osid.lexicon.IdiomSearch`		the idiom search
Compliance	`mandatory`		This method must be implemented.
Method	getIdiomSearchOrder
Description	Gets an idiom search order. The `IdiomSearchOrder` is supplied to an `IdiomSearch` to specify the ordering of results.
Return	`osid.lexicon.IdiomSearchOrder`		the idiom search order
Compliance	`mandatory`		This method must be implemented.
Method	getIdiomsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.lexicon.IdiomQuery`	`idiomQuery`	the idiom query
Parameters	`osid.lexicon.IdiomSearch`	`idiomSearch`	the idiom search
Return	`osid.lexicon.IdiomSearchResults`		the idiom search results
Errors	NULL_ARGUMENT		`idiomQuery` or `idiomSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`idiomQuery` or `idiomSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getIdiomQueryFromInspector
Description	Gets an idiom query from an inspector. The inspector is available from an `IdiomSearchResults` .
Parameters	`osid.lexicon.IdiomQueryInspector`	`idiomQueryInspector`	an idiom query inspector
Return	`osid.lexicon.IdiomQuery`		the idiom query
Errors	NULL_ARGUMENT		`idiomQueryInspector` is `null`
Errors	UNSUPPORTED		`idiomQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.