org.osid.provisioning.rules

Interface PoolConstrainerQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidConstrainerQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidRuleQuery, Suppliable

public interface PoolConstrainerQuery
extends OsidConstrainerQuery

This is the query for searching pool constrainers. 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	clearRuledPoolIdTerms() Clears the pool Id query terms.
void	clearRuledPoolTerms() Clears the pool query terms.
DistributorQuery	getDistributorQuery() Gets the query for a distributor.
PoolConstrainerQueryRecord	getPoolConstrainerQueryRecord(Type poolConstrainerRecordType) Gets the pool constrainer query record corresponding to the given PoolConstrainer record Type.
PoolQuery	getRuledPoolQuery() Gets the query for a pool.
void	matchAnyRuledPool(boolean match) Matches mapped to any pool.
void	matchDistributorId(Id distributorId, boolean match) Matches mapped to the distributor.
void	matchRuledPoolId(Id distributorId, boolean match) Matches mapped to a pool.
boolean	supportsDistributorQuery() Tests if a DistributorQuery is available.
boolean	supportsRuledPoolQuery() Tests if a PoolQuery is available.

Methods inherited from interface org.osid.OsidRuleQuery

clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery

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

Method Detail

matchRuledPoolId

void matchRuledPoolId(Id distributorId,
                    boolean match)

Matches mapped to a pool.

Parameters:

distributorId - the pool Id

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

Throws:

NullArgumentException - distributorId is null

Compliance:

mandatory - This method must be implemented.

clearRuledPoolIdTerms

void clearRuledPoolIdTerms()

Clears the pool Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledPoolQuery

boolean supportsRuledPoolQuery()

Tests if a PoolQuery is available.

Returns:

true if a pool query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledPoolQuery

PoolQuery getRuledPoolQuery()

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

Returns:

the pool query

Throws:

UnimplementedException - supportsRuledPoolQuery() is false

Compliance:

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

matchAnyRuledPool

void matchAnyRuledPool(boolean match)

Matches mapped to any pool.

Parameters:

match - true for mapped to any pool, false to match mapped to no pools

Compliance:

mandatory - This method must be implemented.

clearRuledPoolTerms

void clearRuledPoolTerms()

Clears the pool query terms.

Compliance:

mandatory - This method must be implemented.

matchDistributorId

void matchDistributorId(Id distributorId,
                      boolean match)

Matches mapped to the distributor.

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.

getPoolConstrainerQueryRecord

PoolConstrainerQueryRecord getPoolConstrainerQueryRecord(Type poolConstrainerRecordType)
                                                         throws OperationFailedException

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

Parameters:

poolConstrainerRecordType - a pool constrainer record type

Returns:

the pool constrainer query record

Throws:

NullArgumentException - poolConstrainerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(poolConstrainerRecordType) is false

Compliance:

mandatory - This method must be implemented.