org.osid

Interface OsidRuleQuery

All Superinterfaces:

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

All Known Subinterfaces:

ActionEnablerQuery, ActionQuery, AuctionConstrainerEnablerQuery, AuctionConstrainerQuery, AuctionProcessorEnablerQuery, AuctionProcessorQuery, AuditEnablerQuery, AuthorizationEnablerQuery, AvailabilityEnablerQuery, BallotConstrainerEnablerQuery, BallotConstrainerQuery, BrokerConstrainerEnablerQuery, BrokerConstrainerQuery, BrokerProcessorEnablerQuery, BrokerProcessorQuery, CanonicalUnitEnablerQuery, CanonicalUnitProcessorEnablerQuery, CanonicalUnitProcessorQuery, CatalogEnablerQuery, CheckQuery, CommissionEnablerQuery, CommitmentEnablerQuery, CompositionEnablerQuery, ContactEnablerQuery, DemographicEnablerQuery, DemographicQuery, DeviceEnablerQuery, EdgeEnablerQuery, FunctionQuery, GradebookColumnSummaryQuery, HoldEnablerQuery, InputEnablerQuery, InputQuery, InquiryEnablerQuery, InquiryQuery, InstructionQuery, JobConstrainerEnablerQuery, JobConstrainerQuery, JobProcessorEnablerQuery, JobProcessorQuery, ObstacleEnablerQuery, OfferingConstrainerEnablerQuery, OfferingConstrainerQuery, OffsetEventEnablerQuery, OffsetEventQuery, OsidConstrainerQuery, OsidEnablerQuery, OsidProcessorQuery, ParameterProcessorEnablerQuery, ParameterProcessorQuery, ParameterQuery, PoolConstrainerEnablerQuery, PoolConstrainerQuery, PoolProcessorEnablerQuery, PoolProcessorQuery, PriceEnablerQuery, PriceQuery, ProcessEnablerQuery, ProfileEntryEnablerQuery, QueueConstrainerEnablerQuery, QueueConstrainerEnablerQuery, QueueConstrainerQuery, QueueConstrainerQuery, QueueProcessorEnablerQuery, QueueProcessorEnablerQuery, QueueProcessorQuery, QueueProcessorQuery, RaceConstrainerEnablerQuery, RaceConstrainerQuery, RaceProcessorEnablerQuery, RaceProcessorQuery, RecurringEventEnablerQuery, RecurringEventQuery, RelationshipEnablerQuery, RelevancyEnablerQuery, RequisiteQuery, RuleQuery, SequenceRuleEnablerQuery, SequenceRuleQuery, SignalEnablerQuery, SignalQuery, SpeedZoneEnablerQuery, SpeedZoneQuery, StepConstrainerEnablerQuery, StepConstrainerQuery, StepProcessorEnablerQuery, StepProcessorQuery, SubscriptionEnablerQuery, SupersedingEventEnablerQuery, SupersedingEventQuery, TodoProducerQuery, TriggerEnablerQuery, TriggerQuery, ValueEnablerQuery

public interface OsidRuleQuery
extends OsidObjectQuery, OsidOperableQuery

This is the query interface for searching rules. Each method 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	clearRuleIdTerms() Clears all rule Id terms.
void	clearRuleTerms() Clears all rule terms.
RuleQuery	getRuleQuery(boolean match) Gets the query for the rule.
void	matchAnyRule(boolean match) Match any associated rule.
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 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

matchRuleId

void matchRuleId(Id ruleId,
               boolean match)

Match the Id of the rule.

Parameters:

ruleId - Id to match

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

Throws:

NullArgumentException - ruleId is null

Compliance:

mandatory - This method must be implemented.

clearRuleIdTerms

void clearRuleIdTerms()

Clears all rule Id terms.

Compliance:

mandatory - This method must be implemented.

supportsRuleQuery

boolean supportsRuleQuery()

Tests if a RuleQuery for the rule is available.

Returns:

true if a rule query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuleQuery

RuleQuery getRuleQuery(boolean match)

Gets the query for the rule. Each retrieval performs a boolean OR.

Parameters:

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

Returns:

the rule query

Throws:

UnimplementedException - supportsRuleQuery() is false

Compliance:

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

matchAnyRule

void matchAnyRule(boolean match)

Match any associated rule.

Parameters:

match - true to match any rule, false to match no rules

Compliance:

mandatory - This method must be implemented.

clearRuleTerms

void clearRuleTerms()

Clears all rule terms.

Compliance:

mandatory - This method must be implemented.