Interface ControllerSearchSession

All Superinterfaces:

AutoCloseable, Closeable, ControllerQuerySession, OsidSession, OsidSession

public interface ControllerSearchSession
extends ControllerQuerySession

This session provides methods for searching among Controllers . 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

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

close

Methods inherited from interface ControllerQuerySession

canSearchControllers, getControllerQuery, getControllersByQuery, getSystem, getSystemId, useFederatedSystemView, useIsolatedSystemView

Modifier and Type	Method	Description
boolean	canSearchControllers()	Tests if this user can perform Controller lookups.
ControllerQuery	getControllerQuery()	Gets a controller query.
ControllerList	getControllersByQuery(ControllerQuery controllerQuery)	Gets a list of Controllers matching the given controller query.
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

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.