OSID - osid.dictionary.EntrySearchSession Service Interface Definition

Interface	osid.dictionary.EntrySearchSession
Implements	`osid.dictionary.EntryQuerySession`
Description	This session provides methods for searching among entries. The search query is constructed using the `EntryQuery.` `getEntryByQuery()` is the basic search method and returns a list of `Entries.` A more advanced search may be performed with `getEntriesBySearch().` It accepts an `EntrySearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getEntriesBySearch()` returns a `EntrySearchResult` that can be used to access the resulting `EntryList` or be used to perform a search within the result set through `EntrySearch.`
Method	getEntrySearch
Description	Gets an entry search.
Return	`osid.dictionary.EntrySearch`		the entry search
Compliance	`mandatory`		This method must be implemented.
Method	getEntrySearchOrder
Description	Gets an entry search order. The `EntrySearchOrder` is supplied to a `EntrySearch` to specify the ordering of results.
Return	`osid.dictionary.EntrySearchOrder`		the entry search order
Compliance	`mandatory`		This method must be implemented.
Method	getEntriesBySearch
Description	Gets a list of `Entry` elements matching the given search.
Parameters	`osid.dictionary.EntryQuery`	`entryQuery`	the entry query
Parameters	`osid.dictionary.EntrySearch`	`entrySearch`	the entry search
Return	`osid.dictionary.EntrySearchResults`		the returned search results
Errors	NULL_ARGUMENT		`entryQuery` or `entrySearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`entrySearch` or `entryQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getEntryQueryFromInspector
Description	Gets an entry query from an inspector. The inspector is available from an `EntrySearchResults.`
Parameters	`osid.dictionary.EntryQueryInspector`	`entryQueryInspector`	an entry query inspector
Return	`osid.dictionary.EntryQuery`		the entry query
Errors	NULL_ARGUMENT		`entryQueryInspector` is `null`
Errors	UNSUPPORTED		`entryQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.