public interface BrokerProcessorQuery extends OsidProcessorQuery
This is the query for searching broker processors. 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 |
clearAllowsCompoundRequestsTerms()
Clears the allows compound requests query terms.
|
void |
clearAllowsProvisionExchangeTerms()
Clears the allows provision exchange query terms.
|
void |
clearDistributorIdTerms()
Clears the distributor
Id query terms. |
void |
clearDistributorTerms()
Clears the distributor query terms.
|
void |
clearFixedLeaseDurationTerms()
Clears the fixed lease duration query terms.
|
void |
clearLeasingTerms()
Clears the leasing query terms.
|
void |
clearMustReturnProvisionsTerms()
Clears the must return provisions query terms.
|
void |
clearRuledBrokerIdTerms()
Clears the broker
Id query terms. |
void |
clearRuledBrokerTerms()
Clears the broker query terms.
|
BrokerProcessorQueryRecord |
getBrokerProcessorQueryRecord(Type brokerProcessorRecordType)
Gets the broker processor query record corresponding to the given
BrokerProcessor record Type. |
DistributorQuery |
getDistributorQuery()
Gets the query for a distributor.
|
BrokerQuery |
getRuledBrokerQuery()
Gets the query for a broker.
|
void |
matchAllowsCompoundRequests(boolean match)
Matches brokers that allow comound requests.
|
void |
matchAllowsProvisionExchange(boolean match)
Matches brokers that allow provision exchange.
|
void |
matchAnyFixedLeaseDuration(boolean match)
Matches brokers with any fixed lease duration.
|
void |
matchAnyRuledBroker(boolean match)
Matches mapped to any broker.
|
void |
matchDistributorId(Id distributorId,
boolean match)
Matches mapped to the distributor.
|
void |
matchFixedLeaseDuration(Duration from,
Duration to,
boolean match)
Matches brokers that issue fixed duration leases between the given
durations inclusive.
|
void |
matchLeasing(boolean match)
Matches brokers that issue leases.
|
void |
matchMustReturnProvisions(boolean match)
Matches brokers that require provisions to be returned.
|
void |
matchRuledBrokerId(Id distributorId,
boolean match)
Matches mapped to the 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 matchLeasing(boolean match)
match
- true
to match brokers that issue leases,
false
to match brokers that issue permanent
provisionsmandatory
- This method must be implemented. void clearLeasingTerms()
mandatory
- This method must be implemented. void matchFixedLeaseDuration(Duration from, Duration to, boolean match)
from
- starting duration rangeto
- ending duration rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
mandatory
- This method must be implemented. void matchAnyFixedLeaseDuration(boolean match)
match
- true
to match brokers with any fixed
lease duration, returns, false
otherwisemandatory
- This method must be implemented. void clearFixedLeaseDurationTerms()
mandatory
- This method must be implemented. void matchMustReturnProvisions(boolean match)
match
- true
to match brokers that require
provision returns,, false
otherwisemandatory
- This method must be implemented. void clearMustReturnProvisionsTerms()
mandatory
- This method must be implemented. void matchAllowsProvisionExchange(boolean match)
match
- true
to match brokers that permit
provision exchange, false
otherwisemandatory
- This method must be implemented. void clearAllowsProvisionExchangeTerms()
mandatory
- This method must be implemented. void matchAllowsCompoundRequests(boolean match)
match
- true
to match brokers that permit
compound requests, false
otherwisemandatory
- This method must be implemented. void clearAllowsCompoundRequestsTerms()
mandatory
- This method must be implemented. 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 brokermandatory
- 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. BrokerProcessorQueryRecord getBrokerProcessorQueryRecord(Type brokerProcessorRecordType) throws OperationFailedException
BrokerProcessor
record Type.
Multiple
record retrievals produce a nested OR
term.brokerProcessorRecordType
- a broker processor record typeNullArgumentException
-
brokerProcessorRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(brokerProcessorRecordType)
is
false
mandatory
- This method must be implemented.