public interface ChainQuery extends OsidObjectQuery
This is the query for searching chains. 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 |
clearAntimatroidIdTerms()
Clears the antimatroid
Id query terms. |
void |
clearAntimatroidTerms()
Clears the antimatroid query terms.
|
void |
clearElementTerms()
Clears the element query terms.
|
void |
clearFifoTerms()
Clears the fifo query terms.
|
AntimatroidQuery |
getAntimatroidQuery()
Gets the query for an antimatroid.
|
ChainQueryRecord |
getChainQueryRecord(Type chainRecordType)
Gets the query record corresponding to the given
Chain
record Type. |
void |
matchAntimatroidId(Id actionGroupId,
boolean match)
Sets the action group
Id for this query to match
sequencinglers assigned to action groups. |
void |
matchAnyElement(boolean match)
Matches chains with any element.
|
void |
matchElement(Id elementId,
boolean match)
Sets the element
Id for this query. |
void |
matchFifo(boolean match)
Matches fifo chains.
|
boolean |
supportsAntimatroidQuery()
Tests if an
AntimatroidQuery 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 matchFifo(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearFifoTerms()
mandatory
- This method must be implemented. void matchElement(Id elementId, boolean match)
Id
for this query.elementId
- the element Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- elementId
is
null
mandatory
- This method must be implemented. void matchAnyElement(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearElementTerms()
mandatory
- This method must be implemented. void matchAntimatroidId(Id actionGroupId, boolean match)
Id
for this query to match
sequencinglers assigned to action groups.actionGroupId
- the action group Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- actionGroupId
is
null
mandatory
- This method must be implemented. void clearAntimatroidIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsAntimatroidQuery()
AntimatroidQuery
is available. true
if an antimatroid query is available,
false
otherwisemandatory
- This method must be implemented. AntimatroidQuery getAntimatroidQuery()
OR
term.UnimplementedException
-
supportsAntimatroidQuery()
is false
optional
- This method must be implemented if
supportsAntimatroidQuery()
is true.
void clearAntimatroidTerms()
mandatory
- This method must be implemented. ChainQueryRecord getChainQueryRecord(Type chainRecordType) throws OperationFailedException
Chain
record Type.
Multiple record retrievals produce a
nested OR
term.chainRecordType
- a chain record typeNullArgumentException
- chainRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(chainRecordType)
is false
mandatory
- This method must be implemented.