OSID Logo
OSID Specifications
configuration package
Version 3.0.0
Release Candidate Preview
Interfaceosid.configuration.ValueQuery
Implementsosid.OsidObjectQuery
osid.OsidOperableQuery
osid.OsidSubjugateableQuery
Description

The interface to query a value.

MethodmatchPriority
Description

Adds a priority match. Multiple ranges can be added to perform a boolean OR among them.

Parameterscardinallowstart priority value
cardinalhighend priority value
booleanmatch true if a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodmatchAnyPriority
Description

Matches values with any priority.

Parametersbooleanmatch true if to match values with any priority, false to match values with no priority
CompliancemandatoryThis method must be implemented.
MethodclearPriorityTerms
Description

Clears the priority terms.

CompliancemandatoryThis method must be implemented.
MethodmatchBooleanValue
Description

Adds a boolean match.

Parametersbooleanvaluea boolean value
booleanmatch true if a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearBooleanValueTerms
Description

Clears the boolean value terms.

CompliancemandatoryThis method must be implemented.
MethodmatchBytesValue
Description

Adds a byte string match. Multiple byte arrays can be added to perform a boolean OR among them.

Parametersbyte[]valuea byte value
booleanmatch true if a positive match, false for a negative match
booleanpartial true if for a partial match, false for complete match
CompliancemandatoryThis method must be implemented.
MethodclearBytesValueTerms
Description

Clears the bytes value terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCardinalValue
Description

Adds a cardinal match within the given range inclusive. Multiple ranges can be added to perform a boolean OR among them.

Parameterscardinallowstart cardinal value
cardinalhighend cardinal value
booleanmatch true if a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearCardinalValueTerms
Description

Clears the cardinal value terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCoordinateValue
Description

Adds a coordinate match for coordinates inside the specified coordinate. Multiple ranges can be added to perform a boolean OR among them.

Parametersosid.mapping.Coordinatecoordinatea coordinate value
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT coordinate is null
CompliancemandatoryThis method must be implemented.
MethodclearCoordinateValueTerms
Description

Clears the coordinate value terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCurrencyValue
Description

Adds a curency match within the given range inclusive. Multiple ranges can be added to perform a boolean OR among them.

Parametersosid.financials.Currencylowstart currency value
osid.financials.Currencyhigha currency value
booleanmatch true if a positive match, false for a negative match
ErrorsINVALID_ARGUMENT low is greater than high
NULL_ARGUMENT low or high is null
CompliancemandatoryThis method must be implemented.
MethodclearCurrencyValueTerms
Description

Clears the currency value terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDateTimeValue
Description

Adds a DateTime range match within the given range inclusive. Multiple ranges can be added to perform a boolean OR among them.

Parametersosid.calendaring.DateTimelowstart datetime value
osid.calendaring.DateTimehighend datetime value
booleanmatch true if a positive match, false for a negative match
ErrorsINVALID_ARGUMENT low is greater than high
NULL_ARGUMENT low or high is null
CompliancemandatoryThis method must be implemented.
MethodclearDateTimeValueTerms
Description

Clears the date time value terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDecimalValue
Description

Adds a decimal match within the given range inclusive. Multiple ranges can be added to perform a boolean OR among them.

Parametersdecimallowstart decimal value
decimalhighend decimal value
booleanmatch true if a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearDecimalValueTerms
Description

Clears the decimal value terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDistanceValue
Description

Adds a Distance range match within the given range inclusive. Multiple ranges can be added to perform a boolean OR among them.

Parametersosid.mapping.Distancelowstart distance value
osid.mapping.Distancehighend distance value
booleanmatch true if a positive match, false for a negative match
ErrorsINVALID_ARGUMENT low is greater than high
NULL_ARGUMENT low or high is null
CompliancemandatoryThis method must be implemented.
MethodclearDistanceValueTerms
Description

Clears the distance value terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDurationValue
Description

Adds a Duration range match within the given range inclusive. Multiple ranges can be added to perform a boolean OR among them.

Parametersosid.calendaring.Durationlowstart duration value
osid.calendaring.Durationhighend duration value
booleanmatch true if a positive match, false for a negative match
ErrorsINVALID_ARGUMENT low is greater than high
NULL_ARGUMENT low or high is null
CompliancemandatoryThis method must be implemented.
MethodclearDurationValueTerms
Description

Clears the duration value terms.

CompliancemandatoryThis method must be implemented.
MethodmatchHeadingValue
Description

Adds a Heading range match within the given range inclusive. Multiple ranges can be added to perform a boolean OR among them.

Parametersosid.mapping.Headinglowstart heading value
osid.mapping.Headinghighend heading value
booleanmatch true if a positive match, false for a negative match
ErrorsINVALID_ARGUMENT low is greater than high
NULL_ARGUMENT low or high is null
CompliancemandatoryThis method must be implemented.
MethodclearHeadingValueTerms
Description

Clears the heading value terms.

CompliancemandatoryThis method must be implemented.
MethodmatchIdValue
Description

Adds an Id to match. Multiple Ids can be added to perform a boolean OR among them.

