public interface QueueProcessorEnablerQuery extends OsidEnablerQuery
This is the query for searching queue processor enablers. 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 |
clearRuledQueueProcessorIdTerms()
Clears the queue processor
Id query terms. |
void |
clearRuledQueueProcessorTerms()
Clears the queue processor query terms.
|
FrontOfficeQuery |
getFrontOfficeQuery()
Gets the query for a front office.
|
QueueProcessorEnablerQueryRecord |
getQueueProcessorEnablerQueryRecord(Type queueProcessorEnablerRecordType)
Gets the queue processor enabler query record corresponding to the
given
QueueProcessorEnabler record Type. |
QueueProcessorQuery |
getRuledQueueProcessorQuery()
Gets the query for a queue processor.
|
void |
matchAnyRuledQueueProcessor(boolean match)
Matches enablers mapped to any queue processor.
|
void |
matchFrontOfficeId(Id frontOfficeId,
boolean match)
Matches enablers mapped to the front office.
|
void |
matchRuledQueueProcessorId(Id queueProcessorId,
boolean match)
Matches enablers mapped to the queue processor.
|
boolean |
supportsFrontOfficeQuery()
Tests if an
FrontOfficeQuery is available. |
boolean |
supportsRuledQueueProcessorQuery()
Tests if a
QueueProcessorQuery is available. |
clearCyclicEventIdTerms, clearCyclicEventTerms, clearDemographicIdTerms, clearDemographicTerms, clearEventIdTerms, clearEventTerms, clearScheduleIdTerms, clearScheduleTerms, getCyclicEventQuery, getDemographicQuery, getEventQuery, getScheduleQuery, matchAnyCyclicEvent, matchAnyDemographic, matchAnyEvent, matchAnySchedule, matchCyclicEventId, matchDemographicId, matchEventId, matchScheduleId, supportsCyclicEventQuery, supportsDemographicQuery, supportsEventQuery, supportsScheduleQuery
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
clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate
void matchRuledQueueProcessorId(Id queueProcessorId, boolean match)
queueProcessorId
- the queue processor Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- queueProcessorId
is null
mandatory
- This method must be implemented. void clearRuledQueueProcessorIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledQueueProcessorQuery()
QueueProcessorQuery
is available. true
if a queue processor query is available,
false
otherwisemandatory
- This method must be implemented. QueueProcessorQuery getRuledQueueProcessorQuery()
OR
term.UnimplementedException
-
supportsRuledQueueProcessorQuery()
is false
optional
- This method must be implemented if
supportsRuledQueueProcessorQuery()
is true.
void matchAnyRuledQueueProcessor(boolean match)
match
- true
for enablers mapped to any queue
processor, false
to match enablers mapped to no
queue processorsmandatory
- This method must be implemented. void clearRuledQueueProcessorTerms()
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. QueueProcessorEnablerQueryRecord getQueueProcessorEnablerQueryRecord(Type queueProcessorEnablerRecordType) throws OperationFailedException
QueueProcessorEnabler
record Type.
Multiple record retrievals produce a nested OR
term.queueProcessorEnablerRecordType
- a queue processor enabler
record typeNullArgumentException
-
queueProcessorEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(queueProcessorEnablerRecordType)
is
false
mandatory
- This method must be implemented.