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 an AND term while multiple invocations of the same method produce a nested OR .

Method Summary

Modifier and Type	Method	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)	Sets the distributor Id for this query to match queues assigned to distributors.
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 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 OsidRuleQuery

clearConditionRecordTypeTerms, clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyConditionRecordType, matchAnyRule, matchConditionRecordType, matchRuleId, supportsRuleQuery

Modifier and Type	Method	Description
void	clearConditionRecordTypeTerms()	Clears the condition record Type query terms.
void	clearRuleIdTerms()	Clears all rule Id terms.
void	clearRuleTerms()	Clears all rule terms.
RuleQuery	getRuleQuery(boolean match)	Gets the query for the rule.
void	matchAnyConditionRecordType(boolean match)	Matches rules with any condition record type.
void	matchAnyRule(boolean match)	Match any associated rule.
void	matchConditionRecordType(Type conditionRecordType, boolean match)	Matches a condition record type.
void	matchRuleId(Id ruleId, boolean match)	Match the Id of the rule.
boolean	supportsRuleQuery()	Tests if a RuleQuery for the rule is available.

Method Details

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 {@code supportsRequiredProvisionPoolQuery()} is {@code 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 {@code supportsRuledQueueQuery()} is {@code 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)

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.

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.