Interface ValueSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, ValueQuerySession

public interface ValueSearchSession
extends ValueQuerySession

This session provides methods for searching Values . The search query is constructed using the ValueQuery . The parameter Type also specifies the record for the value query.

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

Two views of the configuration data are defined;

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

Method Summary

Modifier and Type	Method	Description
ValueQuery	getValueQueryFromInspector(ValueQueryInspector valueQueryInspector)	Gets a value query from an inspector.
ValueSearchResults	getValuesBySearch(ValueQuery valueQuery, ValueSearch valueSearch)	Gets a list of Values matching the given search query using the given search.
ValueSearch	getValueSearch()	Gets a value search.
ValueSearchOrder	getValueSearchOrder()	Gets a value 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 ValueQuerySession

canSearchValues, getConfiguration, getConfigurationId, getValueQuery, getValuesByQuery, useFederatedConfigurationView, useIsolatedConfigurationView

Modifier and Type	Method	Description
boolean	canSearchValues()	Tests if this user can perform Value searches.
Configuration	getConfiguration()	Gets the Configuration associated with this session.
Id	getConfigurationId()	Gets the Configuration Id associated with this session.
ValueQuery	getValueQuery()	Gets a value query.
ValueList	getValuesByQuery(ValueQuery valueQuery)	Gets a list of Values matching the given value query.
void	useFederatedConfigurationView()	Federates the view for methods in this session.
void	useIsolatedConfigurationView()	Isolates the view for methods in this session.

Method Details

getValueSearch

ValueSearch getValueSearch()

Gets a value search.

Returns:

the value search

Compliance:

mandatory - This method must be implemented.

getValueSearchOrder

ValueSearchOrder getValueSearchOrder()

Gets a value search order. The ValueSearchOrder is supplied to a ValueSearch to specify the ordering of results.

Returns:

the value search order

Compliance:

mandatory - This method must be implemented.

getValuesBySearch

ValueSearchResults getValuesBySearch(ValueQuery valueQuery,
 ValueSearch valueSearch)
                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

valueQuery - the value query

valueSearch - the value search

Returns:

the serach results

Throws:

NullArgumentException - valueQuery or valueSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - valueQuery or valueSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getValueQueryFromInspector

ValueQuery getValueQueryFromInspector(ValueQueryInspector valueQueryInspector)

Gets a value query from an inspector. The inspector is available from a ValueSearchResults .

Parameters:

valueQueryInspector - a value query inspector

Returns:

the value query

Throws:

NullArgumentException - valueQueryInspector is null

UnsupportedException - valueQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.