OSID Logo
OSID Specifications
configuration package
Version 3.0.0
Release Candidate Preview
Interfaceosid.configuration.ParameterQuery
Implementsosid.OsidRuleQuery
Description

The ParameterQuery is used to assemble search queries. A Parameter is available from a ParameterSearchSession and defines methods to query for a Parameter that includes setting a display name and a description. Once the desired parameters are set, the ParameterQuery is given to the designated search method. The same ParameterQuery returned from the session must be used in the search as the provider may utilize implementation-specific data wiithin the object.

If multiple data elements are set, the results matching all the given data (eg: AND ) are returned. Search methods throughout the OSIDs accept multiple OsidQuery interfaces. Each ParameterQuery in the array behaves like an OR such that results are returned that match any of the given ParameterQuery objects.

Any match method inside a ParameterQuery may be invoked multiple times. In the case of a match method, each invocation adds an element to an OR expression. Any of these terms may also be negated through the match flag.

                     
                     
                     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.

MethodmatchValueSyntax
Description

Adds a match for parameters of a given value syntax. Multiple matches can be added to perform a boolean OR among them.

Parametersosid.Syntaxsyntaxthe parameter value syntax
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT syntax is null
CompliancemandatoryThis method must be implemented.
MethodclearValueSyntaxTerms
Description

Clears the value syntax terms.

CompliancemandatoryThis method must be implemented.
MethodmatchValueCoordinateType
Description

Adds a match for parameters with a given coordinate type for a coordinate value. Multiple matches can be added to perform a boolean OR among them.

Parametersosid.type.TypecoordinateTypethe coordinate type
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT coordinateType is null
CompliancemandatoryThis method must be implemented.
MethodclearValueCoordinateTypeTerms
Description

Clears the coordinate type terms.

CompliancemandatoryThis method must be implemented.
MethodmatchValueHeadingType
Description

Adds a match for parameters with a given heading type for a coordinate value. Multiple matches can be added to perform a boolean OR among them.

Parametersosid.type.TypeheadingTypethe heading type
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT headingType is null
CompliancemandatoryThis method must be implemented.
MethodclearValueHeadingTypeTerms
Description

Clears the coorheadingdinate record type terms.

CompliancemandatoryThis method must be implemented.
MethodmatchValueObjectType
Description

Adds a match for parameters with a given object type for an object value. Multiple matches can be added to perform a boolean OR among them.

Parametersosid.type.TypeobjectTypethe object type
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT objectType is null
CompliancemandatoryThis method must be implemented.
MethodclearValueObjectTypeTerms
Description

Clears the object value type terms.

CompliancemandatoryThis method must be implemented.
MethodmatchValueSpatialUnitRecordType
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 OR among them.

Parametersosid.type.TypespatialUnitRecordTypethe spatial unit record type
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT spatialUnitRecordType is null
CompliancemandatoryThis method must be implemented.
MethodclearValueSpatialUnitRecordTypeTerms
Description

Clears the spatial unit record type terms.

CompliancemandatoryThis method must be implemented.
MethodmatchValueVersionScheme
Description

Adds a match for parameters with a given version type for a version value. Multiple matches can be added to perform a boolean OR among them.

Parametersosid.type.TypeversionTypethe version type
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT versionType is null
CompliancemandatoryThis method must be implemented.
MethodclearValueVersionSchemeTerms
Description

Clears the value type terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsValueQuery
Description

Tests if a ValueQuery is available.

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

Gets the query for a value.

Returnosid.configuration.ValueQuerythe value query
ErrorsUNIMPLEMENTED supportsValueQuery() is false
ComplianceoptionalThis method must be implemented if supportsValueQuery() is true.
MethodmatchAnyValue
Description

Matches parameters that have any value.

Parametersbooleanmatch true to match parameters with any value, false to match parameters with no value
CompliancemandatoryThis method must be implemented.
MethodclearValueTerms
Description

Clears the value terms.

CompliancemandatoryThis method must be implemented.
MethodmatchValuesShuffled
Description

Matches shuffle order.

Parametersbooleanshuffle true to match shuffle by weight, false to match order by index
CompliancemandatoryThis method must be implemented.
MethodmatchAnyValuesShuffled
Description

Matches parameters that have any shuffle value.

Parametersbooleanmatch true to match parameters with any shuffle value, false to match parameters with no shuffle value
CompliancemandatoryThis method must be implemented.
MethodclearValuesShuffledTerms
Description

Clears the shuffle terms.

CompliancemandatoryThis method must be implemented.
MethodmatchConfigurationId
Description

Sets the configuration Id for this query.

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

Clears the configuration Id 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.

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

Clears the configuration terms.

CompliancemandatoryThis method must be implemented.
MethodgetParameterQueryRecord
Description

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

Parametersosid.type.TypeparameterRecordTypea parameter record type
Returnosid.configuration.records.ParameterQueryRecordthe parameter query record
ErrorsNULL_ARGUMENT parameterRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(parameterRecordType) is false
CompliancemandatoryThis method must be implemented.