OSID - osid.dictionary.DictionarySearchSession Service Interface Definition

Interface	osid.dictionary.DictionarySearchSession
Implements	`osid.dictionary.DictionaryQuerySession`
Used By	`osid.dictionary.DictionaryManager`
Used By	`osid.dictionary.DictionaryProxyManager`
Description	This session provides methods for searching `Dictionaries` . The search query is constructed using the `DictionaryQuery. The` dictionary record `Type` also specifies the record for the dictionary query. `getDictionariesByQuery()` is the basic search method and returns a list of `Dictionary` elements. A more advanced search may be performed with `getDictionaresBySearch()` . It accepts a `DictionarySearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getDictionariesBySearch()` returns a `DictionarySearchResults` that can be used to access the resulting `DictionaryList` or be used to perform a search within the result set through `DictionarySearch` . Dictionaries may have a query record indicated by their respective record types. The query record is accessed via the `DictionaryQuery` .
Method	getDictionarySearch
Description	Gets a dictionary search.
Return	`osid.dictionary.DictionarySearch`		the dictionary search
Compliance	`mandatory`		This method must be implemented.
Method	getDictionarySearchOrder
Description	Gets a dictionary search order. The `DictionarySearchOrder` is supplied to a `DictionarySearch` to specify the ordering of results.
Return	`osid.dictionary.DictionarySearchOrder`		the dictionary search order
Compliance	`mandatory`		This method must be implemented.
Method	getDictionariesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.dictionary.DictionaryQuery`	`dictionaryQuery`	the dictionary search query
Parameters	`osid.dictionary.DictionarySearch`	`dictionarySearch`	the dictionary search
Return	`osid.dictionary.DictionarySearchResults`		the returned search results
Errors	NULL_ARGUMENT		`dictionaryQuery` or `dictionarySearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`dictionarySearch` or `dictionaryQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getDictionaryQueryFromInspector
Description	Gets a dictionary query from an inspector. The inspector is available from a `DictionarySearchResults` .
Parameters	`osid.dictionary.DictionaryQueryInspector`	`dictionaryQueryInspector`	a dictionary query inspector
Return	`osid.dictionary.DictionaryQuery`		the dictionary query
Errors	NULL_ARGUMENT		`dictionaryQueryInspector` is `null`
Errors	UNSUPPORTED		`dictionaryQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.