Interface TextSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, TextQuerySession

public interface TextSearchSession
extends TextQuerySession

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 Summary

Modifier and Type	Method	Description
TextQuery	getTextQueryFromInspector(TextQueryInspector textQueryInspector)	Gets a text query from an inspector.
TextSearchResults	getTextsBySearch(TextQuery textQuery, TextSearch textSearch)	Gets the search results matching the given search query using the given search.
TextSearch	getTextSearch()	Gets a text search.
TextSearchOrder	getTextSearchOrder()	Gets a text search order.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Methods inherited from interface TextQuerySession

canSearchTexts, getPress, getPressId, getTextQuery, getTextsByQuery, useFederatedPressView, useIsolatedPressView

Modifier and Type	Method	Description
boolean	canSearchTexts()	Tests if this user can perform Text lookups.
Press	getPress()	Gets the Press associated with this session.
Id	getPressId()	Gets the Press Id associated with this session.
TextQuery	getTextQuery()	Gets a text query.
TextList	getTextsByQuery(TextQuery textQuery)	Gets a list of Texts matching the given text query,
void	useFederatedPressView()	Federates the view for methods in this session.
void	useIsolatedPressView()	Isolates the view for methods in this session.

Method Details

getTextSearch

TextSearch getTextSearch()

Gets a text search.

Returns:

the text search

Compliance:

mandatory - This method must be implemented.

getTextSearchOrder

TextSearchOrder getTextSearchOrder()

Gets a text search order. The TextSearchOrder is supplied to a TextSearch to specify the ordering of results.

Returns:

the text search order

Compliance:

mandatory - This method must be implemented.

getTextsBySearch

TextSearchResults getTextsBySearch(TextQuery textQuery,
 TextSearch textSearch)
                            throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

textQuery - the text query

textSearch - the text search

Returns:

the text search results

Throws:

NullArgumentException - textQuery or textSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - textQuery or textSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getTextQueryFromInspector

TextQuery getTextQueryFromInspector(TextQueryInspector textQueryInspector)

Gets a text query from an inspector. The inspector is available from a TextSearchResults .

Parameters:

textQueryInspector - a text query inspector

Returns:

the text query

Throws:

NullArgumentException - textQueryInspector is null

UnsupportedException - textQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.