public interface QueueConstrainerEnablerQuery extends OsidEnablerQuery
This is the query for searching queue constrainer 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 |
clearDistributorIdTerms()
Clears the distributor
Id query terms. |
void |
clearDistributorTerms()
Clears the distributor query terms.
|
void |
clearRuledQueueConstrainerIdTerms()
Clears the queue constrainer
Id query terms. |
void |
clearRuledQueueConstrainerTerms()
Clears the queue constrainer query terms.
|
DistributorQuery |
getDistributorQuery()
Gets the query for a distributor.
|
QueueConstrainerEnablerQueryRecord |
getQueueConstrainerEnablerQueryRecord(Type queueConstrainerEnablerRecordType)
Gets the queue constrainer enabler query record corresponding to the
given
QueueConstrainerEnabler record Type. |
QueueConstrainerQuery |
getRuledQueueConstrainerQuery()
Gets the query for a queue constrainer.
|
void |
matchAnyRuledQueueConstrainer(boolean match)
Matches enablers mapped to any queue constrainer.
|
void |
matchDistributorId(Id distributorId,
boolean match)
Matches enablers mapped to the distributor.
|
void |
matchRuledQueueConstrainerId(Id queueConstrainerId,
boolean match)
Matches enablers mapped to the queue constrainer.
|
boolean |
supportsDistributorQuery()
Tests if a
DistributorQuery is available. |
boolean |
supportsRuledQueueConstrainerQuery()
Tests if a
QueueConstrainerQuery 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 matchRuledQueueConstrainerId(Id queueConstrainerId, boolean match)
queueConstrainerId
- the queue constrainer Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- queueConstrainerId
is null
mandatory
- This method must be implemented. void clearRuledQueueConstrainerIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledQueueConstrainerQuery()
QueueConstrainerQuery
is available. true
if a queue constrainer query is available,
false
otherwisemandatory
- This method must be implemented. QueueConstrainerQuery getRuledQueueConstrainerQuery()
OR
term.UnimplementedException
-
supportsRuledQueueConstrainerQuery()
is false
optional
- This method must be implemented if
supportsRuledQueueConstrainerQuery()
is
true.
void matchAnyRuledQueueConstrainer(boolean match)
match
- true
for enablers mapped to any queue
constrainer, false
to match enablers mapped to
no queue constrainersmandatory
- This method must be implemented. void clearRuledQueueConstrainerTerms()
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. QueueConstrainerEnablerQueryRecord getQueueConstrainerEnablerQueryRecord(Type queueConstrainerEnablerRecordType) throws OperationFailedException
QueueConstrainerEnabler
record Type.
Multiple record retrievals produce a nested OR
term.queueConstrainerEnablerRecordType
- a queue constrainer enabler
record typeNullArgumentException
-
queueConstrainerEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(queueConstrainerEnablerRecordType)
is
false
mandatory
- This method must be implemented.