public interface ParameterQuery extends OsidRuleQuery
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.
Modifier and Type | Method and Description |
---|---|
void |
clearConfigurationIdTerms()
Clears the configuration
Id terms. |
void |
clearConfigurationTerms()
Clears the configuration terms.
|
void |
clearValueCoordinateTypeTerms()
Clears the coordinate type terms.
|
void |
clearValueHeadingTypeTerms()
Clears the coorheadingdinate record type terms.
|
void |
clearValueObjectTypeTerms()
Clears the object value type terms.
|
void |
clearValueSpatialUnitRecordTypeTerms()
Clears the spatial unit record type terms.
|
void |
clearValuesShuffledTerms()
Clears the shuffle terms.
|
void |
clearValueSyntaxTerms()
Clears the value syntax terms.
|
void |
clearValueTerms()
Clears the value terms.
|
void |
clearValueVersionSchemeTerms()
Clears the value type terms.
|
ConfigurationQuery |
getConfigurationQuery()
Gets the query for a configuration.
|
ParameterQueryRecord |
getParameterQueryRecord(Type parameterRecordType)
Gets the parameter query record corresponding to the given
Parameter record Type. |
ValueQuery |
getValueQuery()
Gets the query for a value.
|
void |
matchAnyValue(boolean match)
Matches parameters that have any value.
|
void |
matchAnyValuesShuffled(boolean match)
Matches parameters that have any shuffle value.
|
void |
matchConfigurationId(Id configurationId,
boolean match)
Sets the configuration
Id for this query. |
void |
matchValueCoordinateType(Type coordinateType,
boolean match)
Adds a match for parameters with a given coordinate type for a
coordinate value.
|
void |
matchValueHeadingType(Type headingType,
boolean match)
Adds a match for parameters with a given heading type for a coordinate
value.
|
void |
matchValueObjectType(Type objectType,
boolean match)
Adds a match for parameters with a given object type for an object
value.
|
void |
matchValueSpatialUnitRecordType(Type spatialUnitRecordType,
boolean match)
Adds a match for parameters with a given spatial unit record type for
a coordinate value.
|
void |
matchValuesShuffled(boolean shuffle)
Matches shuffle order.
|
void |
matchValueSyntax(Syntax syntax,
boolean match)
Adds a match for parameters of a given value syntax.
|
void |
matchValueVersionScheme(Type versionType,
boolean match)
Adds a match for parameters with a given version type for a version
value.
|
boolean |
supportsConfigurationQuery()
Tests if a
ConfigurationQuery is available. |
boolean |
supportsValueQuery()
Tests if a
ValueQuery is available. |
clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery
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 matchValueSyntax(Syntax syntax, boolean match)
OR
among them.syntax
- the parameter value syntaxmatch
- true
for a positive match, false
for a negative matchNullArgumentException
- syntax
is
null
mandatory
- This method must be implemented. void clearValueSyntaxTerms()
mandatory
- This method must be implemented. void matchValueCoordinateType(Type coordinateType, boolean match)
OR
among them.coordinateType
- the coordinate typematch
- true
for a positive match, false
for a negative matchNullArgumentException
- coordinateType
is null
mandatory
- This method must be implemented. void clearValueCoordinateTypeTerms()
mandatory
- This method must be implemented. void matchValueHeadingType(Type headingType, boolean match)
OR
among them.headingType
- the heading typematch
- true
for a positive match, false
for a negative matchNullArgumentException
- headingType
is
null
mandatory
- This method must be implemented. void clearValueHeadingTypeTerms()
mandatory
- This method must be implemented. void matchValueObjectType(Type objectType, boolean match)
OR
among them.objectType
- the object typematch
- true
for a positive match, false
for a negative matchNullArgumentException
- objectType
is
null
mandatory
- This method must be implemented. void clearValueObjectTypeTerms()
mandatory
- This method must be implemented. void matchValueSpatialUnitRecordType(Type spatialUnitRecordType, boolean match)
OR
among them.spatialUnitRecordType
- the spatial unit record typematch
- true
for a positive match, false
for a negative matchNullArgumentException
- spatialUnitRecordType
is null
mandatory
- This method must be implemented. void clearValueSpatialUnitRecordTypeTerms()
mandatory
- This method must be implemented. void matchValueVersionScheme(Type versionType, boolean match)
OR
among them.versionType
- the version typematch
- true
for a positive match, false
for a negative matchNullArgumentException
- versionType
is
null
mandatory
- This method must be implemented. void clearValueVersionSchemeTerms()
mandatory
- This method must be implemented. boolean supportsValueQuery()
ValueQuery
is available. true
if a value query is available,
false
otherwisemandatory
- This method must be implemented. ValueQuery getValueQuery()
UnimplementedException
- supportsValueQuery()
is false
optional
- This method must be implemented if
supportsValueQuery()
is true.
void matchAnyValue(boolean match)
match
- true
to match parameters with any value,
false
to match parameters with no valuemandatory
- This method must be implemented. void clearValueTerms()
mandatory
- This method must be implemented. void matchValuesShuffled(boolean shuffle)
shuffle
- true
to match shuffle by weight, false
to match order by indexmandatory
- This method must be implemented. void matchAnyValuesShuffled(boolean match)
match
- true
to match parameters with any shuffle
value, false
to match parameters with no
shuffle valuemandatory
- This method must be implemented. void clearValuesShuffledTerms()
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()
mandatory
- This method must be implemented. ParameterQueryRecord getParameterQueryRecord(Type parameterRecordType) throws OperationFailedException
Parameter
record Type.
Multiple record
retrievals produce a nested OR
term.parameterRecordType
- a parameter record typeNullArgumentException
- parameterRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(parameterRecordType)
is false
mandatory
- This method must be implemented.