OSID Logo
OSID Specifications
configuration rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.configuration.rules.ParameterProcessorEnablerQuery
Implementsosid.OsidEnablerQuery
Description

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

MethodmatchRuledParameterProcessorId
Description

Matches enablers mapped to the parameter processor.

Parametersosid.id.IdparameterProcessorIdthe parameter processor Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT parameterProcessorId is null
CompliancemandatoryThis method must be implemented.
MethodclearRuledParameterProcessorIdTerms
Description

Clears the parameter processor Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledParameterProcessorQuery
Description

Tests if a ParameterProcessorQuery is available.

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

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

Returnosid.configuration.rules.ParameterProcessorQuerythe parameter processor query
ErrorsUNIMPLEMENTED supportsRuledParameterProcessorQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuledParameterProcessorQuery() is true.
MethodmatchAnyRuledParameterProcessor
Description

Matches enablers mapped to any parameter processor.

Parametersbooleanmatch true for enablers mapped to any parameter processor, false to match enablers mapped to no parameter processors
CompliancemandatoryThis method must be implemented.
MethodclearRuledParameterProcessorTerms
Description

Clears the parameter processor query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchConfigurationId
Description

Matches enablers 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.
MethodgetParameterProcessorEnablerQueryRecord
Description

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

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