Interface ParameterProcessorEnablerSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, ParameterProcessorEnablerQuerySession

public interface ParameterProcessorEnablerSearchSession
extends ParameterProcessorEnablerQuerySession

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

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

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Modifier and Type	Method	Description
ParameterProcessorEnablerQuery	getParameterProcessorEnablerQueryFromInspector(ParameterProcessorEnablerQueryInspector parameterProcessorEnablerQueryInspector)	Gets a parameter processor enabler query from an inspector.
ParameterProcessorEnablerSearchResults	getParameterProcessorEnablersBySearch(ParameterProcessorEnablerQuery parameterProcessorEnablerQuery, ParameterProcessorEnablerSearch parameterProcessorEnablerSearch)	Gets the search results matching the given search query using the given search.
ParameterProcessorEnablerSearch	getParameterProcessorEnablerSearch()	Gets a parameter processor enabler search.
ParameterProcessorEnablerSearchOrder	getParameterProcessorEnablerSearchOrder()	Gets a parameter processor enabler search order.

Methods inherited from interface Closeable

close

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.

Methods inherited from interface ParameterProcessorEnablerQuerySession

canSearchParameterProcessorEnablers, getConfiguration, getConfigurationId, getParameterProcessorEnablerQuery, getParameterProcessorEnablersByQuery, useFederatedConfigurationView, useIsolatedConfigurationView

Modifier and Type	Method	Description
boolean	canSearchParameterProcessorEnablers()	Tests if this user can perform ParameterProcessorEnabler lookups.
Configuration	getConfiguration()	Gets the Configuration associated with this session.
Id	getConfigurationId()	Gets the Configuration Id associated with this session.
ParameterProcessorEnablerQuery	getParameterProcessorEnablerQuery()	Gets a parameter processor enabler query.
ParameterProcessorEnablerList	getParameterProcessorEnablersByQuery(ParameterProcessorEnablerQuery parameterProcessorEnablerQuery)	Gets a list of ParameterProcessorEnablers matching the given parameter processor query.
void	useFederatedConfigurationView()	Federates the view for methods in this session.
void	useIsolatedConfigurationView()	Isolates the view for methods in this session.

Method Details

getParameterProcessorEnablerSearch

ParameterProcessorEnablerSearch getParameterProcessorEnablerSearch()

Gets a parameter processor enabler search.

Returns:

the parameter processor enabler search

Compliance:

mandatory - This method must be implemented.

getParameterProcessorEnablerSearchOrder

ParameterProcessorEnablerSearchOrder getParameterProcessorEnablerSearchOrder()

Gets a parameter processor enabler search order. The ParameterProcessorEnablerSearchOrder is supplied to a ParameterProcessorEnablerSearch to specify the ordering of results.

Returns:

the parameter processor enabler search order

Compliance:

mandatory - This method must be implemented.

getParameterProcessorEnablersBySearch

ParameterProcessorEnablerSearchResults getParameterProcessorEnablersBySearch(ParameterProcessorEnablerQuery parameterProcessorEnablerQuery,
 ParameterProcessorEnablerSearch parameterProcessorEnablerSearch)
                                                                      throws OperationFailedException,
PermissionDeniedException

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

Parameters:

parameterProcessorEnablerQuery - the parameter processor enabler query

parameterProcessorEnablerSearch - the parameter processor enabler search

Returns:

the returned search results

Throws:

NullArgumentException - parameterProcessorEnablerQuery or parameterProcessorEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - parameterProcessorEnablerQuery or parameterProcessorEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getParameterProcessorEnablerQueryFromInspector

ParameterProcessorEnablerQuery getParameterProcessorEnablerQueryFromInspector(ParameterProcessorEnablerQueryInspector parameterProcessorEnablerQueryInspector)

Gets a parameter processor enabler query from an inspector. The inspector is available from a ParameterProcessorEnablerSearchResults.

Parameters:

parameterProcessorEnablerQueryInspector - a parameter processor enabler query inspector

Returns:

the parameter processor enabler query

Throws:

NullArgumentException - parameterProcessorEnablerQueryInspector is null

UnsupportedException - parameterProcessorEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.