Interface IdiomSearchSession

All Superinterfaces:

AutoCloseable, Closeable, IdiomQuerySession, OsidSession, OsidSession

public interface IdiomSearchSession
extends IdiomQuerySession

This session provides methods for searching among Idioms . The search query is constructed using the IdiomQuery .

getIdiomsByQuery() is the basic search method and returns a list of Idioms . A more advanced search may be performed with getIdiomsBySearch() . It accepts an IdiomSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getIdiomsBySearch() returns an IdiomSearchResults that can be used to access the resulting IdiomList or be used to perform a search within the result set through IdiomSearch .

This session defines views that offer differing behaviors for searching.

• federated press view: searches include idioms in presses of which this idiom is an ancestor in the press hierarchy
• isolated press view: searches are restricted to idioms in this press

Idioms may have a query record indicated by their respective record types. The query record is accessed via the IdiomQuery .

Method Summary

Modifier and Type	Method	Description
IdiomQuery	getIdiomQueryFromInspector(IdiomQueryInspector idiomQueryInspector)	Gets an idiom query from an inspector.
IdiomSearchResults	getIdiomsBySearch(IdiomQuery idiomQuery, IdiomSearch idiomSearch)	Gets the search results matching the given search query using the given search.
IdiomSearch	getIdiomSearch()	Gets an idiom search.
IdiomSearchOrder	getIdiomSearchOrder()	Gets an idiom search order.

Methods inherited from interface Closeable

close

Methods inherited from interface IdiomQuerySession

canSearchIdioms, getIdiomQuery, getIdiomsByQuery, getPress, getPressId, useFederatedPressView, useIsolatedPressView

Modifier and Type	Method	Description
boolean	canSearchIdioms()	Tests if this user can perform Idiom lookups.
IdiomQuery	getIdiomQuery()	Gets an idiom query.
IdiomList	getIdiomsByQuery(IdiomQuery idiomQuery)	Gets a list of Idioms matching the given idiom query.
Press	getPress()	Gets the Press associated with this session.
Id	getPressId()	Gets the Press Id associated with this session.
void	useFederatedPressView()	Federates the view for methods in this session.
void	useIsolatedPressView()	Isolates the view for methods in this session.

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.

Method Details

getIdiomSearch

IdiomSearch getIdiomSearch()

Gets an idiom search.

Returns:

the idiom search

Compliance:

mandatory - This method must be implemented.

getIdiomSearchOrder

IdiomSearchOrder getIdiomSearchOrder()

Gets an idiom search order. The IdiomSearchOrder is supplied to an IdiomSearch to specify the ordering of results.

Returns:

the idiom search order

Compliance:

mandatory - This method must be implemented.

getIdiomsBySearch

IdiomSearchResults getIdiomsBySearch(IdiomQuery idiomQuery,
 IdiomSearch idiomSearch)
                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

idiomQuery - the idiom query

idiomSearch - the idiom search

Returns:

the idiom search results

Throws:

NullArgumentException - idiomQuery or idiomSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - idiomQuery or idiomSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getIdiomQueryFromInspector

IdiomQuery getIdiomQueryFromInspector(IdiomQueryInspector idiomQueryInspector)

Gets an idiom query from an inspector. The inspector is available from an IdiomSearchResults .

Parameters:

idiomQueryInspector - an idiom query inspector

Returns:

the idiom query

Throws:

NullArgumentException - idiomQueryInspector is null

UnsupportedException - idiomQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.