org.osid.configuration

Interface ValueQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidSubjugateableQuery, Suppliable

public interface ValueQuery
extends OsidObjectQuery, OsidOperableQuery, OsidSubjugateableQuery

The interface to query a value.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearBooleanValueTerms() Clears the boolean value terms.
void	clearBytesValueTerms() Clears the bytes value terms.
void	clearCardinalValueTerms() Clears the cardinal value terms.
void	clearConfigurationIdTerms() Clears the configuration Id terms.
void	clearConfigurationTerms() Clears the configuration Id terms.
void	clearCoordinateValueTerms() Clears the coordinate value terms.
void	clearCurrencyValueTerms() Clears the currency value terms.
void	clearDateTimeValueTerms() Clears the date time value terms.
void	clearDecimalValueTerms() Clears the decimal value terms.
void	clearDistanceValueTerms() Clears the distance value terms.
void	clearDurationValueTerms() Clears the duration value terms.
void	clearHeadingValueTerms() Clears the heading value terms.
void	clearIdValueTerms() Clears the Id value terms.
void	clearIntegerValueTerms() Clears the integer value terms.
void	clearObjectValueTerms() Clears the object value terms.
void	clearObjectValueTypeTerms() Clears the object value type value terms.
void	clearParameterIdTerms() Clears the parameter Id terms.
void	clearParameterTerms() Clears the parameter terms.
void	clearPriorityTerms() Clears the priority terms.
void	clearSpatialUnitValueTerms() Clears the spatial unit value terms.
void	clearSpeedValueTerms() Clears the speed value terms.
void	clearStringValueTerms() Clears the string value terms.
void	clearTimeValueTerms() Clears the time value terms.
void	clearTypeValueTerms() Clears the type value terms.
void	clearVersionValueTerms() Clears the version value terms.
ConfigurationQuery	getConfigurationQuery() Gets the query for a configuration.
ParameterQuery	getParameterQuery() Gets the query for a parameter.
ValueQueryRecord	getValueQueryRecord(Type valueRecordType) Gets the value query record corresponding to the given Value record Type.
void	matchAnyPriority(boolean match) Matches values with any priority.
void	matchBooleanValue(boolean value, boolean match) Adds a boolean match.
void	matchBytesValue(byte[] value, boolean match, boolean partial) Adds a byte string match.
void	matchCardinalValue(long low, long high, boolean match) Adds a cardinal match within the given range inclusive.
void	matchConfigurationId(Id configurationId, boolean match) Sets the configuration Id for this query.
void	matchCoordinateValue(Coordinate coordinate, boolean match) Adds a coordinate match for coordinates inside the specified coordinate.
void	matchCurrencyValue(Currency low, Currency high, boolean match) Adds a curency match within the given range inclusive.
void	matchDateTimeValue(DateTime low, DateTime high, boolean match) Adds a DateTime range match within the given range inclusive.
void	matchDecimalValue(java.math.BigDecimal low, java.math.BigDecimal high, boolean match) Adds a decimal match within the given range inclusive.
void	matchDistanceValue(Distance low, Distance high, boolean match) Adds a Distance range match within the given range inclusive.
void	matchDurationValue(Duration low, Duration high, boolean match) Adds a Duration range match within the given range inclusive.
void	matchHeadingValue(Heading low, Heading high, boolean match) Adds a Heading range match within the given range inclusive.
void	matchIdValue(Id value, boolean match) Adds an Id to match.
void	matchIntegerValue(long low, long high, boolean match) Adds an integer match within the given range inclusive.
void	matchObjectValue(java.lang.Object object, Type objectType, boolean match) Adds an object match.
void	matchObjectValueType(Type objectType, boolean match) Adds a Type to match on the type of object.
void	matchParameterId(Id parameterId, boolean match) Adds a parameter Id for this query.
void	matchPriority(long low, long high, boolean match) Adds a priority match.
void	matchSpatialUnitValue(SpatialUnit value, boolean match) Adds a spatial unit match within the given spatial unit inclusive.
void	matchSpeedValue(Speed low, Speed high, boolean match) Adds a speed match within the given range inclusive.
void	matchStringValue(java.lang.String value, Type stringMatchType, boolean match) Adds a string match.
void	matchTimeValue(Time low, Time high, boolean match) Adds a time match within the given range inclusive.
void	matchTypeValue(Type value, boolean match) Adds a Type match.
void	matchVersionValue(Version low, Version high, boolean match) Adds a Version match within the given range inclusive.
boolean	supportsConfigurationQuery() Tests if a ConfigurationQuery is available.
boolean	supportsParameterQuery() Tests if a ParameterQuery is available.

Methods inherited from interface org.osid.OsidObjectQuery

clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidOperableQuery

clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational

Method Detail

matchPriority

void matchPriority(long low,
                 long high,
                 boolean match)

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

Parameters:

low - start priority value

high - end priority value

match - true if a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

matchAnyPriority

void matchAnyPriority(boolean match)

Matches values with any priority.

Parameters:

match - true if to match values with any priority, false to match values with no priority

Compliance:

mandatory - This method must be implemented.

clearPriorityTerms

void clearPriorityTerms()

Clears the priority terms.

Compliance:

mandatory - This method must be implemented.

matchBooleanValue

void matchBooleanValue(boolean value,
                     boolean match)

Adds a boolean match.

Parameters:

value - a boolean value

match - true if a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

clearBooleanValueTerms

void clearBooleanValueTerms()

Clears the boolean value terms.

Compliance:

mandatory - This method must be implemented.

matchBytesValue

void matchBytesValue(byte[] value,
                   boolean match,
                   boolean partial)

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

Parameters:

value - a byte value

match - true if a positive match, false for a negative match

partial - true if for a partial match, false for complete match

Compliance:

mandatory - This method must be implemented.

clearBytesValueTerms

void clearBytesValueTerms()

Clears the bytes value terms.

Compliance:

mandatory - This method must be implemented.

matchCardinalValue

void matchCardinalValue(long low,
                      long high,
                      boolean match)

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

Parameters:

low - start cardinal value

high - end cardinal value

match - true if a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

clearCardinalValueTerms

void clearCardinalValueTerms()

Clears the cardinal value terms.

Compliance:

mandatory - This method must be implemented.

matchCoordinateValue

void matchCoordinateValue(Coordinate coordinate,
                        boolean match)

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

Parameters:

coordinate - a coordinate value

match - true if a positive match, false for a negative match

Throws:

NullArgumentException - coordinate is null

Compliance:

mandatory - This method must be implemented.

clearCoordinateValueTerms

void clearCoordinateValueTerms()

Clears the coordinate value terms.

Compliance:

mandatory - This method must be implemented.

matchCurrencyValue

void matchCurrencyValue(Currency low,
                      Currency high,
                      boolean match)

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

Parameters:

low - start currency value

high - a currency value

match - true if a positive match, false for a negative match

Throws:

InvalidArgumentException - low is greater than high

NullArgumentException - low or high is null

Compliance:

mandatory - This method must be implemented.

clearCurrencyValueTerms

void clearCurrencyValueTerms()

Clears the currency value terms.

Compliance:

mandatory - This method must be implemented.

matchDateTimeValue

void matchDateTimeValue(DateTime low,
                      DateTime high,
                      boolean match)

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

Parameters:

low - start datetime value

high - end datetime value

match - true if a positive match, false for a negative match

Throws:

InvalidArgumentException - low is greater than high

NullArgumentException - low or high is null

Compliance:

mandatory - This method must be implemented.

clearDateTimeValueTerms

void clearDateTimeValueTerms()

Clears the date time value terms.

Compliance:

mandatory - This method must be implemented.

matchDecimalValue

void matchDecimalValue(java.math.BigDecimal low,
                     java.math.BigDecimal high,
                     boolean match)

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

Parameters:

low - start decimal value

high - end decimal value

match - true if a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

clearDecimalValueTerms

void clearDecimalValueTerms()

Clears the decimal value terms.

Compliance:

mandatory - This method must be implemented.

matchDistanceValue

void matchDistanceValue(Distance low,
                      Distance high,
                      boolean match)

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

Parameters:

low - start distance value

high - end distance value

match - true if a positive match, false for a negative match

Throws:

InvalidArgumentException - low is greater than high

NullArgumentException - low or high is null

Compliance:

mandatory - This method must be implemented.

clearDistanceValueTerms

void clearDistanceValueTerms()

Clears the distance value terms.

Compliance:

mandatory - This method must be implemented.

matchDurationValue

void matchDurationValue(Duration low,
                      Duration high,
                      boolean match)

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

Parameters:

low - start duration value

high - end duration value

match - true if a positive match, false for a negative match

Throws:

InvalidArgumentException - low is greater than high

NullArgumentException - low or high is null

Compliance:

mandatory - This method must be implemented.

clearDurationValueTerms

void clearDurationValueTerms()

Clears the duration value terms.

Compliance:

mandatory - This method must be implemented.

matchHeadingValue

void matchHeadingValue(Heading low,
                     Heading high,
                     boolean match)

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

Parameters:

low - start heading value

high - end heading value

match - true if a positive match, false for a negative match

Throws:

InvalidArgumentException - low is greater than high

NullArgumentException - low or high is null

Compliance:

mandatory - This method must be implemented.

clearHeadingValueTerms

void clearHeadingValueTerms()

Clears the heading value terms.

Compliance:

mandatory - This method must be implemented.

matchIdValue

void matchIdValue(Id value,
                boolean match)

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

Parameters:

value - an Id value

match - true if a positive match, false for a negative match

Throws:

NullArgumentException - value is null

Compliance:

mandatory - This method must be implemented.

clearIdValueTerms

void clearIdValueTerms()

Clears the Id value terms.

Compliance:

mandatory - This method must be implemented.

matchIntegerValue

void matchIntegerValue(long low,
                     long high,
                     boolean match)

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

Parameters:

low - start integer value

high - end integer value

match - true if a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

clearIntegerValueTerms

void clearIntegerValueTerms()

Clears the integer value terms.

Compliance:

mandatory - This method must be implemented.

matchSpatialUnitValue

void matchSpatialUnitValue(SpatialUnit value,
                         boolean match)

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

Parameters:

value - a spatial unit

match - true if a positive match, false for a negative match

Throws:

NullArgumentException - value is null

Compliance:

mandatory - This method must be implemented.

clearSpatialUnitValueTerms

void clearSpatialUnitValueTerms()

Clears the spatial unit value terms.

Compliance:

mandatory - This method must be implemented.

matchSpeedValue

void matchSpeedValue(Speed low,
                   Speed high,
                   boolean match)

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

Parameters:

low - start speed value

high - end speed value

match - true if a positive match, false for a negative match

Throws:

InvalidArgumentException - low is greater than high

NullArgumentException - low or high is null

Compliance:

mandatory - This method must be implemented.

clearSpeedValueTerms

void clearSpeedValueTerms()

Clears the speed value terms.

Compliance:

mandatory - This method must be implemented.

matchStringValue

void matchStringValue(java.lang.String value,
                    Type stringMatchType,
                    boolean match)

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

Parameters:

value - string to match

stringMatchType - the string match type

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - value is not of stringMatchType

NullArgumentException - value or stringMatchType is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

clearStringValueTerms

void clearStringValueTerms()

Clears the string value terms.

Compliance:

mandatory - This method must be implemented.

matchTimeValue

void matchTimeValue(Time low,
                  Time high,
                  boolean match)

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

Parameters:

low - start time value

high - end time value

match - true if a positive match, false for a negative match

Throws:

InvalidArgumentException - low is greater than high

NullArgumentException - low or high is null

Compliance:

mandatory - This method must be implemented.

clearTimeValueTerms

void clearTimeValueTerms()

Clears the time value terms.

Compliance:

mandatory - This method must be implemented.

matchTypeValue

void matchTypeValue(Type value,
                  boolean match)

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

Parameters:

value - type to match

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - value is null

Compliance:

mandatory - This method must be implemented.

clearTypeValueTerms

void clearTypeValueTerms()

Clears the type value terms.

Compliance:

mandatory - This method must be implemented.

matchVersionValue

void matchVersionValue(Version low,
                     Version high,
                     boolean match)

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

Parameters:

low - start version value

high - end version value

match - true if a positive match, false for a negative match

Throws:

InvalidArgumentException - low is greater than high

NullArgumentException - low or high is null

Compliance:

mandatory - This method must be implemented.

clearVersionValueTerms

void clearVersionValueTerms()

Clears the version value terms.

Compliance:

mandatory - This method must be implemented.

matchObjectValueType

void matchObjectValueType(Type objectType,
                        boolean match)

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

Parameters:

objectType - type to match

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - objectType is null

Compliance:

mandatory - This method must be implemented.

clearObjectValueTypeTerms

void clearObjectValueTypeTerms()

Clears the object value type value terms.

Compliance:

mandatory - This method must be implemented.

matchObjectValue

void matchObjectValue(java.lang.Object object,
                    Type objectType,
                    boolean match)

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

Parameters:

object - object to match

objectType - type of object

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - object or objectType is null

Compliance:

mandatory - This method must be implemented.

clearObjectValueTerms

void clearObjectValueTerms()

Clears the object value terms.

Compliance:

mandatory - This method must be implemented.

matchParameterId

void matchParameterId(Id parameterId,
                    boolean match)

Adds a parameter Id for this query.

Parameters:

parameterId - a parameter Id

match - true if a positive match, false for a negative match

Throws:

NullArgumentException - parameterId is null

Compliance:

mandatory - This method must be implemented.

clearParameterIdTerms

void clearParameterIdTerms()

Clears the parameter Id terms.

Compliance:

mandatory - This method must be implemented.

supportsParameterQuery

boolean supportsParameterQuery()

Tests if a ParameterQuery is available.

Returns:

true if a parameter query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getParameterQuery

ParameterQuery getParameterQuery()

Gets the query for a parameter.

Returns:

the parameter query

Throws:

UnimplementedException - supportsParameterQuery() is false

Compliance:

optional - This method must be implemented if supportsParameterQuery() is true.

clearParameterTerms

void clearParameterTerms()

Clears the parameter terms.

Compliance:

mandatory - This method must be implemented.

matchConfigurationId

void matchConfigurationId(Id configurationId,
                        boolean match)

Sets the configuration Id for this query.

Parameters:

configurationId - a configuration Id

match - true if a positive match, false for a negative match

Throws:

NullArgumentException - configurationId is null

Compliance:

mandatory - This method must be implemented.

clearConfigurationIdTerms

void clearConfigurationIdTerms()

Clears the configuration Id terms.

Compliance:

mandatory - This method must be implemented.

supportsConfigurationQuery

boolean supportsConfigurationQuery()

Tests if a ConfigurationQuery is available.

Returns:

true if a configuration query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getConfigurationQuery

ConfigurationQuery getConfigurationQuery()

Gets the query for a configuration.

Returns:

the configuration query

Throws:

UnimplementedException - supportsConfigurationQuery() is false

Compliance:

optional - This method must be implemented if supportsConfigurationQuery() is true.

clearConfigurationTerms

void clearConfigurationTerms()

Clears the configuration Id terms.

Compliance:

mandatory - This method must be implemented.

getValueQueryRecord

ValueQueryRecord getValueQueryRecord(Type valueRecordType)
                                     throws OperationFailedException

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

Parameters:

valueRecordType - a value record type

Returns:

the value query record

Throws:

NullArgumentException - valueRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(valueRecordType) is false

Compliance:

mandatory - This method must be implemented.