OSID - osid.lexicon.TextQuerySession Service Interface Definition

Interface	osid.lexicon.TextQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.lexicon.TextSearchSession`
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` . 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 query record indicated by their respective record types. The query record is accessed via the `TextQuery` .
Method	getPressId
Description	Gets the `Press` `Id` associated with this session.
Return	`osid.id.Id`		the `Press Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getPress
Description	Gets the `Press` associated with this session.
Return	`osid.lexicon.Press`		the press
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchTexts
Description	Tests if this user can perform `Text` lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED` . This is intended as a hint to an press that may not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedPressView
Description	Federates the view for methods in this session. A federated view will include texts in presses which are children of this press in the press hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedPressView
Description	Isolates the view for methods in this session. An isolated view restricts searches to this press only.
Compliance	`mandatory`		This method is must be implemented.
Method	getTextQuery
Description	Gets a text query.
Return	`osid.lexicon.TextQuery`		the text query
Compliance	`mandatory`		This method must be implemented.
Method	getTextsByQuery
Description	Gets a list of `Texts` matching the given text query,
Parameters	`osid.lexicon.TextQuery`	`textQuery`	the text query
Return	`osid.lexicon.TextList`		the returned `TextList`
Errors	NULL_ARGUMENT		`textQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`textQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.