org.osid.provisioning.rules

Interface QueueConstrainerEnablerQuery

All Superinterfaces:

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

public interface QueueConstrainerEnablerQuery
extends OsidEnablerQuery

This is the query for searching queue constrainer 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	clearRuledQueueConstrainerIdTerms() Clears the queue constrainer Id query terms.
void	clearRuledQueueConstrainerTerms() Clears the queue constrainer query terms.
DistributorQuery	getDistributorQuery() Gets the query for a distributor.
QueueConstrainerEnablerQueryRecord	getQueueConstrainerEnablerQueryRecord(Type queueConstrainerEnablerRecordType) Gets the queue constrainer enabler query record corresponding to the given QueueConstrainerEnabler record Type.
QueueConstrainerQuery	getRuledQueueConstrainerQuery() Gets the query for a queue constrainer.
void	matchAnyRuledQueueConstrainer(boolean match) Matches enablers mapped to any queue constrainer.
void	matchDistributorId(Id distributorId, boolean match) Matches enablers mapped to the distributor.
void	matchRuledQueueConstrainerId(Id queueConstrainerId, boolean match) Matches enablers mapped to the queue constrainer.
boolean	supportsDistributorQuery() Tests if a DistributorQuery is available.
boolean	supportsRuledQueueConstrainerQuery() Tests if a QueueConstrainerQuery 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

matchRuledQueueConstrainerId

void matchRuledQueueConstrainerId(Id queueConstrainerId,
                                boolean match)

Matches enablers mapped to the queue constrainer.

Parameters:

queueConstrainerId - the queue constrainer Id

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

Throws:

NullArgumentException - queueConstrainerId is null

Compliance:

mandatory - This method must be implemented.

clearRuledQueueConstrainerIdTerms

void clearRuledQueueConstrainerIdTerms()

Clears the queue constrainer Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledQueueConstrainerQuery

boolean supportsRuledQueueConstrainerQuery()

Tests if a QueueConstrainerQuery is available.

Returns:

true if a queue constrainer query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledQueueConstrainerQuery

QueueConstrainerQuery getRuledQueueConstrainerQuery()

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

Returns:

the queue constrainer query

Throws:

UnimplementedException - supportsRuledQueueConstrainerQuery() is false

Compliance:

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

matchAnyRuledQueueConstrainer

void matchAnyRuledQueueConstrainer(boolean match)

Matches enablers mapped to any queue constrainer.

Parameters:

match - true for enablers mapped to any queue constrainer, false to match enablers mapped to no queue constrainers

Compliance:

mandatory - This method must be implemented.

clearRuledQueueConstrainerTerms

void clearRuledQueueConstrainerTerms()

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

getQueueConstrainerEnablerQueryRecord

QueueConstrainerEnablerQueryRecord getQueueConstrainerEnablerQueryRecord(Type queueConstrainerEnablerRecordType)
                                                                         throws OperationFailedException

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

Parameters:

queueConstrainerEnablerRecordType - a queue constrainer enabler record type

Returns:

the queue constrainer enabler query record

Throws:

NullArgumentException - queueConstrainerEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(queueConstrainerEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.