Parametersosid.id.Idvaluean Id value
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT value is null
CompliancemandatoryThis method must be implemented.
MethodclearIdValueTerms
Description

Clears the Id value terms.

CompliancemandatoryThis method must be implemented.
MethodmatchIntegerValue
Description

Adds an integer match within the given range inclusive. Multiple ranges can be added to perform a boolean OR among them.

Parametersintegerlowstart integer value
integerhighend integer value
booleanmatch true if a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearIntegerValueTerms
Description

Clears the integer value terms.

CompliancemandatoryThis method must be implemented.
MethodmatchSpatialUnitValue
Description

Adds a spatial unit match within the given spatial unit inclusive. Multiple ranges can be added to perform a boolean OR among them.

Parametersosid.mapping.SpatialUnitvaluea spatial unit
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT value is null
CompliancemandatoryThis method must be implemented.
MethodclearSpatialUnitValueTerms
Description

Clears the spatial unit value terms.

CompliancemandatoryThis method must be implemented.
MethodmatchSpeedValue
Description

Adds a speed match within the given range inclusive. Multiple ranges can be added to perform a boolean OR among them.

Parametersosid.mapping.Speedlowstart speed value
osid.mapping.Speedhighend speed value
booleanmatch true if a positive match, false for a negative match
ErrorsINVALID_ARGUMENT low is greater than high
NULL_ARGUMENT low or high is null
CompliancemandatoryThis method must be implemented.
MethodclearSpeedValueTerms
Description

Clears the speed value terms.

CompliancemandatoryThis method must be implemented.
MethodmatchStringValue
Description

Adds a string match. Multiple strings can be added to perform a boolean OR among them.

Parametersstringvaluestring to match
osid.type.TypestringMatchTypethe string match type
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT value is not of stringMatchType
NULL_ARGUMENT value or stringMatchType is null
UNSUPPORTED supportsStringMatchType(stringMatchType) is false
CompliancemandatoryThis method must be implemented.
MethodclearStringValueTerms
Description

Clears the string value terms.

CompliancemandatoryThis method must be implemented.
MethodmatchTimeValue
Description

Adds a time match within the given range inclusive. Multiple ranges can be added to perform a boolean OR among them.

Parametersosid.calendaring.Timelowstart time value
osid.calendaring.Timehighend time value
booleanmatch true if a positive match, false for a negative match
ErrorsINVALID_ARGUMENT low is greater than high
NULL_ARGUMENT low or high is null
CompliancemandatoryThis method must be implemented.
MethodclearTimeValueTerms
Description

Clears the time value terms.

CompliancemandatoryThis method must be implemented.
MethodmatchTypeValue
Description

Adds a Type match. Multiple types can be added to perform a boolean OR among them.

Parametersosid.type.Typevaluetype to match
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT value is null
CompliancemandatoryThis method must be implemented.
MethodclearTypeValueTerms
Description

Clears the type value terms.

CompliancemandatoryThis method must be implemented.
MethodmatchVersionValue
Description

Adds a Version match within the given range inclusive. Multiple queries can be added to perform a boolean OR among them.

Parametersosid.installation.Versionlowstart version value
osid.installation.Versionhighend version value
booleanmatch true if a positive match, false for a negative match
ErrorsINVALID_ARGUMENT low is greater than high
NULL_ARGUMENT low or high is null
CompliancemandatoryThis method must be implemented.
MethodclearVersionValueTerms
Description

Clears the version value terms.

CompliancemandatoryThis method must be implemented.
MethodmatchObjectValueType
Description

Adds a Type to match on the type of object. Multiple types can be added to perform a boolean OR among them.

Parametersosid.type.TypeobjectTypetype to match
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT objectType is null
CompliancemandatoryThis method must be implemented.
MethodclearObjectValueTypeTerms
Description

Clears the object value type value terms.

CompliancemandatoryThis method must be implemented.
MethodmatchObjectValue
Description

Adds an object match. Multiple objects can be added to perform a boolean OR among them.

Parametersobjectobjectobject to match
osid.type.TypeobjectTypetype of object
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT object or objectType is null
CompliancemandatoryThis method must be implemented.
MethodclearObjectValueTerms
Description

Clears the object value terms.

CompliancemandatoryThis method must be implemented.
MethodmatchParameterId
Description

Adds a parameter Id for this query.

Parametersosid.id.IdparameterIda parameter Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT parameterId is null
CompliancemandatoryThis method must be implemented.
MethodclearParameterIdTerms
Description

Clears the parameter Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsParameterQuery
Description

Tests if a ParameterQuery is available.

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

Gets the query for a parameter.

Returnosid.configuration.ParameterQuerythe parameter query
ErrorsUNIMPLEMENTED supportsParameterQuery() is false
ComplianceoptionalThis method must be implemented if supportsParameterQuery() is true.
MethodclearParameterTerms
Description

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

CompliancemandatoryThis method must be implemented.
MethodgetValueQueryRecord
Description

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

Parametersosid.type.TypevalueRecordTypea value record type
Returnosid.configuration.records.ValueQueryRecordthe value query record
ErrorsNULL_ARGUMENT valueRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(valueRecordType) is false
CompliancemandatoryThis method must be implemented.