org.osid.control.rules

Interface InputEnablerSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, InputEnablerQuerySession, 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

Methods

Modifier and Type	Method and 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 org.osid.control.rules.InputEnablerQuerySession

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

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

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.