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

Modifier and Type	Method	Description
void	clearBrokerageIdTerms()	Clears the brokerage Id query terms.
void	clearBrokerageTerms()	Clears the brokerage query terms.
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.
ResourceQuery	getBrokerageQuery()	Gets the query for a brokerage.
BrokerQueryRecord	getBrokerQueryRecord(Type brokerRecordType)	Gets the broker query record corresponding to the given Broker record Type .Multiple record retrievals produce a nested OR term.
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	matchAnyBrokerage(boolean match)	Matches brokers that have any brokerage.
void	matchAnyPool(boolean match)	Matches brokers with any pool.
void	matchAnyQueue(boolean match)	Matches brokers with any queue.
void	matchBrokerageId(Id brokerageId, boolean match)	Sets the brokerage Id for this query.
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	supportsBrokerageQuery()	Tests if a ResourceQuery is available.
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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from interface 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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidOperableQuery

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

Modifier and Type	Method	Description
void	clearActiveTerms()	Clears the active query terms.
void	clearDisabledTerms()	Clears the administratively disabled query terms.
void	clearEnabledTerms()	Clears the administratively enabled query terms.
void	clearOperationalTerms()	Clears the operational query terms.
void	matchActive(boolean match)	Matches active.
void	matchDisabled(boolean match)	Matches administratively disabled.
void	matchEnabled(boolean match)	Matches administratively enabled.
void	matchOperational(boolean match)	Matches operational operables.

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Methods inherited from interface OsidSourceableQuery

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

Modifier and Type	Method	Description
void	clearBrandingIdTerms()	Clears all asset Id terms.
void	clearBrandingTerms()	Clears all branding terms.
void	clearLicenseTerms()	Clears all license terms.
void	clearProviderIdTerms()	Clears all provider Id terms.
void	clearProviderTerms()	Clears all provider terms.
AssetQuery	getBrandingQuery(boolean match)	Gets the query for an asset.
ResourceQuery	getProviderQuery(boolean match)	Gets the query for the provider.
void	matchAnyBranding(boolean match)	Match sourceables with any branding.
void	matchAnyLicense(boolean match)	Matches any object with a license.
void	matchAnyProvider(boolean match)	Match sourceables with a provider value.
void	matchBrandingId(Id assetId, boolean match)	Match the Id of an asset used for branding.
void	matchLicense(String license, Type stringMatchType, boolean match)	Adds a license to match.
void	matchProviderId(Id resourceId, boolean match)	Match the Id of the provider resource.
boolean	supportsBrandingQuery()	Tests if an AssetQuery for the branding is available.
boolean	supportsProviderQuery()	Tests if a ResourceQuery for the provider is available.

Method Details

matchBrokerageId

void matchBrokerageId(Id brokerageId,
 boolean match)

Sets the brokerage Id for this query.

Parameters:

brokerageId - the brokerage Id

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

Throws:

NullArgumentException - brokerageId is null

Compliance:

mandatory - This method must be implemented.

clearBrokerageIdTerms

void clearBrokerageIdTerms()

Clears the brokerage Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsBrokerageQuery

boolean supportsBrokerageQuery()

Tests if a ResourceQuery is available.

Returns:

true if a brokerage query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getBrokerageQuery

ResourceQuery getBrokerageQuery()

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

Returns:

the brokerage query

Throws:

UnimplementedException - supportsBrokerageQuery() is false

Compliance:

mandatory - This method must be implemented.

matchAnyBrokerage

void matchAnyBrokerage(boolean match)

Matches brokers that have any brokerage.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearBrokerageTerms

void clearBrokerageTerms()

Clears the brokerage query terms.

Compliance:

mandatory - This method must be implemented.

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 {@code supportsQueueQuery()} is {@code 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 {@code supportsPoolQuery()} is {@code 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 {@code supportsDistributorQuery()} is {@code 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.