org.osid.provisioning

Interface BrokerQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidGovernatorQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidSourceableQuery, Suppliable

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidObjectQuery

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

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidOperableQuery

clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational

Methods inherited from interface org.osid.OsidSourceableQuery

clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery

Method Detail

matchQueueId

void matchQueueId(Id queueId,
                boolean match)

Sets the queue Id for this query.

Parameters:

queueId - the queue Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - queueId is null

Compliance:

mandatory - This method must be implemented.

clearQueueIdTerms

void clearQueueIdTerms()

Clears the queue Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsQueueQuery

boolean supportsQueueQuery()

Tests if a QueueQuery is available.

Returns:

true if a queue query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getQueueQuery

QueueQuery getQueueQuery()

Gets the query for a queue. Multiple retrievals produce a nested OR term.

Returns:

the queue query

Throws:

UnimplementedException - supportsQueueQuery() is false

Compliance:

optional - This method must be implemented if supportsQueueQuery() is true.

matchAnyQueue

void matchAnyQueue(boolean match)

Matches brokers with any queue.

Parameters:

match - true to match brokers with any queue, false to match brokers with no queue

Compliance:

mandatory - This method must be implemented.

clearQueueTerms

void clearQueueTerms()

Clears the queue query terms.

Compliance:

mandatory - This method must be implemented.

matchPoolId

void matchPoolId(Id poolId,
               boolean match)

Sets the pool Id for this query.

Parameters:

poolId - the pool Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - poolId is null

Compliance:

mandatory - This method must be implemented.

clearPoolIdTerms

void clearPoolIdTerms()

Clears the pool Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsPoolQuery

boolean supportsPoolQuery()

Tests if a PoolQuery is available.

Returns:

true if a pool query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getPoolQuery

PoolQuery getPoolQuery()

Gets the query for a pool. Multiple retrievals produce a nested OR term.

Returns:

the pool query

Throws:

UnimplementedException - supportsPoolQuery() is false

Compliance:

optional - This method must be implemented if supportsPoolQuery() is true.

matchAnyPool

void matchAnyPool(boolean match)

Matches brokers with any pool.

Parameters:

match - true to match brokers with any pool, false to match brokers with no pool

Compliance:

mandatory - This method must be implemented.

clearPoolTerms

void clearPoolTerms()

Clears the pool query terms.

Compliance:

mandatory - This method must be implemented.

matchDistributorId

void matchDistributorId(Id distributorId,
                      boolean match)

Sets the distributor Id for this query to match queues assigned to distributors.

Parameters:

distributorId - the distributor Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - distributorId is null

Compliance:

mandatory - This method must be implemented.

clearDistributorIdTerms

void clearDistributorIdTerms()

Clears the distributor Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsDistributorQuery

boolean supportsDistributorQuery()

Tests if a DistributorQuery is available.

Returns:

true if a distributor query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDistributorQuery

DistributorQuery getDistributorQuery()

Gets the query for a distributor. Multiple retrievals produce a nested OR term.

Returns:

the distributor query

Throws:

UnimplementedException - supportsDistributorQuery() is false

Compliance:

optional - This method must be implemented if supportsDistributorQuery() is true.

clearDistributorTerms

void clearDistributorTerms()

Clears the distributor query terms.

Compliance:

mandatory - This method must be implemented.

getBrokerQueryRecord

BrokerQueryRecord getBrokerQueryRecord(Type brokerRecordType)
                                       throws OperationFailedException

Gets the broker query record corresponding to the given Broker record Type. Multiple record retrievals produce a nested OR term.

Parameters:

brokerRecordType - a broker record type

Returns:

the broker query record

Throws:

NullArgumentException - brokerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(brokerRecordType) is false

Compliance:

mandatory - This method must be implemented.