org.osid.provisioning

Interface PoolQuery

All Superinterfaces:

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

public interface PoolQuery
extends OsidGovernatorQuery, OsidSubjugateableQuery

This is the query for searching pools. 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	clearBrokerIdTerms() Clears the broker Id query terms.
void	clearBrokerTerms() Clears the broker query terms.
void	clearDistributorIdTerms() Clears the distributor Id query terms.
void	clearDistributorTerms() Clears the distributor query terms.
void	clearProvisionableIdTerms() Clears the provisionable Id query terms.
void	clearProvisionableTerms() Clears the provisionable query terms.
void	clearSizeTerms() Clears the size query terms.
BrokerQuery	getBrokerQuery() Gets the query for a broker.
DistributorQuery	getDistributorQuery() Gets the query for a distributor.
PoolQueryRecord	getPoolQueryRecord(Type poolRecordType) Gets the pool query record corresponding to the given Pool record Type.
ProvisionableQuery	getProvisionableQuery() Gets the query for a PoolQntry.
void	matchAnyProvisionable(boolean match) Matches pools that have any provisionable.
void	matchAnySize(boolean match) Matches pools with any known size.
void	matchBrokerId(Id brokerId, boolean match) Sets the broker Id for this query.
void	matchDistributorId(Id distributorId, boolean match) Sets the distributor Id for this query to match queues assigned to distributors.
void	matchProvisionableId(Id provisionableId, boolean match) Sets the provisionable Id for this query.
void	matchSize(long start, long end, boolean match) Matches pools of the given size inclusive.
boolean	supportsBrokerQuery() Tests if a BrokerQuery is available.
boolean	supportsDistributorQuery() Tests if a DistributorQuery is available.
boolean	supportsProvisionableQuery() Tests if a ProvisionableQuery 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

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 a 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.

clearBrokerTerms

void clearBrokerTerms()

Clears the broker query terms.

Compliance:

mandatory - This method must be implemented.

matchProvisionableId

void matchProvisionableId(Id provisionableId,
                        boolean match)

Sets the provisionable Id for this query.

Parameters:

provisionableId - the provisionable Id

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

Throws:

NullArgumentException - provisionableId is null

Compliance:

mandatory - This method must be implemented.

clearProvisionableIdTerms

void clearProvisionableIdTerms()

Clears the provisionable Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsProvisionableQuery

boolean supportsProvisionableQuery()

Tests if a ProvisionableQuery is available.

Returns:

true if a provisionable query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getProvisionableQuery

ProvisionableQuery getProvisionableQuery()

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

Returns:

the provisionable query

Throws:

UnimplementedException - supportsProvisionableQuery() is false

Compliance:

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

matchAnyProvisionable

void matchAnyProvisionable(boolean match)

Matches pools that have any provisionable.

Parameters:

match - true to match pools with any provisionable, false to match pools with no provisionable

Compliance:

mandatory - This method must be implemented.

clearProvisionableTerms

void clearProvisionableTerms()

Clears the provisionable query terms.

Compliance:

mandatory - This method must be implemented.

matchSize

void matchSize(long start,
             long end,
             boolean match)

Matches pools of the given size inclusive.

Parameters:

start - start of range

end - end of range

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

Throws:

InvalidArgumentException - start is greater than end

Compliance:

mandatory - This method must be implemented.

matchAnySize

void matchAnySize(boolean match)

Matches pools with any known size.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearSizeTerms

void clearSizeTerms()

Clears the size 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.

getPoolQueryRecord

PoolQueryRecord getPoolQueryRecord(Type poolRecordType)
                                   throws OperationFailedException

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

Parameters:

poolRecordType - a pool record type

Returns:

the pool query record

Throws:

NullArgumentException - poolRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(poolRecordType) is false

Compliance:

mandatory - This method must be implemented.