OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.ControllerSearchSession
Implementsosid.control.ControllerQuerySession
Description

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.

MethodgetControllerSearch
Description

Gets a controller search.

Returnosid.control.ControllerSearchthe controller search
CompliancemandatoryThis method must be implemented.
MethodgetControllerSearchOrder
Description

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

Returnosid.control.ControllerSearchOrderthe controller search order
CompliancemandatoryThis method must be implemented.
MethodgetControllersBySearch
Description

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

Parametersosid.control.ControllerQuerycontrollerQuerythe controller query
osid.control.ControllerSearchcontrollerSearchthe controller search
Returnosid.control.ControllerSearchResultsthe controller search results
ErrorsNULL_ARGUMENT controllerQuery or controllerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED controllerQuery or controllerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetControllerQueryFromInspector
Description

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

Parametersosid.control.ControllerQueryInspectorcontrollerQueryInspectora controller query inspector
Returnosid.control.ControllerQuerythe controller query
ErrorsNULL_ARGUMENT controllerQueryInspector is null
UNSUPPORTED controllerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.