org.osid.configuration

Interface ValueSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession, ValueQuerySession

public interface ValueSearchSession
extends ValueQuerySession

This session provides methods for searching Value objects. 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

Methods

Modifier and Type	Method and 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 org.osid.configuration.ValueQuerySession

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

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.