org.osid.provisioning.rules

Interface QueueProcessorQuery

All Superinterfaces:

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

public interface QueueProcessorQuery
extends OsidProcessorQuery

This is the query for searching queue processors. 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	clearAutomaticTerms() Clears the automatic query terms.
void	clearDistributorIdTerms() Clears the distributor Id query terms.
void	clearDistributorTerms() Clears the distributor query terms.
void	clearFifoTerms() Clears the fifo query terms.
void	clearRemovesProcessedQueueEntriesTerms() Clears the removes processed queue entries query terms.
void	clearRuledQueueIdTerms() Clears the queue Id query terms.
void	clearRuledQueueTerms() Clears the queue query terms.
DistributorQuery	getDistributorQuery() Gets the query for a distributor.
QueueProcessorQueryRecord	getQueueProcessorQueryRecord(Type queueProcessorRecordType) Gets the queue processor query record corresponding to the given QueueProcessor record Type.
QueueQuery	getRuledQueueQuery() Gets the query for a queue.
void	matchAnyRuledQueue(boolean match) Matches mapped to any queue.
void	matchAutomatic(boolean match) Matches automatic processors.
void	matchDistributorId(Id distributorId, boolean match) Matches mapped to the distributor.
void	matchFifo(boolean match) Matches first-in-first-out processors.
void	matchRemovesProcessedQueueEntries(boolean match) Matches processors that remove processed queue entries.
void	matchRuledQueueId(Id queueId, boolean match) Matches mapped to the queue.
boolean	supportsDistributorQuery() Tests if a DistributorQuery 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

matchAutomatic

void matchAutomatic(boolean match)

Matches automatic processors.

Parameters:

match - true to match automatic processors, false to match manual processors

Compliance:

mandatory - This method must be implemented.

clearAutomaticTerms

void clearAutomaticTerms()

Clears the automatic query terms.

Compliance:

mandatory - This method must be implemented.

matchFifo

void matchFifo(boolean match)

Matches first-in-first-out processors.

Parameters:

match - true to match fifo processors, false otherwise

Compliance:

mandatory - This method must be implemented.

clearFifoTerms

void clearFifoTerms()

Clears the fifo query terms.

Compliance:

mandatory - This method must be implemented.

matchRemovesProcessedQueueEntries

void matchRemovesProcessedQueueEntries(boolean match)

Matches processors that remove processed queue entries.

Parameters:

match - true to match removing queue entry processors, false otherwise

Compliance:

mandatory - This method must be implemented.

clearRemovesProcessedQueueEntriesTerms

void clearRemovesProcessedQueueEntriesTerms()

Clears the removes processed queue entries query terms.

Compliance:

mandatory - This method must be implemented.

matchRuledQueueId

void matchRuledQueueId(Id queueId,
                     boolean match)

Matches mapped to the 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 queue

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.

getQueueProcessorQueryRecord

QueueProcessorQueryRecord getQueueProcessorQueryRecord(Type queueProcessorRecordType)
                                                       throws OperationFailedException

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

Parameters:

queueProcessorRecordType - a queue processor record type

Returns:

the queue processor query record

Throws:

NullArgumentException - queueProcessorRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(queueProcessorRecordType) is false

Compliance:

mandatory - This method must be implemented.