org.osid.provisioning.rules

Interface QueueProcessorEnablerQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidEnablerQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidRuleQuery, OsidTemporalQuery, Suppliable

public interface QueueProcessorEnablerQuery
extends OsidEnablerQuery

This is the query for searching queue processor enablers. 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	clearRuledQueueProcessorIdTerms() Clears the queue processor Id query terms.
void	clearRuledQueueProcessorTerms() Clears the queue processor query terms.
DistributorQuery	getDistributorQuery() Gets the query for a distributor.
QueueProcessorEnablerQueryRecord	getQueueProcessorEnablerQueryRecord(Type queueProcessorEnablerRecordType) Gets the queue processor enabler query record corresponding to the given QueueProcessorEnabler record Type.
QueueProcessorQuery	getRuledQueueProcessorQuery() Gets the query for a queue processor.
void	matchAnyRuledQueueProcessor(boolean match) Matches enablers mapped to any queue processor.
void	matchDistributorId(Id distributorId, boolean match) Matches enablers mapped to the distributor.
void	matchRuledQueueProcessorId(Id queueProcessorId, boolean match) Matches enablers mapped to the queue processor.
boolean	supportsDistributorQuery() Tests if a DistributorQuery is available.
boolean	supportsRuledQueueProcessorQuery() Tests if a QueueProcessorQuery is available.

Methods inherited from interface org.osid.OsidEnablerQuery

clearCyclicEventIdTerms, clearCyclicEventTerms, clearDemographicIdTerms, clearDemographicTerms, clearEventIdTerms, clearEventTerms, clearScheduleIdTerms, clearScheduleTerms, getCyclicEventQuery, getDemographicQuery, getEventQuery, getScheduleQuery, matchAnyCyclicEvent, matchAnyDemographic, matchAnyEvent, matchAnySchedule, matchCyclicEventId, matchDemographicId, matchEventId, matchScheduleId, supportsCyclicEventQuery, supportsDemographicQuery, supportsEventQuery, supportsScheduleQuery

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

Methods inherited from interface org.osid.OsidTemporalQuery

clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

Method Detail

matchRuledQueueProcessorId

void matchRuledQueueProcessorId(Id queueProcessorId,
                              boolean match)

Matches enablers mapped to the queue processor.

Parameters:

queueProcessorId - the queue processor Id

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

Throws:

NullArgumentException - queueProcessorId is null

Compliance:

mandatory - This method must be implemented.

clearRuledQueueProcessorIdTerms

void clearRuledQueueProcessorIdTerms()

Clears the queue processor Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledQueueProcessorQuery

boolean supportsRuledQueueProcessorQuery()

Tests if a QueueProcessorQuery is available.

Returns:

true if a queue processor query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledQueueProcessorQuery

QueueProcessorQuery getRuledQueueProcessorQuery()

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

Returns:

the queue processor query

Throws:

UnimplementedException - supportsRuledQueueProcessorQuery() is false

Compliance:

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

matchAnyRuledQueueProcessor

void matchAnyRuledQueueProcessor(boolean match)

Matches enablers mapped to any queue processor.

Parameters:

match - true for enablers mapped to any queue processor, false to match enablers mapped to no queue processors

Compliance:

mandatory - This method must be implemented.

clearRuledQueueProcessorTerms

void clearRuledQueueProcessorTerms()

Clears the queue processor query terms.

Compliance:

mandatory - This method must be implemented.

matchDistributorId

void matchDistributorId(Id distributorId,
                      boolean match)

Matches enablers 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.

getQueueProcessorEnablerQueryRecord

QueueProcessorEnablerQueryRecord getQueueProcessorEnablerQueryRecord(Type queueProcessorEnablerRecordType)
                                                                     throws OperationFailedException

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

Parameters:

queueProcessorEnablerRecordType - a queue processor enabler record type

Returns:

the queue processor enabler query record

Throws:

NullArgumentException - queueProcessorEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(queueProcessorEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.