org.osid.provisioning.rules

Interface PoolProcessorEnablerQuery

All Superinterfaces:

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

public interface PoolProcessorEnablerQuery
extends OsidEnablerQuery

This is the query for searching pool processor 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	clearRuledPoolProcessorIdTerms() Clears the pool processor Id query terms.
void	clearRuledPoolProcessorTerms() Clears the pool processor query terms.
DistributorQuery	getDistributorQuery() Gets the query for a distributor.
PoolProcessorEnablerQueryRecord	getPoolProcessorEnablerQueryRecord(Type poolProcessorEnablerRecordType) Gets the pool processor enabler query record corresponding to the given PoolProcessorEnabler record Type.
PoolProcessorQuery	getRuledPoolProcessorQuery() Gets the query for a pool processor.
void	matchAnyRuledPoolProcessor(boolean match) Matches enablers mapped to any pool processor.
void	matchDistributorId(Id distributorId, boolean match) Matches enablers mapped to the distributor.
void	matchRuledPoolProcessorId(Id poolProcessorId, boolean match) Matches enablers mapped to the pool processor.
boolean	supportsDistributorQuery() Tests if a DistributorQuery is available.
boolean	supportsRuledPoolProcessorQuery() Tests if a PoolProcessorQuery 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

matchRuledPoolProcessorId

void matchRuledPoolProcessorId(Id poolProcessorId,
                             boolean match)

Matches enablers mapped to the pool processor.

Parameters:

poolProcessorId - the pool processor Id

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

Throws:

NullArgumentException - poolProcessorId is null

Compliance:

mandatory - This method must be implemented.

clearRuledPoolProcessorIdTerms

void clearRuledPoolProcessorIdTerms()

Clears the pool processor Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledPoolProcessorQuery

boolean supportsRuledPoolProcessorQuery()

Tests if a PoolProcessorQuery is available.

Returns:

true if a pool processor query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledPoolProcessorQuery

PoolProcessorQuery getRuledPoolProcessorQuery()

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

Returns:

the pool processor query

Throws:

UnimplementedException - supportsRuledPoolProcessorQuery() is false

Compliance:

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

matchAnyRuledPoolProcessor

void matchAnyRuledPoolProcessor(boolean match)

Matches enablers mapped to any pool processor.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearRuledPoolProcessorTerms

void clearRuledPoolProcessorTerms()

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

getPoolProcessorEnablerQueryRecord

PoolProcessorEnablerQueryRecord getPoolProcessorEnablerQueryRecord(Type poolProcessorEnablerRecordType)
                                                                   throws OperationFailedException

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

Parameters:

poolProcessorEnablerRecordType - a pool processor enabler record type

Returns:

the pool processor enabler query record

Throws:

NullArgumentException - poolProcessorEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(poolProcessorEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.