OSID Logo
OSID Specifications
configuration rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.configuration.rules.ParameterProcessorEnablerSearchSession
Implementsosid.configuration.rules.ParameterProcessorEnablerQuerySession
Description

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

getParameterProcessorEnablersByQuery() is the basic search method and returns a list of ParameterProcessorEnablers. A more advanced search may be performed with getParameterProcessorEnablersBySearch(). It accepts a ParameterProcessorEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as configuration. getParameterProcessorEnablersBySearch() returns a ParameterProcessorEnablerSearchResults that can be used to access the resulting ParameterProcessorEnablerList or be used to perform a search within the result set through ParameterProcessorEnablerSearch.

This session defines views that offer differing behaviors for searching.

  • federated configuration view: searches include parameter processor enablers in configurations of which this configuration is an ancestor in the configuration hierarchy
  • isolated configuration view: searches are restricted to parameter processor enablers in this configuration

ParameterProcessorEnablers may have a query record indicated by their respective record types. The query record is accessed via the ParameterProcessorEnablerQuery.

MethodgetParameterProcessorEnablerSearch
Description

Gets a parameter processor enabler search.

Returnosid.configuration.rules.ParameterProcessorEnablerSearchthe parameter processor enabler search
CompliancemandatoryThis method must be implemented.
MethodgetParameterProcessorEnablerSearchOrder
Description

Gets a parameter processor enabler search order. The ParameterProcessorEnablerSearchOrder is supplied to a ParameterProcessorEnablerSearch to specify the ordering of results.

Returnosid.configuration.rules.ParameterProcessorEnablerSearchOrderthe parameter processor enabler search order
CompliancemandatoryThis method must be implemented.
MethodgetParameterProcessorEnablersBySearch
Description

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

Parametersosid.configuration.rules.ParameterProcessorEnablerQueryparameterProcessorEnablerQuerythe parameter processor enabler query
osid.configuration.rules.ParameterProcessorEnablerSearchparameterProcessorEnablerSearchthe parameter processor enabler search
Returnosid.configuration.rules.ParameterProcessorEnablerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT parameterProcessorEnablerQuery or parameterProcessorEnablerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED parameterProcessorEnablerQuery or parameterProcessorEnablerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetParameterProcessorEnablerQueryFromInspector
Description

Gets a parameter processor enabler query from an inspector. The inspector is available from a ParameterProcessorEnablerSearchResults.

Parametersosid.configuration.rules.ParameterProcessorEnablerQueryInspectorparameterProcessorEnablerQueryInspectora parameter processor enabler query inspector
Returnosid.configuration.rules.ParameterProcessorEnablerQuerythe parameter processor enabler query
ErrorsNULL_ARGUMENT parameterProcessorEnablerQueryInspector is null
UNSUPPORTED parameterProcessorEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.