Interface FunctionSearchSession

All Superinterfaces:

AutoCloseable, Closeable, FunctionQuerySession, OsidSession, OsidSession

public interface FunctionSearchSession
extends FunctionQuerySession

This session provides methods for searching Function objects. The search query is constructed using the FunctionQuery . The function record Type also specifies the record for the function query.

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

This session defines views that offer differing behaviors for searching.

• federated vault view: searches include functions in vaults of which this vault is a ancestor in the vault hierarchy
• isolated vault view: searches are restricted to functions in this vault

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

Method Summary

Modifier and Type	Method	Description
FunctionQuery	getFunctionQueryFromInspector(FunctionQueryInspector functionQueryInspector)	Gets a function query from an inspector.
FunctionSearchResults	getFunctionsBySearch(FunctionQuery functionQuery, FunctionSearch functionSearch)	Gets the search results matching the given search query using the given search.
FunctionSearch	getFunctionSearch()	Gets a function search.
FunctionSearchOrder	getFunctionSearchOrder()	Gets a function search order.

Methods inherited from interface Closeable

close

Methods inherited from interface FunctionQuerySession

canSearchFunctions, getFunctionQuery, getFunctionsByQuery, getVault, getVaultId, useFederatedVaultView, useIsolatedVaultView

Modifier and Type	Method	Description
boolean	canSearchFunctions()	Tests if this user can perform Function searches.
FunctionQuery	getFunctionQuery()	Gets a function query.
FunctionList	getFunctionsByQuery(FunctionQuery functionQuery)	Gets a list of Functions matching the given query.
Vault	getVault()	Gets the Vault associated with this session.
Id	getVaultId()	Gets the Vault Id associated with this session.
void	useFederatedVaultView()	Federates the view for methods in this session.
void	useIsolatedVaultView()	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

getFunctionSearch

FunctionSearch getFunctionSearch()

Gets a function search.

Returns:

the function search

Compliance:

mandatory - This method must be implemented.

getFunctionSearchOrder

FunctionSearchOrder getFunctionSearchOrder()

Gets a function search order. The FunctionSearchOrder is supplied to a FunctionSearch to specify the ordering of results.

Returns:

the function search order

Compliance:

mandatory - This method must be implemented.

getFunctionsBySearch

FunctionSearchResults getFunctionsBySearch(FunctionQuery functionQuery,
 FunctionSearch functionSearch)
                                    throws OperationFailedException,
PermissionDeniedException

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

Parameters:

functionQuery - the function query

functionSearch - the function search

Returns:

the returned search results

Throws:

NullArgumentException - functionQuery or functionSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - functionSearch or functionQuery is not of this service

Compliance:

mandatory - This method must be implemented.

getFunctionQueryFromInspector

FunctionQuery getFunctionQueryFromInspector(FunctionQueryInspector functionQueryInspector)

Gets a function query from an inspector. The inspector is available from a FunctionSearchResults .

Parameters:

functionQueryInspector - a function query inspector

Returns:

the function query

Throws:

NullArgumentException - functionQueryInspector is null

UnsupportedException - functionQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.