Interface ValueEnablerSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, 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

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

canSearchValueEnablers, getConfiguration, getConfigurationId, getValueEnablerQuery, getValueEnablersByQuery, useFederatedConfigurationView, useIsolatedConfigurationView

Modifier and Type	Method	Description
boolean	canSearchValueEnablers()	Tests if this user can perform ValueEnabler lookups.
Configuration	getConfiguration()	Gets the Configuration associated with this session.
Id	getConfigurationId()	Gets the Configuration Id associated with this session.
ValueEnablerQuery	getValueEnablerQuery()	Gets a value enabler query.
ValueEnablerList	getValueEnablersByQuery(ValueEnablerQuery valueEnablerQuery)	Gets a list of ValueEnablers matching the given value enabler query.
void	useFederatedConfigurationView()	Federates the view for methods in this session.
void	useIsolatedConfigurationView()	Isolates the view for methods in this session.

Method Details

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.