org.osid.provisioning.rules

Interface BrokerProcessorEnablerQuery

All Superinterfaces:

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

public interface BrokerProcessorEnablerQuery
extends OsidEnablerQuery

This is the query for searching broker 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	clearRuledBrokerProcessorIdTerms() Clears the broker processor Id query terms.
void	clearRuledBrokerProcessorTerms() Clears the broker processor query terms.
BrokerProcessorEnablerQueryRecord	getBrokerProcessorEnablerQueryRecord(Type brokerProcessorEnablerRecordType) Gets the broker processor enabler query record corresponding to the given BrokerProcessorEnabler record Type.
DistributorQuery	getDistributorQuery() Gets the query for a distributor.
BrokerProcessorQuery	getRuledBrokerProcessorQuery() Gets the query for a broker processor.
void	matchAnyRuledBrokerProcessor(boolean match) Matches enablers mapped to any broker processor.
void	matchDistributorId(Id distributorId, boolean match) Matches enablers mapped to the distributor.
void	matchRuledBrokerProcessorId(Id brokerProcessorId, boolean match) Matches enablers mapped to the broker processor.
boolean	supportsDistributorQuery() Tests if a DistributorQuery is available.
boolean	supportsRuledBrokerProcessorQuery() Tests if a BrokerProcessorQuery 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

matchRuledBrokerProcessorId

void matchRuledBrokerProcessorId(Id brokerProcessorId,
                               boolean match)

Matches enablers mapped to the broker processor.

Parameters:

brokerProcessorId - the broker processor Id

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

Throws:

NullArgumentException - brokerProcessorId is null

Compliance:

mandatory - This method must be implemented.

clearRuledBrokerProcessorIdTerms

void clearRuledBrokerProcessorIdTerms()

Clears the broker processor Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledBrokerProcessorQuery

boolean supportsRuledBrokerProcessorQuery()

Tests if a BrokerProcessorQuery is available.

Returns:

true if a broker processor query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledBrokerProcessorQuery

BrokerProcessorQuery getRuledBrokerProcessorQuery()

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

Returns:

the broker processor query

Throws:

UnimplementedException - supportsRuledBrokerProcessorQuery() is false

Compliance:

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

matchAnyRuledBrokerProcessor

void matchAnyRuledBrokerProcessor(boolean match)

Matches enablers mapped to any broker processor.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearRuledBrokerProcessorTerms

void clearRuledBrokerProcessorTerms()

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

getBrokerProcessorEnablerQueryRecord

BrokerProcessorEnablerQueryRecord getBrokerProcessorEnablerQueryRecord(Type brokerProcessorEnablerRecordType)
                                                                       throws OperationFailedException

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

Parameters:

brokerProcessorEnablerRecordType - a broker processor enabler record type

Returns:

the broker processor enabler query record

Throws:

NullArgumentException - brokerProcessorEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(brokerProcessorEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.