public interface QueueProcessorQuery extends OsidProcessorQuery
This is the query for searching queue processors. Each method match
specifies a AND
term while multiple invocations of the same
method produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearAutomaticTerms()
Clears the automatic query terms.
|
void |
clearDistributorIdTerms()
Clears the distributor
Id query terms. |
void |
clearDistributorTerms()
Clears the distributor query terms.
|
void |
clearFifoTerms()
Clears the fifo query terms.
|
void |
clearRemovesProcessedQueueEntriesTerms()
Clears the removes processed queue entries query terms.
|
void |
clearRuledQueueIdTerms()
Clears the queue
Id query terms. |
void |
clearRuledQueueTerms()
Clears the queue query terms.
|
DistributorQuery |
getDistributorQuery()
Gets the query for a distributor.
|
QueueProcessorQueryRecord |
getQueueProcessorQueryRecord(Type queueProcessorRecordType)
Gets the queue processor query record corresponding to the given
QueueProcessor record Type. |
QueueQuery |
getRuledQueueQuery()
Gets the query for a queue.
|
void |
matchAnyRuledQueue(boolean match)
Matches mapped to any queue.
|
void |
matchAutomatic(boolean match)
Matches automatic processors.
|
void |
matchDistributorId(Id distributorId,
boolean match)
Matches mapped to the distributor.
|
void |
matchFifo(boolean match)
Matches first-in-first-out processors.
|
void |
matchRemovesProcessedQueueEntries(boolean match)
Matches processors that remove processed queue entries.
|
void |
matchRuledQueueId(Id queueId,
boolean match)
Matches mapped to the queue.
|
boolean |
supportsDistributorQuery()
Tests if a
DistributorQuery is available. |
boolean |
supportsRuledQueueQuery()
Tests if a
QueueQuery is available. |
clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery
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
clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational
void matchAutomatic(boolean match)
match
- true
to match automatic processors,
false
to match manual processorsmandatory
- This method must be implemented. void clearAutomaticTerms()
mandatory
- This method must be implemented. void matchFifo(boolean match)
match
- true
to match fifo processors,
false
otherwisemandatory
- This method must be implemented. void clearFifoTerms()
mandatory
- This method must be implemented. void matchRemovesProcessedQueueEntries(boolean match)
match
- true
to match removing queue entry
processors, false
otherwisemandatory
- This method must be implemented. void clearRemovesProcessedQueueEntriesTerms()
mandatory
- This method must be implemented. void matchRuledQueueId(Id queueId, boolean match)
queueId
- the queue Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- queueId
is
null
mandatory
- This method must be implemented. void clearRuledQueueIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledQueueQuery()
QueueQuery
is available. true
if a queue query is available,
false
otherwisemandatory
- This method must be implemented. QueueQuery getRuledQueueQuery()
OR
term.UnimplementedException
-
supportsRuledQueueQuery()
is false
optional
- This method must be implemented if
supportsRuledQueueQuery()
is true.
void matchAnyRuledQueue(boolean match)
match
- true
for mapped to any queue,
false
to match mapped to no queuemandatory
- This method must be implemented. void clearRuledQueueTerms()
mandatory
- This method must be implemented. void matchDistributorId(Id distributorId, boolean match)
distributorId
- the distributor Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- distributorId
is
null
mandatory
- This method must be implemented. void clearDistributorIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsDistributorQuery()
DistributorQuery
is available. true
if a distributor query is available,
false
otherwisemandatory
- This method must be implemented. DistributorQuery getDistributorQuery()
OR
term.UnimplementedException
-
supportsDistributorQuery()
is false
optional
- This method must be implemented if
supportsDistributorQuery()
is true.
void clearDistributorTerms()
mandatory
- This method must be implemented. QueueProcessorQueryRecord getQueueProcessorQueryRecord(Type queueProcessorRecordType) throws OperationFailedException
QueueProcessor
record Type.
Multiple
record retrievals produce a nested OR
term.queueProcessorRecordType
- a queue processor record typeNullArgumentException
- queueProcessorRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(queueProcessorRecordType)
is
false
mandatory
- This method must be implemented.