public interface EntryQuery extends OsidObjectQuery
This is the query for searching dictionary entries. Each method
specifies an AND
term while multiple invocations of the
same method produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearDictionaryIdTerms()
Clears the dictionary
Id terms. |
void |
clearDictionaryTerms()
Clears the dictionary terms.
|
void |
clearKeyTerms()
Clears the key terms.
|
void |
clearKeyTypeTerms()
Clears the key type terms.
|
void |
clearValueTerms()
Clears the value terms.
|
void |
clearValueTypeTerms()
Clears the value type terms.
|
DictionaryQuery |
getDictionaryQuery()
Gets the query for a dictionary.
|
EntryQueryRecord |
getEntryQueryRecord(Type entryRecordType)
Gets the entry query record corresponding to the given
Dictionary record Type. |
void |
matchDictionaryId(Id dictionaryId,
boolean match)
Sets the dictionary
Id for this query. |
void |
matchKey(java.lang.Object key,
Type keyType,
boolean match)
Matches entries of this key.
|
void |
matchKeyType(Type keyType,
boolean match)
Sets the
Type for querying keys of a given type. |
void |
matchValue(java.lang.Object value,
Type valueType,
boolean match)
Sets the value in this entry.
|
void |
matchValueType(Type valueType,
boolean match)
Sets the
Type of this entry value. |
boolean |
supportsDictionaryQuery()
Tests if a
DictionaryQuery 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
void matchKeyType(Type keyType, boolean match)
Type
for querying keys of a given type.keyType
- the key Type
match
- true
for a positive match, false
for a negative matchNullArgumentException
- keyType
is
null
mandatory
- This method must be implemented. void clearKeyTypeTerms()
mandatory
- This method must be implemented. void matchKey(java.lang.Object key, Type keyType, boolean match)
key
- the keykeyType
- the key Type
match
- true
for a positive match, false
for a negative matchNullArgumentException
- key
or
keyType
is null
mandatory
- This method must be implemented. void clearKeyTerms()
mandatory
- This method must be implemented. void matchValueType(Type valueType, boolean match)
Type
of this entry value.valueType
- the value Type
match
- true
for a positive match, false
for a negative matchNullArgumentException
- valueType
is
null
mandatory
- This method must be implemented. void clearValueTypeTerms()
mandatory
- This method must be implemented. void matchValue(java.lang.Object value, Type valueType, boolean match)
value
- the valuevalueType
- the value Type
match
- true
for a positive match, false
for a negative matchNullArgumentException
- value
or
valueType
is null
mandatory
- This method must be implemented. void clearValueTerms()
mandatory
- This method must be implemented. void matchDictionaryId(Id dictionaryId, boolean match)
Id
for this query.dictionaryId
- a dictionary Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- dictionaryId
is
null
mandatory
- This method must be implemented. void clearDictionaryIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsDictionaryQuery()
DictionaryQuery
is available. true
if a dictionary query is available,
false
otherwisemandatory
- This method must be implemented. DictionaryQuery getDictionaryQuery()
OR
term.UnimplementedException
-
supportsDictionaryQuery()
is false
optional
- This method must be implemented if
supportsDictionaryQuery()
is true.
void clearDictionaryTerms()
mandatory
- This method must be implemented. EntryQueryRecord getEntryQueryRecord(Type entryRecordType) throws OperationFailedException
Dictionary
record Type.
Multiple retrievale
produce a nested boolean OR
term.entryRecordType
- an entry record typeNullArgumentException
- entryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(entryRecordType)
is false
mandatory
- This method must be implemented.