Interface | osid.configuration.rules.ParameterProcessorQuery | ||
---|---|---|---|
Implements | osid.OsidProcessorQuery | ||
Description |
This is the query for searching parameter processors. Each
method match specifies an | ||
Method | matchRuledParameterId | ||
Description |
Matches mapped to the parameter. | ||
Parameters | osid.id.Id | parameterId | the parameter Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | parameterId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledParameterIdTerms | ||
Description |
Clears the parameter | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRuledParameterQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a parameter query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRuledParameterQuery | ||
Description |
Gets the query for a parameter. Multiple retrievals
produce a nested | ||
Return | osid.configuration.ParameterQuery | the parameter query | |
Errors | UNIMPLEMENTED | supportsRuledParameterQuery() is false | |
Compliance | optional | This method must be implemented if supportsRuledParameterQuery()
is true. | |
Method | matchAnyRuledParameter | ||
Description |
Matches mapped to any parameter. | ||
Parameters | boolean | match | true for mapped to any parameter, false to
match mapped to no parameters |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledParameterTerms | ||
Description |
Clears the parameter query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchConfigurationId | ||
Description |
Matches mapped to the configuration. | ||
Parameters | osid.id.Id | configurationId | the configuration Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | configurationId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearConfigurationIdTerms | ||
Description |
Clears the configuration | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsConfigurationQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a configuration query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getConfigurationQuery | ||
Description |
Gets the query for a configuration. Multiple retrievals
produce a nested | ||
Return | osid.configuration.ConfigurationQuery | the configuration query | |
Errors | UNIMPLEMENTED | supportsConfigurationQuery() is false | |
Compliance | optional | This method must be implemented if supportsConfigurationQuery()
is true. | |
Method | clearConfigurationTerms | ||
Description |
Clears the configuration query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getParameterProcessorQueryRecord | ||
Description |
Gets the parameter processor query record corresponding
to the given | ||
Parameters | osid.type.Type | parameterProcessorRecordType | a parameter processor record type |
Return | osid.configuration.rules.records.ParameterProcessorQueryRecord | the parameter processor query record | |
Errors | NULL_ARGUMENT | parameterProcessorRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(parameterProcessorRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |