public interface AntimatroidQuery extends OsidCatalogQuery
This is the query for searching antimatroids. Each method match
specifies an AND
term while multiple invocations of the
same method produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearAncestorAntimatroidIdTerms()
Clears the ancestor antimatroid
Id query terms. |
void |
clearAncestorAntimatroidTerms()
Clears the ancestor antimatroid query terms.
|
void |
clearChainIdTerms()
Clears the chain
Id query terms. |
void |
clearChainTerms()
Clears the chain query terms.
|
void |
clearDescendantAntimatroidIdTerms()
Clears the descendant antimatroid
Id query terms. |
void |
clearDescendantAntimatroidTerms()
Clears the descendant antimatroid query terms.
|
AntimatroidQuery |
getAncestorAntimatroidQuery()
Gets the query for an antimatroid.
|
AntimatroidQueryRecord |
getAntimatroidQueryRecord(Type antimatroidRecordType)
Gets the antimatroid query record corresponding to the given
Antimatroid record Type. |
ChainQuery |
getChainQuery()
Gets the query for a chain.
|
AntimatroidQuery |
getDescendantAntimatroidQuery()
Gets the query for an antimatroid/ Multiple retrievals produce a
nested
OR term. |
void |
matchAncestorAntimatroidId(Id antimatroidId,
boolean match)
Sets the antimatroid
Id for this query to match
antimatroids that have the specified antimatroid as an ancestor. |
void |
matchAnyAncestorAntimatroid(boolean match)
Matches antimatroids with any ancestor.
|
void |
matchAnyChain(boolean match)
Matches action groups with any chain.
|
void |
matchAnyDescendantAntimatroid(boolean match)
Matches antimatroids with any descendant.
|
void |
matchChainId(Id chainId,
boolean match)
Sets the chain
Id for this query. |
void |
matchDescendantAntimatroidId(Id antimatroidId,
boolean match)
Sets the antimatroid
Id for this query to match
antimatroids that have the specified antimatroid as a descendant. |
boolean |
supportsAncestorAntimatroidQuery()
Tests if an
AntimatroidQuery is available. |
boolean |
supportsDescendantAntimatroidQuery()
Tests if an
AntimatroidQuery is available. |
boolean |
supportsInputQuery()
Tests if a
ChainQuery 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 matchChainId(Id chainId, boolean match)
Id
for this query.chainId
- the chain Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- chainId
is
null
mandatory
- This method must be implemented. void clearChainIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsInputQuery()
ChainQuery
is available. true
if an input query is available,
false
otherwisemandatory
- This method must be implemented. ChainQuery getChainQuery()
OR
term.UnimplementedException
- supportsChainQuery()
is false
optional
- This method must be implemented if
supportsChainQuery()
is true.
void matchAnyChain(boolean match)
match
- true
to match antimatroids with any
chain, false
to match antimatroids with no
chainsmandatory
- This method must be implemented. void clearChainTerms()
mandatory
- This method must be implemented. void matchAncestorAntimatroidId(Id antimatroidId, boolean match)
Id
for this query to match
antimatroids that have the specified antimatroid as an ancestor.antimatroidId
- an antimatroid Id
match
- true
for a positive match, false
for negative matchNullArgumentException
- antimatroidId
is
null
mandatory
- This method must be implemented. void clearAncestorAntimatroidIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsAncestorAntimatroidQuery()
AntimatroidQuery
is available. true
if an antimatroid query is available,
false
otherwisemandatory
- This method must be implemented. AntimatroidQuery getAncestorAntimatroidQuery()
OR
term.UnimplementedException
-
supportsAncestorAntimatroidQuery()
is false
optional
- This method must be implemented if
supportsAncestorAntimatroidQuery()
is true.
void matchAnyAncestorAntimatroid(boolean match)
match
- true
to match antimatroids with any
ancestor, false
to match root antimatroidsmandatory
- This method must be implemented. void clearAncestorAntimatroidTerms()
mandatory
- This method must be implemented. void matchDescendantAntimatroidId(Id antimatroidId, boolean match)
Id
for this query to match
antimatroids that have the specified antimatroid as a descendant.antimatroidId
- an antimatroid Id
match
- true
for a positive match, false
for negative matchNullArgumentException
- antimatroidId
is
null
mandatory
- This method must be implemented. void clearDescendantAntimatroidIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsDescendantAntimatroidQuery()
AntimatroidQuery
is available. true
if an antimatroid query is available,
false
otherwisemandatory
- This method must be implemented. AntimatroidQuery getDescendantAntimatroidQuery()
OR
term.UnimplementedException
-
supportsDescendantAntimatroidQuery()
is false
optional
- This method must be implemented if
supportsDescendantAntimatroidQuery()
is
true.
void matchAnyDescendantAntimatroid(boolean match)
match
- true
to match antimatroids with any
descendant, false
to match leaf antimatroidsmandatory
- This method must be implemented. void clearDescendantAntimatroidTerms()
mandatory
- This method must be implemented. AntimatroidQueryRecord getAntimatroidQueryRecord(Type antimatroidRecordType) throws OperationFailedException
Antimatroid
record Type.
Multiple record
retrievals produce a nested OR
term.antimatroidRecordType
- an antimatroid record typeNullArgumentException
- antimatroidRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(antimatroidRecordType)
is false
mandatory
- This method must be implemented.