public interface HierarchyQuery extends OsidCatalogQuery
This is the query for searching hierarchies. Results are returned if
all the specified elements match. Each method match request produces an
AND
term while multiple invocations of a method produces a
nested OR,
except for accessing the HierarchyQuery
record.
Modifier and Type | Method and Description |
---|---|
void |
clearNodeIdTerms()
Clears the node
Id terms. |
HierarchyQueryRecord |
getHierarchyQueryRecord(Type hierarchyRecordType)
Gets the hierarchy record query corresponding to the given
Hierarchy record Type. |
void |
matchAnyNodeId(boolean match)
Matches hierarchies with any node.
|
void |
matchNodeId(Id id,
boolean match)
Matches an
Id of a node in this hierarchy. |
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 matchNodeId(Id id, boolean match)
Id
of a node in this hierarchy. Multiple
nodes can be added to this query which behave as a boolean AND.
id
- Id
to matchmatch
- true
if a positive match, false
for negative matchNullArgumentException
- id
is
null
mandatory
- This method must be implemented. void matchAnyNodeId(boolean match)
match
- true
to match hierarchies with any nodes,
false
to match hierarchies with no nodesmandatory
- This method must be implemented. void clearNodeIdTerms()
Id
terms.mandatory
- This method must be implemented. HierarchyQueryRecord getHierarchyQueryRecord(Type hierarchyRecordType) throws OperationFailedException
Hierarchy
record Type.
Multiple record
retrievals of the same type may return the same underlying object and
do not result in adding terms to the query. Multiple record retrievals
of different types add AND
terms to the other elements
set in this form.hierarchyRecordType
- a hierarchy record typeNullArgumentException
- hierarchyRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(hierarchyRecordType)
is false
mandatory
- This method must be implemented.