org.osid.provisioning.rules

Interface BrokerConstrainerEnablerQuery

All Superinterfaces:

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

public interface BrokerConstrainerEnablerQuery
extends OsidEnablerQuery

This is the query for searching broker 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	clearRuledBrokerConstrainerIdTerms() Clears the broker constrainer Id query terms.
void	clearRuledBrokerConstrainerTerms() Clears the broker constrainer query terms.
BrokerConstrainerEnablerQueryRecord	getBrokerConstrainerEnablerQueryRecord(Type brokerConstrainerEnablerRecordType) Gets the broker constrainer enabler query record corresponding to the given BrokerConstrainerEnabler record Type.
DistributorQuery	getDistributorQuery() Gets the query for a distributor.
BrokerConstrainerQuery	getRuledBrokerConstrainerQuery() Gets the query for a broker constrainer.
void	matchAnyRuledBrokerConstrainer(boolean match) Matches enablers mapped to any broker constrainer.
void	matchDistributorId(Id distributorId, boolean match) Matches enablers mapped to the distributor.
void	matchRuledBrokerConstrainerId(Id brokerConstrainerId, boolean match) Matches enablers mapped to the broker constrainer.
boolean	supportsDistributorQuery() Tests if a DistributorQuery is available.
boolean	supportsRuledBrokerConstrainerQuery() Tests if a BrokerConstrainerQuery 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

matchRuledBrokerConstrainerId

void matchRuledBrokerConstrainerId(Id brokerConstrainerId,
                                 boolean match)

Matches enablers mapped to the broker constrainer.

Parameters:

brokerConstrainerId - the broker constrainer Id

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

Throws:

NullArgumentException - brokerConstrainerId is null

Compliance:

mandatory - This method must be implemented.

clearRuledBrokerConstrainerIdTerms

void clearRuledBrokerConstrainerIdTerms()

Clears the broker constrainer Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledBrokerConstrainerQuery

boolean supportsRuledBrokerConstrainerQuery()

Tests if a BrokerConstrainerQuery is available.

Returns:

true if a broker constrainer query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledBrokerConstrainerQuery

BrokerConstrainerQuery getRuledBrokerConstrainerQuery()

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

Returns:

the broker constrainer query

Throws:

UnimplementedException - supportsRuledBrokerConstrainerQuery() is false

Compliance:

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

matchAnyRuledBrokerConstrainer

void matchAnyRuledBrokerConstrainer(boolean match)

Matches enablers mapped to any broker constrainer.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearRuledBrokerConstrainerTerms

void clearRuledBrokerConstrainerTerms()

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

getBrokerConstrainerEnablerQueryRecord

BrokerConstrainerEnablerQueryRecord getBrokerConstrainerEnablerQueryRecord(Type brokerConstrainerEnablerRecordType)
                                                                           throws OperationFailedException

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

Parameters:

brokerConstrainerEnablerRecordType - a broker constrainer enabler record type

Returns:

the broker constrainer enabler query record

Throws:

NullArgumentException - brokerConstrainerEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(brokerConstrainerEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.