public interface BrokerProcessorEnablerQuery extends OsidEnablerQuery
This is the query for searching broker processor enablers. 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 |
clearDistributorIdTerms()
Clears the distributor
Id query terms. |
void |
clearDistributorTerms()
Clears the distributor query terms.
|
void |
clearRuledBrokerProcessorIdTerms()
Clears the broker processor
Id query terms. |
void |
clearRuledBrokerProcessorTerms()
Clears the broker processor query terms.
|
BrokerProcessorEnablerQueryRecord |
getBrokerProcessorEnablerQueryRecord(Type brokerProcessorEnablerRecordType)
Gets the broker processor enabler query record corresponding to the
given
BrokerProcessorEnabler record Type. |
DistributorQuery |
getDistributorQuery()
Gets the query for a distributor.
|
BrokerProcessorQuery |
getRuledBrokerProcessorQuery()
Gets the query for a broker processor.
|
void |
matchAnyRuledBrokerProcessor(boolean match)
Matches enablers mapped to any broker processor.
|
void |
matchDistributorId(Id distributorId,
boolean match)
Matches enablers mapped to the distributor.
|
void |
matchRuledBrokerProcessorId(Id brokerProcessorId,
boolean match)
Matches enablers mapped to the broker processor.
|
boolean |
supportsDistributorQuery()
Tests if a
DistributorQuery is available. |
boolean |
supportsRuledBrokerProcessorQuery()
Tests if a
BrokerProcessorQuery 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 matchRuledBrokerProcessorId(Id brokerProcessorId, boolean match)
brokerProcessorId
- the broker processor Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- brokerProcessorId
is null
mandatory
- This method must be implemented. void clearRuledBrokerProcessorIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledBrokerProcessorQuery()
BrokerProcessorQuery
is available. true
if a broker processor query is available,
false
otherwisemandatory
- This method must be implemented. BrokerProcessorQuery getRuledBrokerProcessorQuery()
OR
term.UnimplementedException
-
supportsRuledBrokerProcessorQuery()
is false
optional
- This method must be implemented if
supportsRuledBrokerProcessorQuery()
is
true.
void matchAnyRuledBrokerProcessor(boolean match)
match
- true
for enablers mapped to any broker
processor, false
to match enablers mapped to no
broker processorsmandatory
- This method must be implemented. void clearRuledBrokerProcessorTerms()
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. BrokerProcessorEnablerQueryRecord getBrokerProcessorEnablerQueryRecord(Type brokerProcessorEnablerRecordType) throws OperationFailedException
BrokerProcessorEnabler
record Type.
Multiple record retrievals produce a nested OR
term.brokerProcessorEnablerRecordType
- a broker processor enabler
record typeNullArgumentException
-
brokerProcessorEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(brokerProcessorEnablerRecordType)
is
false
mandatory
- This method must be implemented.