Interface ParameterSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, ParameterQuerySession

public interface ParameterSearchSession
extends ParameterQuerySession

This session provides methods for searching Parameters . The search query is constructed using the ParameterQuery .

getParametersByQuery() is the basic search method and returns a list of Parameters . A more advanced search may be performed with getParametersBySearch() .It accepts a ParameterSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getParametersBySearch() returns a ParameterSearchResults that can be used to access the resulting ParameterList or be used to perform a search within the result set through ParameterSearch .

Two views of the configuration data are defined;

• federated: parameters defined in configurations that are a parent of this configuration in the configuration hierarchy are included
• isolated: parameters are contained to within this configuration

Method Summary

Modifier and Type	Method	Description
ParameterQuery	getParameterQueryFromInspector(ParameterQueryInspector parameterQueryInspector)	Gets a parameter query from an inspector.
ParameterSearchResults	getParametersBySearch(ParameterQuery parameterQuery, ParameterSearch parameterSearch)	Gets a list of Parameters matching the given search query using the given search.
ParameterSearch	getParameterSearch()	Gets a parameter search.
ParameterSearchOrder	getParameterSearchOrder()	Gets a parameter entry 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 ParameterQuerySession

canSearchParameters, getConfiguration, getConfigurationId, getParameterQuery, getParametersByQuery, useFederatedConfigurationView, useIsolatedConfigurationView

Modifier and Type	Method	Description
boolean	canSearchParameters()	Tests if this user can perform Parameter searches.
Configuration	getConfiguration()	Gets the Configuration associated with this session.
Id	getConfigurationId()	Gets the Configuration Id associated with this session.
ParameterQuery	getParameterQuery()	Gets a paraameter query.
ParameterList	getParametersByQuery(ParameterQuery parameterQuery)	Gets a list of Parameters matching the given query.
void	useFederatedConfigurationView()	Federates the view for methods in this session.
void	useIsolatedConfigurationView()	Isolates the view for methods in this session.

Method Details

getParameterSearch

ParameterSearch getParameterSearch()

Gets a parameter search.

Returns:

the parameter search

Compliance:

mandatory - This method must be implemented.

getParameterSearchOrder

ParameterSearchOrder getParameterSearchOrder()

Gets a parameter entry search order. The ParameterEntrySearchOrder is supplied to an ParameterEntrySearch to specify the ordering of results.

Returns:

the parameter search order

Compliance:

mandatory - This method must be implemented.

getParametersBySearch

ParameterSearchResults getParametersBySearch(ParameterQuery parameterQuery,
 ParameterSearch parameterSearch)
                                      throws OperationFailedException,
PermissionDeniedException

Gets a list of Parameters matching the given search query using the given search.

Parameters:

parameterQuery - the parameter query

parameterSearch - the parameter search

Returns:

the parameter search results

Throws:

NullArgumentException - parameterQuery or parameterSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - parameterQuery or parameterSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getParameterQueryFromInspector

ParameterQuery getParameterQueryFromInspector(ParameterQueryInspector parameterQueryInspector)

Gets a parameter query from an inspector. The inspector is available from a ParameterSearchResults .

Parameters:

parameterQueryInspector - a parameter query inspector

Returns:

the parameter query

Throws:

NullArgumentException - parameterQueryInspector is null

UnsupportedException - parameterQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.