org.osid.configuration.rules

Interface ValueEnablerSearchSession

All Superinterfaces:

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

public interface ValueEnablerSearchSession
extends ValueEnablerQuerySession

This session provides methods for searching among ValueEnabler objects. The search query is constructed using the ValueEnableryQuery.

getValueEnablersByQuery() is the basic search method and returns a list of ValueEnablers. A more advanced search may be performed with getValueEnablersBySearch(). It accepts a ValueEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as configuration. getValueEnablersBySearch() returns a ValueEnablerSearchResults that can be used to access the resulting ValueEnablerList or be used to perform a search within the result set through ValueEnablerSearch.

This session defines views that offer differing behaviors for searching.

• federated configuration view: searches include value enablers in configurations of which this configuration is an ancestor in the configuration hierarchy
• isolated configuration view: searches are restricted to value enablers in this configuration

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

Method Summary

Methods

Modifier and Type	Method and Description
ValueEnablerQuery	getValueEnablerQueryFromInspector(ValueEnablerQueryInspector valueEnablerQueryInspector) Gets a value enabler query from an inspector.
ValueEnablerSearchResults	getValueEnablersBySearch(ValueEnablerQuery valueEnablerQuery, ValueEnablerSearch valueEnablerSearch) Gets the search results matching the given search query using the given search.
ValueEnablerSearch	getValueEnablerSearch() Gets a value enabler search.
ValueEnablerSearchOrder	getValueEnablerSearchOrder() Gets a value enabler search order.

Methods inherited from interface org.osid.configuration.rules.ValueEnablerQuerySession

canSearchValueEnablers, getConfiguration, getConfigurationId, getValueEnablerQuery, getValueEnablersByQuery, 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

getValueEnablerSearch

ValueEnablerSearch getValueEnablerSearch()

Gets a value enabler search.

Returns:

the value enabler search

Compliance:

mandatory - This method must be implemented.

getValueEnablerSearchOrder

ValueEnablerSearchOrder getValueEnablerSearchOrder()

Gets a value enabler search order. The ValueEnablerSearchOrder is supplied to a ValueEnablerSearch to specify the ordering of results.

Returns:

the value enabler search order

Compliance:

mandatory - This method must be implemented.

getValueEnablersBySearch

ValueEnablerSearchResults getValueEnablersBySearch(ValueEnablerQuery valueEnablerQuery,
                                                 ValueEnablerSearch valueEnablerSearch)
                                                   throws OperationFailedException,
                                                          PermissionDeniedException

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

Parameters:

valueEnablerQuery - the value enabler query

valueEnablerSearch - the value enabler search

Returns:

the returned search results

Throws:

NullArgumentException - valueEnablerQuery or valueEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - valueEnablerQuery or valueEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getValueEnablerQueryFromInspector

ValueEnablerQuery getValueEnablerQueryFromInspector(ValueEnablerQueryInspector valueEnablerQueryInspector)

Gets a value enabler query from an inspector. The inspector is available from a ValueEnablerSearchResults.

Parameters:

valueEnablerQueryInspector - a value enabler query inspector

Returns:

the value enabler query

Throws:

NullArgumentException - valueEnablerQueryInspector is null

UnsupportedException - valueEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.