Interface ConfigurationSearchSession

All Superinterfaces:

AutoCloseable, Closeable, ConfigurationQuerySession, OsidSession, OsidSession

public interface ConfigurationSearchSession
extends ConfigurationQuerySession

This session provides methods for searching among Configurations . 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface ConfigurationQuerySession

canSearchConfigurations, getConfigurationQuery, getConfigurationsByQuery

Modifier and Type	Method	Description
boolean	canSearchConfigurations()	Tests if this user can perform Configuration searches.
ConfigurationQuery	getConfigurationQuery()	Gets a configuration query.
ConfigurationList	getConfigurationsByQuery(ConfigurationQuery configurationQuery)	Gets a list of Configurations matching the given search.

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.

Method Details

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.