org.osid.tracking.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	clearFrontOfficeIdTerms() Clears the front office Id query terms.
void	clearFrontOfficeTerms() Clears the front office query terms.
void	clearRuledQueueIdTerms() Clears the queue Id query terms.
void	clearRuledQueueTerms() Clears the queue query terms.
FrontOfficeQuery	getFrontOfficeQuery() Gets the query for a front office.
QueueConstrainerQueryRecord	getQueueConstrainerQueryRecord(Type queueConstrainerRecordType) Gets the queue constrainer query record corresponding to the given QueueConstrainer record Type.
QueueQuery	getRuledQueueQuery() Gets the query for a queue.
void	matchAnyRuledQueue(boolean match) Matches constrainers mapped to any queue.
void	matchFrontOfficeId(Id frontOfficeId, boolean match) Matches constrainers mapped to the front office.
void	matchRuledQueueId(Id queueId, boolean match) Matches mapped to a queue.
boolean	supportsFrontOfficeQuery() Tests if an FrontOfficeQuery 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

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 constrainers mapped to any queue.

Parameters:

match - true for constrainers mapped to any queue, false to match constrainers 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.

matchFrontOfficeId

void matchFrontOfficeId(Id frontOfficeId,
                      boolean match)

Matches constrainers mapped to the front office.

Parameters:

frontOfficeId - the front office Id

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

Throws:

NullArgumentException - frontOfficeId is null

Compliance:

mandatory - This method must be implemented.

clearFrontOfficeIdTerms

void clearFrontOfficeIdTerms()

Clears the front office Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsFrontOfficeQuery

boolean supportsFrontOfficeQuery()

Tests if an FrontOfficeQuery is available.

Returns:

true if a front office query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getFrontOfficeQuery

FrontOfficeQuery getFrontOfficeQuery()

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

Returns:

the front office query

Throws:

UnimplementedException - supportsFrontOfficeQuery() is false

Compliance:

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

clearFrontOfficeTerms

void clearFrontOfficeTerms()

Clears the front office 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.