Interface EngineSearchSession

All Superinterfaces:

AutoCloseable, Closeable, EngineQuerySession, OsidSession, OsidSession

public interface EngineSearchSession
extends EngineQuerySession

This session provides methods for searching Engines . The search query is constructed using the EngineQuery . The engine record Type also specifies the recod for the engine query.

getEnginesByQuery() is the basic search method and returns a list of Engine elements. A more advanced search may be performed with getEnginesBySearch() . It accepts an EngineSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getEnginesBySearch() returns an EngineSearchResults that can be used to access the resulting EngineList or be used to perform a search within the result set through EngineSearch .

Engines may have an engine query record indicated by their respective record types. The engine query record is accessed via the EngineQuery . The returns in this session may not be cast directly to these interfaces.

Method Summary

Modifier and Type	Method	Description
EngineQuery	getEngineQueryFromInspector(EngineQueryInspector engineQueryInspector)	Gets an engine query from an inspector.
EngineSearchResults	getEnginesBySearch(EngineQuery engineQuery, EngineSearch engineSearch)	Gets the search results matching the given search.
EngineSearch	getEngineSearch()	Gets an engine search.
EngineSearchOrder	getEngineSearchOrder()	Gets an engine search order.

Methods inherited from interface Closeable

close

Methods inherited from interface EngineQuerySession

canSearchEngines, getEngineQuery, getEnginesByQuery

Modifier and Type	Method	Description
boolean	canSearchEngines()	Tests if this user can perform Engine searches.
EngineQuery	getEngineQuery()	Gets an engine query.
EngineList	getEnginesByQuery(EngineQuery engineQuery)	Gets a list of Engines matching the given search.

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

getEngineSearch

EngineSearch getEngineSearch()

Gets an engine search.

Returns:

the engine search

Compliance:

mandatory - This method must be implemented.

getEngineSearchOrder

EngineSearchOrder getEngineSearchOrder()

Gets an engine search order. The EngineSearchOrder is supplied to an EngineSearch to specify the ordering of results.

Returns:

the engine search order

Compliance:

mandatory - This method must be implemented.

getEnginesBySearch

EngineSearchResults getEnginesBySearch(EngineQuery engineQuery,
 EngineSearch engineSearch)
                                throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search.

Parameters:

engineQuery - the engine query

engineSearch - the engine search

Returns:

the engine search results

Throws:

NullArgumentException - engineQuery or engineSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - engineQuery or engineSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getEngineQueryFromInspector

EngineQuery getEngineQueryFromInspector(EngineQueryInspector engineQueryInspector)

Gets an engine query from an inspector. The inspector is available from an EngineSearchResults .

Parameters:

engineQueryInspector - an engine query inspector

Returns:

the engine query

Throws:

NullArgumentException - engineQueryInspector is null

UnsupportedException - engineQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.