OSID Logo
OSID Specifications
control rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.rules.InputEnablerSearchSession
Implementsosid.control.rules.InputEnablerQuerySession
Description

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.

MethodgetInputEnablerSearch
Description

Gets an input enabler search.

Returnosid.control.rules.InputEnablerSearchthe input enabler search
CompliancemandatoryThis method must be implemented.
MethodgetInputEnablerSearchOrder
Description

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

Returnosid.control.rules.InputEnablerSearchOrderthe input enabler search order
CompliancemandatoryThis method must be implemented.
MethodgetInputEnablersBySearch
Description

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

Parametersosid.control.rules.InputEnablerQueryinputEnablerQuerythe input enabler query
osid.control.rules.InputEnablerSearchinputEnablerSearchthe input enabler search
Returnosid.control.rules.InputEnablerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT inputEnablerQuery or inputEnablerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED inputEnablerQuery or inputEnablerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetInputEnablerQueryFromInspector
Description

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

Parametersosid.control.rules.InputEnablerQueryInspectorinputEnablerQueryInspectoran input enabler query inspector
Returnosid.control.rules.InputEnablerQuerythe input enabler query
ErrorsNULL_ARGUMENT inputEnablerQueryInspector is null
UNSUPPORTED inputEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.