org.osid.provisioning.rules

Interface QueueConstrainerQuery

All Superinterfaces:

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

public interface QueueConstrainerQuery
extends OsidConstrainerQuery

This is the query for searching queue constrainers. Each method match specifies a 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	clearRequiredProvisionPoolIdTerms() Clears the required provision pool Id query terms.
void	clearRequiredProvisionPoolTerms() Clears the required provision pool query terms.
void	clearRequiresProvisionsTerms() Clears the requires provisions query terms.
void	clearRuledQueueIdTerms() Clears the queue Id query terms.
void	clearRuledQueueTerms() Clears the queue query terms.
void	clearSizeLimitTerms() Clears the size limit query terms.
DistributorQuery	getDistributorQuery() Gets the query for a distributor.
QueueConstrainerQueryRecord	getQueueConstrainerQueryRecord(Type queueConstrainerRecordType) Gets the queue constrainer query record corresponding to the given QueueConstrainer record Type.
PoolQuery	getRequiredProvisionPoolQuery() Gets the query for a Pool.
QueueQuery	getRuledQueueQuery() Gets the query for a queue.
void	matchAnyRequiredProvisionPool(boolean match) Matches queues that have any required provision pool.
void	matchAnyRuledQueue(boolean match) Matches mapped to any queue.
void	matchAnySizeLimit(boolean match) Matches queues with any known size limit.
void	matchDistributorId(Id distributorId, boolean match) Matches mapped to the distributor.
void	matchRequiredProvisionPoolId(Id poolId, boolean match) Sets the required provision pool Id for this query.
void	matchRequiresProvisions(boolean match) Matches constraints that require provisions.
void	matchRuledQueueId(Id queueId, boolean match) Matches mapped to a queue.
void	matchSizeLimit(long start, long end, boolean match) Matches queues of the given size limit inclusive.
boolean	supportsDistributorQuery() Tests if a DistributorQuery is available.
boolean	supportsRequiredProvisionPoolQuery() Tests if a PoolQuery is available.
boolean	supportsRuledQueueQuery() Tests if a QueueQuery 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

matchSizeLimit

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

Matches queues of the given size limit 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.

matchAnySizeLimit

void matchAnySizeLimit(boolean match)

Matches queues with any known size limit.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearSizeLimitTerms

void clearSizeLimitTerms()

Clears the size limit query terms.

Compliance:

mandatory - This method must be implemented.

matchRequiresProvisions

void matchRequiresProvisions(boolean match)

Matches constraints that require provisions.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearRequiresProvisionsTerms

void clearRequiresProvisionsTerms()

Clears the requires provisions query terms.

Compliance:

mandatory - This method must be implemented.

matchRequiredProvisionPoolId

void matchRequiredProvisionPoolId(Id poolId,
                                boolean match)

Sets the required provision pool Id for this query.

Parameters:

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

clearRequiredProvisionPoolIdTerms

void clearRequiredProvisionPoolIdTerms()

Clears the required provision pool Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRequiredProvisionPoolQuery

boolean supportsRequiredProvisionPoolQuery()

Tests if a PoolQuery is available.

Returns:

true if a required provision pool query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRequiredProvisionPoolQuery

PoolQuery getRequiredProvisionPoolQuery()

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

Returns:

the required provision pool query

Throws:

UnimplementedException - supportsRequiredProvisionPoolQuery() is false

Compliance:

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

matchAnyRequiredProvisionPool

void matchAnyRequiredProvisionPool(boolean match)

Matches queues that have any required provision pool.

Parameters:

match - true to match queues with any required provision pool, false to match queues with no required provision pool

Compliance:

mandatory - This method must be implemented.

clearRequiredProvisionPoolTerms

void clearRequiredProvisionPoolTerms()

Clears the required provision pool query terms.

Compliance:

mandatory - This method must be implemented.

matchRuledQueueId

void matchRuledQueueId(Id queueId,
                     boolean match)

Matches mapped to a queue.

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.

clearRuledQueueIdTerms

void clearRuledQueueIdTerms()

Clears the queue Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledQueueQuery

boolean supportsRuledQueueQuery()

Tests if a QueueQuery is available.

Returns:

true if a queue query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledQueueQuery

QueueQuery getRuledQueueQuery()

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

Returns:

the queue query

Throws:

UnimplementedException - supportsRuledQueueQuery() is false

Compliance:

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

matchAnyRuledQueue

void matchAnyRuledQueue(boolean match)

Matches mapped to any queue.

Parameters:

match - true for mapped to any queue, false to match mapped to no queues

Compliance:

mandatory - This method must be implemented.

clearRuledQueueTerms

void clearRuledQueueTerms()

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

getQueueConstrainerQueryRecord

QueueConstrainerQueryRecord getQueueConstrainerQueryRecord(Type queueConstrainerRecordType)
                                                           throws OperationFailedException

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

Parameters:

queueConstrainerRecordType - a queue constrainer record type

Returns:

the queue constrainer query record

Throws:

NullArgumentException - queueConstrainerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(queueConstrainerRecordType) is false

Compliance:

mandatory - This method must be implemented.