OSID Logo
OSID Specifications
configuration rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.configuration.rules.ParameterProcessorQuery
Implementsosid.OsidProcessorQuery
Description

This is the query for searching parameter processors. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchRuledParameterId
Description

Matches mapped to the parameter.

Parametersosid.id.IdparameterIdthe parameter Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT parameterId is null
CompliancemandatoryThis method must be implemented.
MethodclearRuledParameterIdTerms
Description

Clears the parameter Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledParameterQuery
Description

Tests if a ParameterQuery is available.

Returnboolean true if a parameter query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRuledParameterQuery
Description

Gets the query for a parameter. Multiple retrievals produce a nested OR term.

Returnosid.configuration.ParameterQuerythe parameter query
ErrorsUNIMPLEMENTED supportsRuledParameterQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuledParameterQuery() is true.
MethodmatchAnyRuledParameter
Description

Matches mapped to any parameter.

Parametersbooleanmatch true for mapped to any parameter, false to match mapped to no parameters
CompliancemandatoryThis method must be implemented.
MethodclearRuledParameterTerms
Description

Clears the parameter query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchConfigurationId
Description

Matches mapped to the configuration.

Parametersosid.id.IdconfigurationIdthe configuration Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT configurationId is null
CompliancemandatoryThis method must be implemented.
MethodclearConfigurationIdTerms
Description

Clears the configuration Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsConfigurationQuery
Description

Tests if a ConfigurationQuery is available.

Returnboolean true if a configuration query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetConfigurationQuery
Description

Gets the query for a configuration. Multiple retrievals produce a nested OR term.

Returnosid.configuration.ConfigurationQuerythe configuration query
ErrorsUNIMPLEMENTED supportsConfigurationQuery() is false
ComplianceoptionalThis method must be implemented if supportsConfigurationQuery() is true.
MethodclearConfigurationTerms
Description

Clears the configuration query terms.

CompliancemandatoryThis method must be implemented.
MethodgetParameterProcessorQueryRecord
Description

Gets the parameter processor query record corresponding to the given ParameterProcessor record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypeparameterProcessorRecordTypea parameter processor record type
Returnosid.configuration.rules.records.ParameterProcessorQueryRecordthe parameter processor query record
ErrorsNULL_ARGUMENT parameterProcessorRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(parameterProcessorRecordType) is false
CompliancemandatoryThis method must be implemented.