Interface BrokerEnablerQuery

All Superinterfaces:

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

public interface BrokerEnablerQuery
extends OsidEnablerQuery

This is the query for searching broker enablers. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR .

Method Summary

Modifier and Type	Method	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.
BrokerEnablerQueryRecord	getBrokerEnablerQueryRecord(Type brokerEnablerRecordType)	Gets the broker enabler query record corresponding to the given BrokerEnabler 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)	Sets the distributor Id for this query to match brokers assigned to distributors.
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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidEnablerQuery

clearCyclicEventIdTerms, clearCyclicEventTerms, clearCyclicTimePeriodIdTerms, clearCyclicTimePeriodTerms, clearEventIdTerms, clearEventTerms, clearRequirementTerms, clearScheduleIdTerms, clearScheduleTerms, clearTimePeriodIdTerms, clearTimePeriodTerms, getCyclicEventQuery, getCyclicTimePeriodQuery, getEventQuery, getScheduleQuery, getTimePeriodQuery, matchAnyCyclicEvent, matchAnyCyclicTimePeriod, matchAnyEvent, matchAnyRequirement, matchAnySchedule, matchAnyTimePeriod, matchCyclicEventId, matchCyclicTimePeriodId, matchEventId, matchRequirement, matchScheduleId, matchTimePeriodId, supportsCyclicEventQuery, supportsCyclicTimePeriodQuery, supportsEventQuery, supportsScheduleQuery, supportsTimePeriodQuery

Modifier and Type	Method	Description
void	clearCyclicEventIdTerms()	Clears the cyclic event Id query terms.
void	clearCyclicEventTerms()	Clears the cyclic event query terms.
void	clearCyclicTimePeriodIdTerms()	Clears the cyclic time period Id query terms.
void	clearCyclicTimePeriodTerms()	Clears the cyclic time period query terms.
void	clearEventIdTerms()	Clears all event Id terms.
void	clearEventTerms()	Clears all recurirng event terms.
void	clearRequirementTerms()	Clears all requirement terms.
void	clearScheduleIdTerms()	Clears all schedule Id terms.
void	clearScheduleTerms()	Clears all schedule terms.
void	clearTimePeriodIdTerms()	Clears the time period Id query terms.
void	clearTimePeriodTerms()	Clears the time period query terms.
CyclicEventQuery	getCyclicEventQuery()	Gets the query for a cyclic event.
CyclicTimePeriodQuery	getCyclicTimePeriodQuery()	Gets the query for a cyclic time period.
EventQuery	getEventQuery(boolean match)	Gets the query for the event.
ScheduleQuery	getScheduleQuery(boolean match)	Gets the query for the schedule.
TimePeriodQuery	getTimePeriodQuery()	Gets the query for a time period.
void	matchAnyCyclicEvent(boolean match)	Matches any enabler with a cyclic event.
void	matchAnyCyclicTimePeriod(boolean match)	Matches any enabler with a cyclic time period.
void	matchAnyEvent(boolean match)	Match any associated event.
void	matchAnyRequirement(boolean match)	Match OsidEnablers with any requirement flag set.
void	matchAnySchedule(boolean match)	Match any associated schedule.
void	matchAnyTimePeriod(boolean match)	Matches any enabler with a time period.
void	matchCyclicEventId(Id cyclicEventId, boolean match)	Sets the cyclic event Id for this query.
void	matchCyclicTimePeriodId(Id cyclicTimePeriodId, boolean match)	Sets the cyclic time period Id for this query.
void	matchEventId(Id eventId, boolean match)	Match the Id of an associated event.
void	matchRequirement(boolean match)	Matches enablers that are requirements,
void	matchScheduleId(Id scheduleId, boolean match)	Match the Id of an associated schedule.
void	matchTimePeriodId(Id timePeriodId, boolean match)	Sets the time period Id for this query.
boolean	supportsCyclicEventQuery()	Tests if a CyclicEventQuery is available.
boolean	supportsCyclicTimePeriodQuery()	Tests if a CyclicTimePeriod query is available.
boolean	supportsEventQuery()	Tests if a EventQuery for the rule is available.
boolean	supportsScheduleQuery()	Tests if a ScheduleQuery for the rule is available.
boolean	supportsTimePeriodQuery()	Tests if a TimePeriod query is available.

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from interface 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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidOperableQuery

clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational

Modifier and Type	Method	Description
void	clearActiveTerms()	Clears the active query terms.
void	clearDisabledTerms()	Clears the administratively disabled query terms.
void	clearEnabledTerms()	Clears the administratively enabled query terms.
void	clearOperationalTerms()	Clears the operational query terms.
void	matchActive(boolean match)	Matches active.
void	matchDisabled(boolean match)	Matches administratively disabled.
void	matchEnabled(boolean match)	Matches administratively enabled.
void	matchOperational(boolean match)	Matches operational operables.

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Methods inherited from interface OsidRuleQuery

clearConditionRecordTypeTerms, clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyConditionRecordType, matchAnyRule, matchConditionRecordType, matchRuleId, supportsRuleQuery

Modifier and Type	Method	Description
void	clearConditionRecordTypeTerms()	Clears the condition record Type query terms.
void	clearRuleIdTerms()	Clears all rule Id terms.
void	clearRuleTerms()	Clears all rule terms.
RuleQuery	getRuleQuery(boolean match)	Gets the query for the rule.
void	matchAnyConditionRecordType(boolean match)	Matches rules with any condition record type.
void	matchAnyRule(boolean match)	Match any associated rule.
void	matchConditionRecordType(Type conditionRecordType, boolean match)	Matches a condition record type.
void	matchRuleId(Id ruleId, boolean match)	Match the Id of the rule.
boolean	supportsRuleQuery()	Tests if a RuleQuery for the rule is available.

Methods inherited from interface OsidTemporalQuery

clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

Modifier and Type	Method	Description
void	clearDateTerms()	Clears the date query terms.
void	clearEffectiveTerms()	Clears the effective query terms.
void	clearEndDateTerms()	Clears the end date query terms.
void	clearStartDateTerms()	Clears the start date query terms.
void	matchAnyEndDate(boolean match)	Matches temporals with any end date set.
void	matchAnyStartDate(boolean match)	Matches temporals with any start date set.
void	matchDate(DateTime from, DateTime to, boolean match)	Matches temporals where the given date range falls entirely between the start and end dates inclusive.
void	matchEffective(boolean match)	Match effective objects where the current date falls within the start and end dates inclusive.
void	matchEndDate(DateTime start, DateTime end, boolean match)	Matches temporals whose effective end date falls in between the given dates inclusive.
void	matchStartDate(DateTime start, DateTime end, boolean match)	Matches temporals whose start date falls in between the given dates inclusive.

Method Details

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 {@code supportsRuledBrokerQuery()} is {@code 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)

Sets the distributor Id for this query to match brokers assigned to distributors.

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 {@code supportsDistributorQuery()} is {@code true} .

clearDistributorTerms

void clearDistributorTerms()

Clears the distributor query terms.

Compliance:

mandatory - This method must be implemented.

getBrokerEnablerQueryRecord

BrokerEnablerQueryRecord getBrokerEnablerQueryRecord(Type brokerEnablerRecordType)
                                              throws OperationFailedException

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

Parameters:

brokerEnablerRecordType - a broker enabler record type

Returns:

the broker enabler query record

Throws:

NullArgumentException - brokerEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(brokerEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.