Interface | osid.configuration.ParameterQuery | ||
---|---|---|---|
Implements | osid.OsidRuleQuery | ||
Description |
The If multiple data elements are set, the results matching
all the given data (eg: Any match method inside a Parameter { ParameterQuery.matchDisplayName AND (ParameterQuery.matchDescription OR Parameter.matchDescription)} OR ParameterQuery String searches are described using a string search Type that indicates the type of regular expression or wildcarding encoding. Compatibility with a strings search Type can be tested within this interface. | ||
Method | matchValueSyntax | ||
Description |
Adds a match for parameters of a given value syntax.
Multiple matches can be added to perform a boolean | ||
Parameters | osid.Syntax | syntax | the parameter value syntax |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | syntax is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearValueSyntaxTerms | ||
Description |
Clears the value syntax terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchValueCoordinateType | ||
Description |
Adds a match for parameters with a given coordinate
type for a coordinate value. Multiple matches can be added
to perform a boolean | ||
Parameters | osid.type.Type | coordinateType | the coordinate type |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | coordinateType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearValueCoordinateTypeTerms | ||
Description |
Clears the coordinate type terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchValueHeadingType | ||
Description |
Adds a match for parameters with a given heading type
for a coordinate value. Multiple matches can be added to
perform a boolean | ||
Parameters | osid.type.Type | headingType | the heading type |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | headingType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearValueHeadingTypeTerms | ||
Description |
Clears the coorheadingdinate record type terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchValueObjectType | ||
Description |
Adds a match for parameters with a given object type
for an object value. Multiple matches can be added to
perform a boolean | ||
Parameters | osid.type.Type | objectType | the object type |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | objectType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearValueObjectTypeTerms | ||
Description |
Clears the object value type terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchValueSpatialUnitRecordType | ||
Description |
Adds a match for parameters with a given spatial unit
record type for a coordinate value. Multiple matches can
be added to perform a boolean | ||
Parameters | osid.type.Type | spatialUnitRecordType | the spatial unit record type |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | spatialUnitRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearValueSpatialUnitRecordTypeTerms | ||
Description |
Clears the spatial unit record type terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchValueVersionScheme | ||
Description |
Adds a match for parameters with a given version type
for a version value. Multiple matches can be added to
perform a boolean | ||
Parameters | osid.type.Type | versionType | the version type |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | versionType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearValueVersionSchemeTerms | ||
Description |
Clears the value type terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsValueQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a value query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getValueQuery | ||
Description |
Gets the query for a value. | ||
Return | osid.configuration.ValueQuery | the value query | |
Errors | UNIMPLEMENTED | supportsValueQuery() is false | |
Compliance | optional | This method must be implemented if supportsValueQuery() is
true. | |
Method | matchAnyValue | ||
Description |
Matches parameters that have any value. | ||
Parameters | boolean | match | true to match parameters with any value, false
to match parameters with no value |
Compliance | mandatory | This method must be implemented. | |
Method | clearValueTerms | ||
Description |
Clears the value terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchValuesShuffled | ||
Description |
Matches shuffle order. | ||
Parameters | boolean | shuffle | true to match shuffle by weight, false to match order by
index |
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyValuesShuffled | ||
Description |
Matches parameters that have any shuffle value. | ||
Parameters | boolean | match | true to match parameters with any shuffle value,
false to match parameters with no shuffle value |
Compliance | mandatory | This method must be implemented. | |
Method | clearValuesShuffledTerms | ||
Description |
Clears the shuffle terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchConfigurationId | ||
Description |
Sets the configuration | ||
Parameters | osid.id.Id | configurationId | a configuration Id |
boolean | match | true if 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. | ||
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 terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getParameterQueryRecord | ||
Description |
Gets the parameter query record corresponding to the
given | ||
Parameters | osid.type.Type | parameterRecordType | a parameter record type |
Return | osid.configuration.records.ParameterQueryRecord | the parameter query record | |
Errors | NULL_ARGUMENT | parameterRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(parameterRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |