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 |
clearFrontOfficeIdTerms()
Clears the front office
Id query terms. |
void |
clearFrontOfficeTerms()
Clears the front office query terms.
|
void |
clearRuledQueueIdTerms()
Clears the queue
Id query terms. |
void |
clearRuledQueueTerms()
Clears the queue query terms.
|
FrontOfficeQuery |
getFrontOfficeQuery()
Gets the query for a front office.
|
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 any rule mapped to any queue.
|
void |
matchFrontOfficeId(Id frontOfficeId,
boolean match)
Matches rules mapped to the front office.
|
void |
matchRuledQueueId(Id queueId,
boolean match)
Matches rules mapped to the queue.
|
boolean |
supportsFrontOfficeQuery()
Tests if an
FrontOfficeQuery 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 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 rules mapped to any queue,
false
to match rules mapped to no queuemandatory
- This method must be implemented. void clearRuledQueueTerms()
mandatory
- This method must be implemented. void matchFrontOfficeId(Id frontOfficeId, boolean match)
frontOfficeId
- the front office Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- frontOfficeId
is
null
mandatory
- This method must be implemented. void clearFrontOfficeIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsFrontOfficeQuery()
FrontOfficeQuery
is available. true
if a front office query is available,
false
otherwisemandatory
- This method must be implemented. FrontOfficeQuery getFrontOfficeQuery()
OR
term.UnimplementedException
-
supportsFrontOfficeQuery()
is false
optional
- This method must be implemented if
supportsFrontOfficeQuery()
is true.
void clearFrontOfficeTerms()
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.