Interface | osid.configuration.rules.ValueEnablerQuery | ||
---|---|---|---|
Implements | osid.OsidEnablerQuery | ||
Description |
This is the query for searching value enablers. Each method
match specifies an | ||
Method | matchRuledValueId | ||
Description |
Matches enablers mapped to the value. | ||
Parameters | osid.id.Id | valueId | the value Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | valueId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledValueIdTerms | ||
Description |
Clears the value | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRuledValueQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a value query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRuledValueQuery | ||
Description |
Gets the query for a value. Multiple retrievals produce
a nested | ||
Return | osid.configuration.ValueQuery | the value query | |
Errors | UNIMPLEMENTED | supportsRuleValueQuery() is false | |
Compliance | optional | This method must be implemented if supportsRuledValueQuery()
is true. | |
Method | matchAnyRuledValue | ||
Description |
Matches enablers mapped to any value. | ||
Parameters | boolean | match | true for enablers mapped to any value, false
to match enablers mapped to no value |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledValueTerms | ||
Description |
Clears the value query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchConfigurationId | ||
Description |
Matches enablers 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 | getValueEnablerQueryRecord | ||
Description |
Gets the value enabler query record corresponding to
the given | ||
Parameters | osid.type.Type | valueEnablerRecordType | a value enabler record type |
Return | osid.configuration.rules.records.ValueEnablerQueryRecord | the value enabler query record | |
Errors | NULL_ARGUMENT | valueEnablerRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(valueEnablerRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |