public interface ValueQuery extends OsidObjectQuery, OsidOperableQuery, OsidSubjugateableQuery
The interface to query a value.
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. |
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
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational
void matchPriority(long low, long high, boolean match)
OR
among them.low
- start priority valuehigh
- end priority valuematch
- true
if a positive match, false
for a negative matchmandatory
- This method must be implemented. void matchAnyPriority(boolean match)
match
- true
if to match values with any
priority, false
to match values with no
prioritymandatory
- This method must be implemented. void clearPriorityTerms()
mandatory
- This method must be implemented. void matchBooleanValue(boolean value, boolean match)
value
- a boolean valuematch
- true
if a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearBooleanValueTerms()
mandatory
- This method must be implemented. void matchBytesValue(byte[] value, boolean match, boolean partial)
OR
among them.value
- a byte valuematch
- true
if a positive match, false
for a negative matchpartial
- true
if for a partial match,
false
for complete matchmandatory
- This method must be implemented. void clearBytesValueTerms()
mandatory
- This method must be implemented. void matchCardinalValue(long low, long high, boolean match)
OR
among them.low
- start cardinal valuehigh
- end cardinal valuematch
- true
if a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearCardinalValueTerms()
mandatory
- This method must be implemented. void matchCoordinateValue(Coordinate coordinate, boolean match)
OR
among them.coordinate
- a coordinate valuematch
- true
if a positive match, false
for a negative matchNullArgumentException
- coordinate
is
null
mandatory
- This method must be implemented. void clearCoordinateValueTerms()
mandatory
- This method must be implemented. void matchCurrencyValue(Currency low, Currency high, boolean match)
OR
among them.low
- start currency valuehigh
- a currency valuematch
- true
if a positive match, false
for a negative matchInvalidArgumentException
- low
is
greater than high
NullArgumentException
- low
or
high
is null
mandatory
- This method must be implemented. void clearCurrencyValueTerms()
mandatory
- This method must be implemented. void matchDateTimeValue(DateTime low, DateTime high, boolean match)
DateTime
range match within the given range
inclusive. Multiple ranges can be added to perform a boolean OR
among them.low
- start datetime valuehigh
- end datetime valuematch
- true
if a positive match, false
for a negative matchInvalidArgumentException
- low
is
greater than high
NullArgumentException
- low
or
high
is null
mandatory
- This method must be implemented. void clearDateTimeValueTerms()
mandatory
- This method must be implemented. void matchDecimalValue(java.math.BigDecimal low, java.math.BigDecimal high, boolean match)
OR
among them.low
- start decimal valuehigh
- end decimal valuematch
- true
if a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearDecimalValueTerms()
mandatory
- This method must be implemented. void matchDistanceValue(Distance low, Distance high, boolean match)
Distance
range match within the given range
inclusive. Multiple ranges can be added to perform a boolean OR
among them.low
- start distance valuehigh
- end distance valuematch
- true
if a positive match, false
for a negative matchInvalidArgumentException
- low
is
greater than high
NullArgumentException
- low
or
high
is null
mandatory
- This method must be implemented. void clearDistanceValueTerms()
mandatory
- This method must be implemented. void matchDurationValue(Duration low, Duration high, boolean match)
Duration
range match within the given range
inclusive. Multiple ranges can be added to perform a boolean OR
among them.low
- start duration valuehigh
- end duration valuematch
- true
if a positive match, false
for a negative matchInvalidArgumentException
- low
is
greater than high
NullArgumentException
- low
or
high
is null
mandatory
- This method must be implemented. void clearDurationValueTerms()
mandatory
- This method must be implemented. void matchHeadingValue(Heading low, Heading high, boolean match)
Heading
range match within the given range
inclusive. Multiple ranges can be added to perform a boolean OR
among them.low
- start heading valuehigh
- end heading valuematch
- true
if a positive match, false
for a negative matchInvalidArgumentException
- low
is
greater than high
NullArgumentException
- low
or
high
is null
mandatory
- This method must be implemented. void clearHeadingValueTerms()
mandatory
- This method must be implemented. void matchIdValue(Id value, boolean match)
Id
to match. Multiple Ids
can be
added to perform a boolean OR
among them.value
- an Id
valuematch
- true
if a positive match, false
for a negative matchNullArgumentException
- value
is
null
mandatory
- This method must be implemented. void clearIdValueTerms()
mandatory
- This method must be implemented. void matchIntegerValue(long low, long high, boolean match)
OR
among them.low
- start integer valuehigh
- end integer valuematch
- true
if a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearIntegerValueTerms()
mandatory
- This method must be implemented. void matchSpatialUnitValue(SpatialUnit value, boolean match)
OR
among them.value
- a spatial unitmatch
- true
if a positive match, false
for a negative matchNullArgumentException
- value
is
null
mandatory
- This method must be implemented. void clearSpatialUnitValueTerms()
mandatory
- This method must be implemented. void matchSpeedValue(Speed low, Speed high, boolean match)
OR
among them.low
- start speed valuehigh
- end speed valuematch
- true
if a positive match, false
for a negative matchInvalidArgumentException
- low
is
greater than high
NullArgumentException
- low
or
high
is null
mandatory
- This method must be implemented. void clearSpeedValueTerms()
mandatory
- This method must be implemented. void matchStringValue(java.lang.String value, Type stringMatchType, boolean match)
OR
among them.value
- string to matchstringMatchType
- the string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- value is
not
of stringMatchType
NullArgumentException
- value
or
stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void clearStringValueTerms()
mandatory
- This method must be implemented. void matchTimeValue(Time low, Time high, boolean match)
OR
among them.low
- start time valuehigh
- end time valuematch
- true
if a positive match, false
for a negative matchInvalidArgumentException
- low
is
greater than high
NullArgumentException
- low
or
high
is null
mandatory
- This method must be implemented. void clearTimeValueTerms()
mandatory
- This method must be implemented. void matchTypeValue(Type value, boolean match)
Type
match. Multiple types can be added to
perform a boolean OR
among them.value
- type to matchmatch
- true
for a positive match, false
for a negative matchNullArgumentException
- value
is
null
mandatory
- This method must be implemented. void clearTypeValueTerms()
mandatory
- This method must be implemented. void matchVersionValue(Version low, Version high, boolean match)
Version
match within the given range inclusive.
Multiple queries can be added to perform a boolean OR
among them.low
- start version valuehigh
- end version valuematch
- true
if a positive match, false
for a negative matchInvalidArgumentException
- low
is
greater than high
NullArgumentException
- low
or
high
is null
mandatory
- This method must be implemented. void clearVersionValueTerms()
mandatory
- This method must be implemented. void matchObjectValueType(Type objectType, boolean match)
Type
to match on the type of object. Multiple
types can be added to perform a boolean OR
among them.objectType
- type to matchmatch
- true
for a positive match, false
for a negative matchNullArgumentException
- objectType
is
null
mandatory
- This method must be implemented. void clearObjectValueTypeTerms()
mandatory
- This method must be implemented. void matchObjectValue(java.lang.Object object, Type objectType, boolean match)
OR
among them.object
- object to matchobjectType
- type of objectmatch
- true
for a positive match, false
for a negative matchNullArgumentException
- object
or
objectType
is null
mandatory
- This method must be implemented. void clearObjectValueTerms()
mandatory
- This method must be implemented. void matchParameterId(Id parameterId, boolean match)
Id
for this query.parameterId
- a parameter Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- parameterId
is
null
mandatory
- This method must be implemented. void clearParameterIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsParameterQuery()
ParameterQuery
is available. true
if a parameter query is available,
false
otherwisemandatory
- This method must be implemented. ParameterQuery getParameterQuery()
UnimplementedException
-
supportsParameterQuery()
is false
optional
- This method must be implemented if
supportsParameterQuery()
is true.
void clearParameterTerms()
mandatory
- This method must be implemented. void matchConfigurationId(Id configurationId, boolean match)
Id
for this query.configurationId
- a configuration Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- configurationId
is null
mandatory
- This method must be implemented. void clearConfigurationIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsConfigurationQuery()
ConfigurationQuery
is available. true
if a configuration query is available,
false
otherwisemandatory
- This method must be implemented. ConfigurationQuery getConfigurationQuery()
UnimplementedException
-
supportsConfigurationQuery()
is false
optional
- This method must be implemented if
supportsConfigurationQuery()
is true.
void clearConfigurationTerms()
Id
terms.mandatory
- This method must be implemented. ValueQueryRecord getValueQueryRecord(Type valueRecordType) throws OperationFailedException
Value
record Type.
Multiple record retrievals produce
a nested OR
term.valueRecordType
- a value record typeNullArgumentException
- valueRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(valueRecordType)
is false
mandatory
- This method must be implemented.