OSID Logo
OSID Specifications
configuration rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.configuration.rules.ParameterProcessorSearchSession
Implementsosid.configuration.rules.ParameterProcessorQuerySession
Description

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

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

This session defines views that offer differing behaviors for searching.

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

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

MethodgetParameterProcessorSearch
Description

Gets a parameter processor search.

Returnosid.configuration.rules.ParameterProcessorSearchthe parameter processor search
CompliancemandatoryThis method must be implemented.
MethodgetParameterProcessorSearchOrder
Description

Gets a parameter processor search order. The ParameterProcessorSearchOrder is supplied to a ParameterProcessorSearch to specify the ordering of results.

Returnosid.configuration.rules.ParameterProcessorSearchOrderthe parameter processor search order
CompliancemandatoryThis method must be implemented.
MethodgetParameterProcessorsBySearch
Description

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

Parametersosid.configuration.rules.ParameterProcessorQueryparameterProcessorQuerythe parameter processor query
osid.configuration.rules.ParameterProcessorSearchparameterProcessorSearchthe parameter processor search
Returnosid.configuration.rules.ParameterProcessorSearchResultsthe returned search results
ErrorsNULL_ARGUMENT parameterProcessorQuery or parameterProcessorSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED parameterProcessorQuery or parameterProcessorSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetParameterProcessorQueryFromInspector
Description

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

Parametersosid.configuration.rules.ParameterProcessorQueryInspectorparameterProcessorQueryInspectora parameter processor query inspector
Returnosid.configuration.rules.ParameterProcessorQuerythe parameter processor query
ErrorsNULL_ARGUMENT parameterProcessorQueryInspector is null
UNSUPPORTED parameterProcessorQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.