OSID - osid.configuration.ValueQuery Service Interface Definition

Interface	osid.configuration.ValueQuery
Implements	`osid.OsidObjectQuery`
	`osid.OsidOperableQuery`
	`osid.OsidSubjugateableQuery`
Description	The interface to query a value.
Method	matchPriority
Description	Adds a priority match. Multiple ranges can be added to perform a boolean `OR` among them.
Parameters	`cardinal`	`low`	start priority value
	`cardinal`	`high`	end priority value
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyPriority
Description	Matches values with any priority.
Parameters	`boolean`	`match`	`true` if to match values with any priority, `false` to match values with no priority
Compliance	`mandatory`		This method must be implemented.
Method	clearPriorityTerms
Description	Clears the priority terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBooleanValue
Description	Adds a boolean match.
Parameters	`boolean`	`value`	a boolean value
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearBooleanValueTerms
Description	Clears the boolean value terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBytesValue
Description	Adds a byte string match. Multiple byte arrays can be added to perform a boolean `OR` among them.
Parameters	`byte[]`	`value`	a byte value
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
	`boolean`	`partial`	`true` if for a partial match, `false` for complete match
Compliance	`mandatory`		This method must be implemented.
Method	clearBytesValueTerms
Description	Clears the bytes value terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCardinalValue
Description	Adds a cardinal match within the given range inclusive. Multiple ranges can be added to perform a boolean `OR` among them.
Parameters	`cardinal`	`low`	start cardinal value
	`cardinal`	`high`	end cardinal value
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearCardinalValueTerms
Description	Clears the cardinal value terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCoordinateValue
Description	Adds a coordinate match for coordinates inside the specified coordinate. Multiple ranges can be added to perform a boolean `OR` among them.
Parameters	`osid.mapping.Coordinate`	`coordinate`	a coordinate value
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`coordinate` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCoordinateValueTerms
Description	Clears the coordinate value terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCurrencyValue
Description	Adds a curency match within the given range inclusive. Multiple ranges can be added to perform a boolean `OR` among them.
Parameters	`osid.financials.Currency`	`low`	start currency value
	`osid.financials.Currency`	`high`	a currency value
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`low` is greater than `high`
Errors	NULL_ARGUMENT		`low` or `high` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCurrencyValueTerms
Description	Clears the currency value terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDateTimeValue
Description	Adds a `DateTime` range match within the given range inclusive. Multiple ranges can be added to perform a boolean `OR` among them.
Parameters	`osid.calendaring.DateTime`	`low`	start datetime value
	`osid.calendaring.DateTime`	`high`	end datetime value
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`low` is greater than `high`
Errors	NULL_ARGUMENT		`low` or `high` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDateTimeValueTerms
Description	Clears the date time value terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDecimalValue
Description	Adds a decimal match within the given range inclusive. Multiple ranges can be added to perform a boolean `OR` among them.
Parameters	`decimal`	`low`	start decimal value
	`decimal`	`high`	end decimal value
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearDecimalValueTerms
Description	Clears the decimal value terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDistanceValue
Description	Adds a `Distance` range match within the given range inclusive. Multiple ranges can be added to perform a boolean `OR` among them.
Parameters	`osid.mapping.Distance`	`low`	start distance value
	`osid.mapping.Distance`	`high`	end distance value
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`low` is greater than `high`
Errors	NULL_ARGUMENT		`low` or `high` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDistanceValueTerms
Description	Clears the distance value terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDurationValue
Description	Adds a `Duration` range match within the given range inclusive. Multiple ranges can be added to perform a boolean `OR` among them.
Parameters	`osid.calendaring.Duration`	`low`	start duration value
	`osid.calendaring.Duration`	`high`	end duration value
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`low` is greater than `high`
Errors	NULL_ARGUMENT		`low` or `high` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDurationValueTerms
Description	Clears the duration value terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchHeadingValue
Description	Adds a `Heading` range match within the given range inclusive. Multiple ranges can be added to perform a boolean `OR` among them.
Parameters	`osid.mapping.Heading`	`low`	start heading value
	`osid.mapping.Heading`	`high`	end heading value
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`low` is greater than `high`
Errors	NULL_ARGUMENT		`low` or `high` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearHeadingValueTerms
Description	Clears the heading value terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchIdValue
Description	Adds an `Id` to match. Multiple `Ids` can be added to perform a boolean `OR` among them.
Parameters	`osid.id.Id`	`value`	an `Id` value
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`value` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearIdValueTerms
Description	Clears the Id value terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchIntegerValue
Description	Adds an integer match within the given range inclusive. Multiple ranges can be added to perform a boolean `OR` among them.
Parameters	`integer`	`low`	start integer value
	`integer`	`high`	end integer value
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearIntegerValueTerms
Description	Clears the integer value terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSpatialUnitValue
Description	Adds a spatial unit match within the given spatial unit inclusive. Multiple ranges can be added to perform a boolean `OR` among them.
Parameters	`osid.mapping.SpatialUnit`	`value`	a spatial unit
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`value` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSpatialUnitValueTerms
Description	Clears the spatial unit value terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSpeedValue
Description	Adds a speed match within the given range inclusive. Multiple ranges can be added to perform a boolean `OR` among them.
Parameters	`osid.mapping.Speed`	`low`	start speed value
	`osid.mapping.Speed`	`high`	end speed value
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`low` is greater than `high`
Errors	NULL_ARGUMENT		`low` or `high` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSpeedValueTerms
Description	Clears the speed value terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchStringValue
Description	Adds a string match. Multiple strings can be added to perform a boolean `OR` among them.
Parameters	`string`	`value`	string to match
	`osid.type.Type`	`stringMatchType`	the string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`value is` not of `stringMatchType`
	NULL_ARGUMENT		`value` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	clearStringValueTerms
