org.osid.provisioning

Interface DistributorQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidCatalogQuery, OsidExtensibleQuery, OsidFederateableQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSourceableQuery, Suppliable

public interface DistributorQuery
extends OsidCatalogQuery

This is the query for searching distributors. 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	clearAncestorDistributorIdTerms() Clears the ancestor distributor Id query terms.
void	clearAncestorDistributorTerms() Clears the ancestor distributor query terms.
void	clearBrokerIdTerms() Clears the broker Id query terms.
void	clearBrokerTerms() Clears the broker query terms.
void	clearDescendantDistributorIdTerms() Clears the descendant distributor Id query terms.
void	clearDescendantDistributorTerms() Clears the descendant distributor query terms.
void	clearPoolIdTerms() Clears the pool Id query terms.
void	clearPoolTerms() Clears the pool query terms.
void	clearProvisionIdTerms() Clears the provision Id query terms.
void	clearProvisionTerms() Clears the provision query terms.
void	clearQueueIdTerms() Clears the queue Id query terms.
void	clearQueueTerms() Clears the queue query terms.
DistributorQuery	getAncestorDistributorQuery() Gets the query for a distributor.
BrokerQuery	getBrokerQuery() Gets the query for a broker.
DistributorQuery	getDescendantDistributorQuery() Gets the query for a distributor/ Multiple retrievals produce a nested OR term.
DistributorQueryRecord	getDistributorQueryRecord(Type distributorRecordType) Gets the distributor query record corresponding to the given Distributor record Type.
PoolQuery	getPoolQuery() Gets the query for a pool.
ProvisionQuery	getProvisionQuery() Gets the query for a provision.
QueueQuery	getQueueQuery() Gets the query for a queue.
void	matchAncestorDistributorId(Id distributorId, boolean match) Sets the distributor Id for this query to match distributors that have the specified distributor as an ancestor.
void	matchAnyAncestorDistributor(boolean match) Matches distributors with any ancestor.
void	matchAnyBroker(boolean match) Matches distributors with any broker.
void	matchAnyDescendantDistributor(boolean match) Matches distributors with any descendant.
void	matchAnyPool(boolean match) Matches brokers with any pool.
void	matchAnyProvision(boolean match) Matches distributors that have any provision.
void	matchAnyQueue(boolean match) Matches distributors with any queue.
void	matchBrokerId(Id brokerId, boolean match) Sets the broker Id for this query.
void	matchDescendantDistributorId(Id distributorId, boolean match) Sets the distributor Id for this query to match distributors that have the specified distributor as a descendant.
void	matchPoolId(Id poolId, boolean match) Sets the pool Id for this query.
void	matchProvisionId(Id provisionId, boolean match) Sets the provision Id for this query to match distributors that have a related provision.
void	matchQueueId(Id queueId, boolean match) Sets the queue Id for this query.
boolean	supportsAncestorDistributorQuery() Tests if a DistributorQuery is available.
boolean	supportsBrokerQuery() Tests if an BrokerQuery is available.
boolean	supportsDescendantDistributorQuery() Tests if a DistributorQuery is available.
boolean	supportsPoolQuery() Tests if a PoolQuery is available.
boolean	supportsProvisionQuery() Tests if a ProvisionQuery 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.OsidSourceableQuery

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

Method Detail

matchBrokerId

void matchBrokerId(Id brokerId,
                 boolean match)

Sets the broker Id for this query.

Parameters:

brokerId - the broker Id

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

Throws:

NullArgumentException - brokerId is null

Compliance:

mandatory - This method must be implemented.

clearBrokerIdTerms

void clearBrokerIdTerms()

Clears the broker Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsBrokerQuery

boolean supportsBrokerQuery()

Tests if an BrokerQuery is available.

Returns:

true if a broker query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getBrokerQuery

BrokerQuery getBrokerQuery()

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

Returns:

the broker query

Throws:

UnimplementedException - supportsBrokerQuery() is false

Compliance:

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

matchAnyBroker

void matchAnyBroker(boolean match)

Matches distributors with any broker.

Parameters:

match - true to match distributors with any broker, false to match distributors with no broker

Compliance:

mandatory - This method must be implemented.

clearBrokerTerms

void clearBrokerTerms()

Clears the broker 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 supportsQueueQuery() is true.

matchAnyQueue

void matchAnyQueue(boolean match)

Matches distributors with any queue.

Parameters:

match - true to match distributors with any queue, false to match distributors 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 distributors with any pool, false to match distributors 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.

matchProvisionId

void matchProvisionId(Id provisionId,
                    boolean match)

Sets the provision Id for this query to match distributors that have a related provision.

Parameters:

provisionId - a provision Id

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

Throws:

NullArgumentException - provisionId is null

Compliance:

mandatory - This method must be implemented.

clearProvisionIdTerms

void clearProvisionIdTerms()

Clears the provision Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsProvisionQuery

boolean supportsProvisionQuery()

Tests if a ProvisionQuery is available.

Returns:

true if a provision query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getProvisionQuery

ProvisionQuery getProvisionQuery()

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

Returns:

the provision query

Throws:

UnimplementedException - supportsProvisionQuery() is false

Compliance:

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

matchAnyProvision

void matchAnyProvision(boolean match)

Matches distributors that have any provision.

Parameters:

match - true to match distributors with any provision, false to match distributors with no provision

Compliance:

mandatory - This method must be implemented.

clearProvisionTerms

void clearProvisionTerms()

Clears the provision query terms.

Compliance:

mandatory - This method must be implemented.

matchAncestorDistributorId

void matchAncestorDistributorId(Id distributorId,
                              boolean match)

Sets the distributor Id for this query to match distributors that have the specified distributor as an ancestor.

Parameters:

distributorId - a distributor Id

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

Throws:

NullArgumentException - distributorId is null

Compliance:

mandatory - This method must be implemented.

clearAncestorDistributorIdTerms

void clearAncestorDistributorIdTerms()

Clears the ancestor distributor Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorDistributorQuery

boolean supportsAncestorDistributorQuery()

Tests if a DistributorQuery is available.

Returns:

true if a distributor query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorDistributorQuery

DistributorQuery getAncestorDistributorQuery()

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

Returns:

the distributor query

Throws:

UnimplementedException - supportsAncestorDistributorQuery() is false

Compliance:

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

matchAnyAncestorDistributor

void matchAnyAncestorDistributor(boolean match)

Matches distributors with any ancestor.

Parameters:

match - true to match distributors with any ancestor, false to match root distributors

Compliance:

mandatory - This method must be implemented.

clearAncestorDistributorTerms

void clearAncestorDistributorTerms()

Clears the ancestor distributor query terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantDistributorId

void matchDescendantDistributorId(Id distributorId,
                                boolean match)

Sets the distributor Id for this query to match distributors that have the specified distributor as a descendant.

Parameters:

distributorId - a distributor Id

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

Throws:

NullArgumentException - distributorId is null

Compliance:

mandatory - This method must be implemented.

clearDescendantDistributorIdTerms

void clearDescendantDistributorIdTerms()

Clears the descendant distributor Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantDistributorQuery

boolean supportsDescendantDistributorQuery()

Tests if a DistributorQuery is available.

Returns:

true if a distributor query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantDistributorQuery

DistributorQuery getDescendantDistributorQuery()

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

Returns:

the distributor query

Throws:

UnimplementedException - supportsDescendantDistributorQuery() is false

Compliance:

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

matchAnyDescendantDistributor

void matchAnyDescendantDistributor(boolean match)

Matches distributors with any descendant.

Parameters:

match - true to match distributors with any descendant, false to match leaf distributors

Compliance:

mandatory - This method must be implemented.

clearDescendantDistributorTerms

void clearDescendantDistributorTerms()

Clears the descendant distributor query terms.

Compliance:

mandatory - This method must be implemented.

getDistributorQueryRecord

DistributorQueryRecord getDistributorQueryRecord(Type distributorRecordType)
                                                 throws OperationFailedException

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

Parameters:

distributorRecordType - a distributor record type

Returns:

the distributor query record

Throws:

NullArgumentException - distributorRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(distributorRecordType) is false

Compliance:

mandatory - This method must be implemented.