OSID - osid.lexicon.TextSearchSession Service Interface Definition

Interface	osid.lexicon.TextSearchSession
Implements	`osid.lexicon.TextQuerySession`
Used By	`osid.lexicon.LexiconManager`
Used By	`osid.lexicon.LexiconProxyManager`
Description	This session provides methods for searching among `Texts` . The search query is constructed using the `TextQuery` . `getTextsByQuery()` is the basic search method and returns a list of `Texts` . A more advanced search may be performed with `getTextsBySearch()` . It accepts a `TextSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getTextsBySearch()` returns a `TextSearchResults` that can be used to access the resulting `TextList` or be used to perform a search within the result set through `TextSearch` . This session defines views that offer differing behaviors for searching. federated press view: searches include texts in presses of which this press is an ancestor in the press hierarchy isolated press view: searches are restricted to texts in this press Texts may have a record indicated by their respective record types. The query record is accessed via the `TextQuery` .
Method	getTextSearch
Description	Gets a text search.
Return	`osid.lexicon.TextSearch`		the text search
Compliance	`mandatory`		This method must be implemented.
Method	getTextSearchOrder
Description	Gets a text search order. The `TextSearchOrder` is supplied to a `TextSearch` to specify the ordering of results.
Return	`osid.lexicon.TextSearchOrder`		the text search order
Compliance	`mandatory`		This method must be implemented.
Method	getTextsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.lexicon.TextQuery`	`textQuery`	the text query
Parameters	`osid.lexicon.TextSearch`	`textSearch`	the text search
Return	`osid.lexicon.TextSearchResults`		the text search results
Errors	NULL_ARGUMENT		`textQuery` or `textSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`textQuery` or `textSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getTextQueryFromInspector
Description	Gets a text query from an inspector. The inspector is available from a `TextSearchResults` .
Parameters	`osid.lexicon.TextQueryInspector`	`textQueryInspector`	a text query inspector
Return	`osid.lexicon.TextQuery`		the text query
Errors	NULL_ARGUMENT		`textQueryInspector` is `null`
Errors	UNSUPPORTED		`textQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.