public interface BrokerQuery extends OsidGovernatorQuery
This is the query for searching brokers. 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 |
clearPoolIdTerms()
Clears the pool
Id query terms. |
void |
clearPoolTerms()
Clears the pool query terms.
|
void |
clearQueueIdTerms()
Clears the queue
Id query terms. |
void |
clearQueueTerms()
Clears the queue query terms.
|
BrokerQueryRecord |
getBrokerQueryRecord(Type brokerRecordType)
Gets the broker query record corresponding to the given
Broker
record Type. |
DistributorQuery |
getDistributorQuery()
Gets the query for a distributor.
|
PoolQuery |
getPoolQuery()
Gets the query for a pool.
|
QueueQuery |
getQueueQuery()
Gets the query for a queue.
|
void |
matchAnyPool(boolean match)
Matches brokers with any pool.
|
void |
matchAnyQueue(boolean match)
Matches brokers with any queue.
|
void |
matchDistributorId(Id distributorId,
boolean match)
Sets the distributor
Id for this query to match queues
assigned to distributors. |
void |
matchPoolId(Id poolId,
boolean match)
Sets the pool
Id for this query. |
void |
matchQueueId(Id queueId,
boolean match)
Sets the queue
Id for this query. |
boolean |
supportsDistributorQuery()
Tests if a
DistributorQuery is available. |
boolean |
supportsPoolQuery()
Tests if a
PoolQuery is available. |
boolean |
supportsQueueQuery()
Tests if a
QueueQuery is available. |
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
clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery
void matchQueueId(Id queueId, boolean match)
Id
for this query.queueId
- the queue Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- queueId
is
null
mandatory
- This method must be implemented. void clearQueueIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsQueueQuery()
QueueQuery
is available. true
if a queue query is available,
false
otherwisemandatory
- This method must be implemented. QueueQuery getQueueQuery()
OR
term.UnimplementedException
- supportsQueueQuery()
is false
optional
- This method must be implemented if
supportsQueueQuery()
is true.
void matchAnyQueue(boolean match)
match
- true
to match brokers with any queue,
false
to match brokers with no queuemandatory
- This method must be implemented. void clearQueueTerms()
mandatory
- This method must be implemented. void matchPoolId(Id poolId, boolean match)
Id
for this query.poolId
- the pool Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- poolId
is
null
mandatory
- This method must be implemented. void clearPoolIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsPoolQuery()
PoolQuery
is available. true
if a pool query is available, false
otherwisemandatory
- This method must be implemented. PoolQuery getPoolQuery()
OR
term.UnimplementedException
- supportsPoolQuery()
is false
optional
- This method must be implemented if
supportsPoolQuery()
is true.
void matchAnyPool(boolean match)
match
- true
to match brokers with any pool,
false
to match brokers with no poolmandatory
- This method must be implemented. void clearPoolTerms()
mandatory
- This method must be implemented. void matchDistributorId(Id distributorId, boolean match)
Id
for this query to match queues
assigned to distributors.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. BrokerQueryRecord getBrokerQueryRecord(Type brokerRecordType) throws OperationFailedException
Broker
record Type.
Multiple record retrievals produce
a nested OR
term.brokerRecordType
- a broker record typeNullArgumentException
- brokerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(brokerRecordType)
is false
mandatory
- This method must be implemented.