Description	Clears the string value terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchTimeValue
Description	Adds a time match within the given range inclusive. Multiple ranges can be added to perform a boolean `OR` among them.
Parameters	`osid.calendaring.Time`	`low`	start time value
	`osid.calendaring.Time`	`high`	end time value
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`low` is greater than `high`
Errors	NULL_ARGUMENT		`low` or `high` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTimeValueTerms
Description	Clears the time value terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchTypeValue
Description	Adds a `Type` match. Multiple types can be added to perform a boolean `OR` among them.
Parameters	`osid.type.Type`	`value`	type to match
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`value` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTypeValueTerms
Description	Clears the type value terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchVersionValue
Description	Adds a `Version` match within the given range inclusive. Multiple queries can be added to perform a boolean `OR` among them.
Parameters	`osid.installation.Version`	`low`	start version value
	`osid.installation.Version`	`high`	end version value
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`low` is greater than `high`
Errors	NULL_ARGUMENT		`low` or `high` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearVersionValueTerms
Description	Clears the version value terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchObjectValueType
Description	Adds a `Type` to match on the type of object. Multiple types can be added to perform a boolean `OR` among them.
Parameters	`osid.type.Type`	`objectType`	type to match
Parameters	`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	clearObjectValueTypeTerms
Description	Clears the object value type value terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchObjectValue
Description	Adds an object match. Multiple objects can be added to perform a boolean `OR` among them.
Parameters	`object`	`object`	object to match
	`osid.type.Type`	`objectType`	type of object
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`object` or `objectType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearObjectValueTerms
Description	Clears the object value terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchParameterId
Description	Adds a parameter `Id` for this query.
Parameters	`osid.id.Id`	`parameterId`	a parameter `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`parameterId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearParameterIdTerms
Description	Clears the parameter `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsParameterQuery
Description	Tests if a `ParameterQuery` is available.
Return	`boolean`		`true` if a parameter query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getParameterQuery
Description	Gets the query for a parameter.
Return	`osid.configuration.ParameterQuery`		the parameter query
Errors	UNIMPLEMENTED		`supportsParameterQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsParameterQuery()` is `true.`
Method	clearParameterTerms
Description	Clears the parameter terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchConfigurationId
Description	Sets the configuration `Id` for this query.
Parameters	`osid.id.Id`	`configurationId`	a configuration `Id`
Parameters	`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 `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsConfigurationQuery
Description	Tests if a `ConfigurationQuery` is available.
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 `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	getValueQueryRecord
Description	Gets the value query record corresponding to the given `Value` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`valueRecordType`	a value record type
Return	`osid.configuration.records.ValueQueryRecord`		the value query record
Errors	NULL_ARGUMENT		`valueRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(valueRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.