public interface DictionaryQuery extends OsidCatalogQuery
This is the query for searching dictionaries. Each method specifies an
AND
term while multiple invocations of the same method
produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearAncestorDictionaryIdTerms()
Clears the ancestor dictionary
Id terms. |
void |
clearAncestorDictionaryTerms()
Clears the ancestor dictionary terms.
|
void |
clearDescendantDictionaryIdTerms()
Clears the dictionary
Id terms. |
void |
clearDescendantDictionaryTerms()
Clears the dictionary terms.
|
void |
clearEntryIdTerms()
Clears the entry
Id terms. |
void |
clearEntryTerms()
Clears the entry terms.
|
DictionaryQuery |
getAncestorDictionaryQuery()
Gets the query for an ancestor dictionary.
|
DictionaryQuery |
getDescendantDictionaryQuery()
Gets the query for a descendant dictioonary.
|
DictionaryQueryRecord |
getDictionaryQueryRecord(Type dictionaryRecordType)
Gets the dictionary query record corresponding to the given
Dictionary record Type. |
EntryQuery |
getEntryQuery()
Gets the query for an entry.
|
void |
matchAncestorDictionaryId(Id dictionaryId,
boolean match)
Sets the dictionary
Id for to match dictionaries in
which the specified dictionary is an acestor. |
void |
matchAnyAncestorDictionary(boolean match)
Matches a dictionary that has any ancestor.
|
void |
matchAnyDescendantDictionary(boolean match)
Matches a dictionary that has any descendant.
|
void |
matchAnyEntry(boolean match)
Matches dictionaries with any entry.
|
void |
matchDescendantDictionaryId(Id dictionaryId,
boolean match)
Sets the dictionary
Id for to match dictionaries in
which the specified dictionary is a descendant. |
void |
matchEntryId(Id entryId,
boolean match)
Sets the entry
Id. |
boolean |
supportsAncestorDictionaryQuery()
Tests if a
DictionaryQuery is available. |
boolean |
supportsDescendantDictionaryQuery()
Tests if a
DictionaryQuery is available. |
boolean |
supportsEntryQuery()
Tests if an
EntryQuery 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
clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery
void matchEntryId(Id entryId, boolean match)
Id.
entryId
- an entry Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- entryId
is
null
mandatory
- This method must be implemented. void clearEntryIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsEntryQuery()
EntryQuery
is available. true
if an entry query is available,
false
otherwisemandatory
- This method must be implemented. EntryQuery getEntryQuery()
OR
term.UnimplementedException
- supportsEntryQuery()
is false
optional
- This method must be implemented if
supportsEntryQuery()
is true.
void matchAnyEntry(boolean match)
match
- true
to match dictionaries with any
entry, false
to match dictionaries with no
entrymandatory
- This method must be implemented. void clearEntryTerms()
mandatory
- This method must be implemented. void matchAncestorDictionaryId(Id dictionaryId, boolean match)
Id
for to match dictionaries in
which the specified dictionary is an acestor.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 clearAncestorDictionaryIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsAncestorDictionaryQuery()
DictionaryQuery
is available. true
if a dictionary query is available,
false
otherwisemandatory
- This method must be implemented. DictionaryQuery getAncestorDictionaryQuery()
OR
term.UnimplementedException
-
supportsAncestorDictionaryQuery()
is false
optional
- This method must be implemented if
supportsAncestorDictionaryQuery()
is true.
void matchAnyAncestorDictionary(boolean match)
match
- true
to match dictionaries with any
ancestor dictionaries, false
to match root
dictionariesmandatory
- This method must be implemented. void clearAncestorDictionaryTerms()
mandatory
- This method must be implemented. void matchDescendantDictionaryId(Id dictionaryId, boolean match)
Id
for to match dictionaries in
which the specified dictionary is a descendant.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 clearDescendantDictionaryIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsDescendantDictionaryQuery()
DictionaryQuery
is available. true
if a dictionary query is available,
false
otherwisemandatory
- This method must be implemented. DictionaryQuery getDescendantDictionaryQuery()
OR
term.UnimplementedException
-
supportsDescendantDictionaryQuery()
is false
optional
- This method must be implemented if
supportsDescendantDictionaryQuery()
is
true.
void matchAnyDescendantDictionary(boolean match)
match
- true
to match dictionaries with any
descendant dictionaries, false
to match leaf
dictionariesmandatory
- This method must be implemented. void clearDescendantDictionaryTerms()
mandatory
- This method must be implemented. DictionaryQueryRecord getDictionaryQueryRecord(Type dictionaryRecordType) throws OperationFailedException
Dictionary
record Type.
Multiple retrievale
produce a nested boolean OR
term.dictionaryRecordType
- a dictionary record typeNullArgumentException
- dictionaryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(dictionaryRecordType)
is false
mandatory
- This method must be implemented.