org.osid.control

Interface ControllerSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, ControllerQuerySession, OsidSession

public interface ControllerSearchSession
extends ControllerQuerySession

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

getControllersByQuery() is the basic search method and returns a list of Controllers. A more advanced search may be performed with getControllersBySearch(). It accepts a ControllerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getControllersBySearch() returns a ControllerSearchResults that can be used to access the resulting ControllerList or be used to perform a search within the result set through ControllerSearch.

This session defines views that offer differing behaviors for searching.

• federated trigger view: searches include controllers in triggers of which this trigger is an ancestor in the trigger hierarchy
• isolated trigger view: searches are restricted to controllers in this trigger

Controllers may have a controller record indicated by their respective record types. The controller record is accessed via the ControllerQuery.

Method Summary

Methods

Modifier and Type	Method and Description
ControllerQuery	getControllerQueryFromInspector(ControllerQueryInspector controllerQueryInspector) Gets a controller query from an inspector.
ControllerSearchResults	getControllersBySearch(ControllerQuery controllerQuery, ControllerSearch controllerSearch) Gets the search results matching the given search query using the given search.
ControllerSearch	getControllerSearch() Gets a controller search.
ControllerSearchOrder	getControllerSearchOrder() Gets a controller search order.

Methods inherited from interface org.osid.control.ControllerQuerySession

canSearchControllers, getControllerQuery, getControllersByQuery, 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

getControllerSearch

ControllerSearch getControllerSearch()

Gets a controller search.

Returns:

the controller search

Compliance:

mandatory - This method must be implemented.

getControllerSearchOrder

ControllerSearchOrder getControllerSearchOrder()

Gets a controller search order. The ControllerSearchOrder is supplied to a ControllerSearch to specify the ordering of results.

Returns:

the controller search order

Compliance:

mandatory - This method must be implemented.

getControllersBySearch

ControllerSearchResults getControllersBySearch(ControllerQuery controllerQuery,
                                             ControllerSearch controllerSearch)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

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

Parameters:

controllerQuery - the controller query

controllerSearch - the controller search

Returns:

the controller search results

Throws:

NullArgumentException - controllerQuery or controllerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - controllerQuery or controllerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getControllerQueryFromInspector

ControllerQuery getControllerQueryFromInspector(ControllerQueryInspector controllerQueryInspector)

Gets a controller query from an inspector. The inspector is available from a ControllerSearchResults.

Parameters:

controllerQueryInspector - a controller query inspector

Returns:

the controller query

Throws:

NullArgumentException - controllerQueryInspector is null

UnsupportedException - controllerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.