public interface BrokerConstrainerQuery extends OsidConstrainerQuery
This is the query for searching broker constrainers. 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 |
clearRuledBrokerIdTerms()
Clears the broker
Id query terms. |
void |
clearRuledBrokerTerms()
Clears the broker query terms.
|
BrokerConstrainerQueryRecord |
getBrokerConstrainerQueryRecord(Type brokerConstrainerRecordType)
Gets the broker constrainer query record corresponding to the given
BrokerConstrainer record Type. |
DistributorQuery |
getDistributorQuery()
Gets the query for a distributor.
|
BrokerQuery |
getRuledBrokerQuery()
Gets the query for a broker.
|
void |
matchAnyRuledBroker(boolean match)
Matches mapped to any broker.
|
void |
matchDistributorId(Id distributorId,
boolean match)
Matches mapped to the distributor.
|
void |
matchRuledBrokerId(Id distributorId,
boolean match)
Matches mapped to a broker.
|
boolean |
supportsDistributorQuery()
Tests if a
DistributorQuery is available. |
boolean |
supportsRuledBrokerQuery()
Tests if a
BrokerQuery 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 matchRuledBrokerId(Id distributorId, boolean match)
distributorId
- the broker Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- distributorId
is
null
mandatory
- This method must be implemented. void clearRuledBrokerIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledBrokerQuery()
BrokerQuery
is available. true
if a broker query is available,
false
otherwisemandatory
- This method must be implemented. BrokerQuery getRuledBrokerQuery()
OR
term.UnimplementedException
-
supportsRuledBrokerQuery()
is false
optional
- This method must be implemented if
supportsRuledBrokerQuery()
is true.
void matchAnyRuledBroker(boolean match)
match
- true
for mapped to any broker,
false
to match mapped to no brokersmandatory
- This method must be implemented. void clearRuledBrokerTerms()
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. BrokerConstrainerQueryRecord getBrokerConstrainerQueryRecord(Type brokerConstrainerRecordType) throws OperationFailedException
BrokerConstrainer
record Type.
Multiple
record retrievals produce a nested OR
term.brokerConstrainerRecordType
- a broker constrainer record typeNullArgumentException
-
brokerConstrainerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(brokerConstrainerRecordType)
is
false
mandatory
- This method must be implemented.