public interface BrokerConstrainerEnablerQuery extends OsidEnablerQuery
This is the query for searching broker constrainer 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 |
clearRuledBrokerConstrainerIdTerms()
Clears the broker constrainer
Id query terms. |
void |
clearRuledBrokerConstrainerTerms()
Clears the broker constrainer query terms.
|
BrokerConstrainerEnablerQueryRecord |
getBrokerConstrainerEnablerQueryRecord(Type brokerConstrainerEnablerRecordType)
Gets the broker constrainer enabler query record corresponding to the
given
BrokerConstrainerEnabler record Type. |
DistributorQuery |
getDistributorQuery()
Gets the query for a distributor.
|
BrokerConstrainerQuery |
getRuledBrokerConstrainerQuery()
Gets the query for a broker constrainer.
|
void |
matchAnyRuledBrokerConstrainer(boolean match)
Matches enablers mapped to any broker constrainer.
|
void |
matchDistributorId(Id distributorId,
boolean match)
Matches enablers mapped to the distributor.
|
void |
matchRuledBrokerConstrainerId(Id brokerConstrainerId,
boolean match)
Matches enablers mapped to the broker constrainer.
|
boolean |
supportsDistributorQuery()
Tests if a
DistributorQuery is available. |
boolean |
supportsRuledBrokerConstrainerQuery()
Tests if a
BrokerConstrainerQuery 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 matchRuledBrokerConstrainerId(Id brokerConstrainerId, boolean match)
brokerConstrainerId
- the broker constrainer Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- brokerConstrainerId
is null
mandatory
- This method must be implemented. void clearRuledBrokerConstrainerIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledBrokerConstrainerQuery()
BrokerConstrainerQuery
is available. true
if a broker constrainer query is
available, false
otherwisemandatory
- This method must be implemented. BrokerConstrainerQuery getRuledBrokerConstrainerQuery()
OR
term.UnimplementedException
-
supportsRuledBrokerConstrainerQuery()
is false
optional
- This method must be implemented if
supportsRuledBrokerConstrainerQuery()
is
true.
void matchAnyRuledBrokerConstrainer(boolean match)
match
- true
for enablers mapped to any broker
constrainer, false
to match enablers mapped to
no broker constrainersmandatory
- This method must be implemented. void clearRuledBrokerConstrainerTerms()
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. BrokerConstrainerEnablerQueryRecord getBrokerConstrainerEnablerQueryRecord(Type brokerConstrainerEnablerRecordType) throws OperationFailedException
BrokerConstrainerEnabler
record Type.
Multiple record retrievals produce a nested OR
term.brokerConstrainerEnablerRecordType
- a broker constrainer
enabler record typeNullArgumentException
-
brokerConstrainerEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(brokerConstrainerEnablerRecordType)
is
false
mandatory
- This method must be implemented.