Interface InputEnablerSearchSession

All Superinterfaces:

AutoCloseable, Closeable, InputEnablerQuerySession, OsidSession, OsidSession

public interface InputEnablerSearchSession
extends InputEnablerQuerySession

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

getInputEnablersByQuery() is the basic search method and returns a list of InputEnablers . A more advanced search may be performed with getInputEnablersBySearch() .It accepts an InputEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as offering. getInputEnablersBySearch() returns an InputEnablerSearchResults that can be used to access the resulting InputEnablerList or be used to perform a search within the result set through InputEnablerSearch .

This session defines views that offer differing behaviors for searching.

• federated system view: searches include input enablers in systems of which this system is an ancestor in the system hierarchy
• isolated system view: searches are restricted to input enablers in this system

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

Method Summary

Modifier and Type	Method	Description
InputEnablerQuery	getInputEnablerQueryFromInspector(InputEnablerQueryInspector inputEnablerQueryInspector)	Gets an input enabler query from an inspector.
InputEnablerSearchResults	getInputEnablersBySearch(InputEnablerQuery inputEnablerQuery, InputEnablerSearch inputEnablerSearch)	Gets the search results matching the given search query using the given search.
InputEnablerSearch	getInputEnablerSearch()	Gets an input enabler search.
InputEnablerSearchOrder	getInputEnablerSearchOrder()	Gets an input enabler search order.

Methods inherited from interface Closeable

close

Methods inherited from interface InputEnablerQuerySession

canSearchInputEnablers, getInputEnablerQuery, getInputEnablersByQuery, getSystem, getSystemId, useFederatedSystemView, useIsolatedSystemView

Modifier and Type	Method	Description
boolean	canSearchInputEnablers()	Tests if this user can perform InputEnabler lookups.
InputEnablerQuery	getInputEnablerQuery()	Gets an input enabler query.
InputEnablerList	getInputEnablersByQuery(InputEnablerQuery inputEnablerQuery)	Gets a list of InputEnablers matching the given search.
System	getSystem()	Gets the System associated with this session.
Id	getSystemId()	Gets the System Id associated with this session.
void	useFederatedSystemView()	Federates the view for methods in this session.
void	useIsolatedSystemView()	Isolates the view for methods in this session.

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

getInputEnablerSearch

InputEnablerSearch getInputEnablerSearch()

Gets an input enabler search.

Returns:

the input enabler search

Compliance:

mandatory - This method must be implemented.

getInputEnablerSearchOrder

InputEnablerSearchOrder getInputEnablerSearchOrder()

Gets an input enabler search order. The InputEnablerSearchOrder is supplied to an InputEnablerSearch to specify the ordering of results.

Returns:

the input enabler search order

Compliance:

mandatory - This method must be implemented.

getInputEnablersBySearch

InputEnablerSearchResults getInputEnablersBySearch(InputEnablerQuery inputEnablerQuery,
 InputEnablerSearch inputEnablerSearch)
                                            throws OperationFailedException,
PermissionDeniedException

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

Parameters:

inputEnablerQuery - the input enabler query

inputEnablerSearch - the input enabler search

Returns:

the returned search results

Throws:

NullArgumentException - inputEnablerQuery or inputEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - inputEnablerQuery or inputEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getInputEnablerQueryFromInspector

InputEnablerQuery getInputEnablerQueryFromInspector(InputEnablerQueryInspector inputEnablerQueryInspector)

Gets an input enabler query from an inspector. The inspector is available from an InputEnablerSearchResults .

Parameters:

inputEnablerQueryInspector - an input enabler query inspector

Returns:

the input enabler query

Throws:

NullArgumentException - inputEnablerQueryInspector is null

UnsupportedException - inputEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.