org.osid.configuration

Interface ConfigurationSearchSession

All Superinterfaces:

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

public interface ConfigurationSearchSession
extends ConfigurationQuerySession

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

getConfigurationsByQuery() is the basic search method and returns a list of Configuration objects.A more advanced search may be performed with getConfigurationsBySearch(). It accepts a ConfigurationSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getConfigurationsBySearch() returns a ConfigurationSearchResults that can be used to access the resulting ConfigurationList or be used to perform a search within the result set through ConfigurationSearch.

Configurations may have a query record indicated by their respective record types. The query record is accessed via the ConfigurationQuery. The returns in this session may not be cast directly to these interfaces.

Method Summary

Methods

Modifier and Type	Method and Description
ConfigurationQuery	getConfigurationQueryFromInspector(ConfigurationQueryInspector configurationQueryInspector) Gets a configuration query from an inspector.
ConfigurationSearchResults	getConfigurationsBySearch(ConfigurationQuery configurationQuery, ConfigurationSearch configurationSearch) Gets a list of Configurations matching the given search.
ConfigurationSearch	getConfigurationSearch() Gets a configuration search.
ConfigurationSearchOrder	getConfigurationSearchOrder() Gets a log search order.

Methods inherited from interface org.osid.configuration.ConfigurationQuerySession

canSearchConfigurations, getConfigurationQuery, getConfigurationsByQuery

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

getConfigurationSearch

ConfigurationSearch getConfigurationSearch()

Gets a configuration search.

Returns:

the configuration search

Compliance:

mandatory - This method must be implemented.

getConfigurationSearchOrder

ConfigurationSearchOrder getConfigurationSearchOrder()

Gets a log search order. The ConfigurationSearchOrder is supplied to a ConfigurationSearch to specify the ordering of results.

Returns:

the configuration search order

Compliance:

mandatory - This method must be implemented.

getConfigurationsBySearch

ConfigurationSearchResults getConfigurationsBySearch(ConfigurationQuery configurationQuery,
                                                   ConfigurationSearch configurationSearch)
                                                     throws OperationFailedException,
                                                            PermissionDeniedException

Gets a list of Configurations matching the given search. Each element in the array is OR'd.

Parameters:

configurationQuery - the configuration query

configurationSearch - the configuration search

Returns:

the configuration search results

Throws:

NullArgumentException - configurationQuery or configurationSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - configurationQuery or configurationSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getConfigurationQueryFromInspector

ConfigurationQuery getConfigurationQueryFromInspector(ConfigurationQueryInspector configurationQueryInspector)

Gets a configuration query from an inspector. The inspector is available from a ConfigurationSearchResults.

Parameters:

configurationQueryInspector - a configuration query inspector

Returns:

the configuration query

Throws:

NullArgumentException - configurationQueryInspector is null

UnsupportedException - configurationQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.