org.osid.provisioning.rules

Interface BrokerConstrainerQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidConstrainerQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidRuleQuery, Suppliable

public interface BrokerConstrainerQuery
extends OsidConstrainerQuery

This is the query for searching broker constrainers. 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	clearRuledBrokerIdTerms() Clears the broker Id query terms.
void	clearRuledBrokerTerms() Clears the broker query terms.
BrokerConstrainerQueryRecord	getBrokerConstrainerQueryRecord(Type brokerConstrainerRecordType) Gets the broker constrainer query record corresponding to the given BrokerConstrainer record Type.
DistributorQuery	getDistributorQuery() Gets the query for a distributor.
BrokerQuery	getRuledBrokerQuery() Gets the query for a broker.
void	matchAnyRuledBroker(boolean match) Matches mapped to any broker.
void	matchDistributorId(Id distributorId, boolean match) Matches mapped to the distributor.
void	matchRuledBrokerId(Id distributorId, boolean match) Matches mapped to a broker.
boolean	supportsDistributorQuery() Tests if a DistributorQuery is available.
boolean	supportsRuledBrokerQuery() Tests if a BrokerQuery is available.

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

Method Detail

matchRuledBrokerId

void matchRuledBrokerId(Id distributorId,
                      boolean match)

Matches mapped to a broker.

Parameters:

distributorId - the broker Id

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

Throws:

NullArgumentException - distributorId is null

Compliance:

mandatory - This method must be implemented.

clearRuledBrokerIdTerms

void clearRuledBrokerIdTerms()

Clears the broker Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledBrokerQuery

boolean supportsRuledBrokerQuery()

Tests if a BrokerQuery is available.

Returns:

true if a broker query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledBrokerQuery

BrokerQuery getRuledBrokerQuery()

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

Returns:

the broker query

Throws:

UnimplementedException - supportsRuledBrokerQuery() is false

Compliance:

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

matchAnyRuledBroker

void matchAnyRuledBroker(boolean match)

Matches mapped to any broker.

Parameters:

match - true for mapped to any broker, false to match mapped to no brokers

Compliance:

mandatory - This method must be implemented.

clearRuledBrokerTerms

void clearRuledBrokerTerms()

Clears the broker query terms.

Compliance:

mandatory - This method must be implemented.

matchDistributorId

void matchDistributorId(Id distributorId,
                      boolean match)

Matches 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.

getBrokerConstrainerQueryRecord

BrokerConstrainerQueryRecord getBrokerConstrainerQueryRecord(Type brokerConstrainerRecordType)
                                                             throws OperationFailedException

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

Parameters:

brokerConstrainerRecordType - a broker constrainer record type

Returns:

the broker constrainer query record

Throws:

NullArgumentException - brokerConstrainerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(brokerConstrainerRecordType) is false

Compliance:

mandatory - This method must be implemented.