org.osid.provisioning.rules

Interface PoolConstrainerEnablerQuery

All Superinterfaces:

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

public interface PoolConstrainerEnablerQuery
extends OsidEnablerQuery

This is the query for searching pool constrainer enablers. Each method match specifies an 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	clearRuledPoolConstrainerIdTerms() Clears the pool constrainer Id query terms.
void	clearRuledPoolConstrainerTerms() Clears the pool constrainer query terms.
DistributorQuery	getDistributorQuery() Gets the query for a distributor.
PoolConstrainerEnablerQueryRecord	getPoolConstrainerEnablerQueryRecord(Type poolConstrainerEnablerRecordType) Gets the pool constrainer enabler query record corresponding to the given PoolConstrainerEnabler record Type.
PoolConstrainerQuery	getRuledPoolConstrainerQuery() Gets the query for a pool constrainer.
void	matchAnyRuledPoolConstrainer(boolean match) Matches enablers mapped to any pool constrainer.
void	matchDistributorId(Id distributorId, boolean match) Matches enablers mapped to the distributor.
void	matchRuledPoolConstrainerId(Id poolConstrainerId, boolean match) Matches enablers mapped to the pool constrainer.
boolean	supportsDistributorQuery() Tests if a DistributorQuery is available.
boolean	supportsRuledPoolConstrainerQuery() Tests if a PoolConstrainerQuery 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

matchRuledPoolConstrainerId

void matchRuledPoolConstrainerId(Id poolConstrainerId,
                               boolean match)

Matches enablers mapped to the pool constrainer.

Parameters:

poolConstrainerId - the pool constrainer Id

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

Throws:

NullArgumentException - poolConstrainerId is null

Compliance:

mandatory - This method must be implemented.

clearRuledPoolConstrainerIdTerms

void clearRuledPoolConstrainerIdTerms()

Clears the pool constrainer Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledPoolConstrainerQuery

boolean supportsRuledPoolConstrainerQuery()

Tests if a PoolConstrainerQuery is available.

Returns:

true if a pool constrainer query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledPoolConstrainerQuery

PoolConstrainerQuery getRuledPoolConstrainerQuery()

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

Returns:

the pool constrainer query

Throws:

UnimplementedException - supportsRuledPoolConstrainerQuery() is false

Compliance:

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

matchAnyRuledPoolConstrainer

void matchAnyRuledPoolConstrainer(boolean match)

Matches enablers mapped to any pool constrainer.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearRuledPoolConstrainerTerms

void clearRuledPoolConstrainerTerms()

Clears the pool 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.

getPoolConstrainerEnablerQueryRecord

PoolConstrainerEnablerQueryRecord getPoolConstrainerEnablerQueryRecord(Type poolConstrainerEnablerRecordType)
                                                                       throws OperationFailedException

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

Parameters:

poolConstrainerEnablerRecordType - a pool constrainer enabler record type

Returns:

the pool constrainer enabler query record

Throws:

NullArgumentException - poolConstrainerEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(poolConstrainerEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.