org.osid.configuration

Interface ParameterSearchSession

All Superinterfaces:

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

public interface ParameterSearchSession
extends ParameterQuerySession

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

Methods

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

canSearchParameters, getConfiguration, getConfigurationId, getParameterQuery, getParametersByQuery, 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

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.