Interface OsidRuleQuery

All Superinterfaces:
Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, Suppliable
All Known Subinterfaces:
ActionEnablerQuery, ActionQuery, AgendaQuery, AuctionConstrainerEnablerQuery, AuctionConstrainerQuery, AuctionProcessorEnablerQuery, AuctionProcessorQuery, AuditConstrainerEnablerQuery, AuditConstrainerQuery, AuditEnablerQuery, AuditProcessorEnablerQuery, AuditProcessorQuery, AuthorizationEnablerQuery, AvailabilityEnablerQuery, BallotConstrainerEnablerQuery, BallotConstrainerQuery, BidEnablerQuery, BrokerConstrainerEnablerQuery, BrokerConstrainerQuery, BrokerEnablerQuery, BrokerProcessorEnablerQuery, BrokerProcessorQuery, CanonicalUnitEnablerQuery, CanonicalUnitProcessorEnablerQuery, CanonicalUnitProcessorQuery, CatalogEnablerQuery, CheckQuery, CommissionEnablerQuery, CommitmentEnablerQuery, CompositionEnablerQuery, ContactEnablerQuery, CourseRequirementQuery, DemographicEnablerQuery, DemographicQuery, DeviceEnablerQuery, DispatchConstrainerEnablerQuery, DispatchConstrainerQuery, DispatchEnablerQuery, DispatchProcessorEnablerQuery, DispatchProcessorQuery, EdgeEnablerQuery, FunctionQuery, HoldEnablerQuery, InputEnablerQuery, InputQuery, InquiryEnablerQuery, InquiryQuery, InstructionQuery, IssueConstrainerEnablerQuery, IssueConstrainerQuery, IssueEnablerQuery, IssueProcessorEnablerQuery, IssueProcessorQuery, JobConstrainerEnablerQuery, JobConstrainerQuery, JobProcessorEnablerQuery, JobProcessorQuery, ObstacleEnablerQuery, OfferingConstrainerEnablerQuery, OfferingConstrainerQuery, OffsetEventEnablerQuery, OffsetEventQuery, OsidConstrainerQuery, OsidEffectuatorQuery, OsidEnablerQuery, OsidOperatorQuery, OsidProcessorQuery, OsidRuleApplicatorQuery, ParameterProcessorEnablerQuery, ParameterProcessorQuery, ParameterQuery, PoolConstrainerEnablerQuery, PoolConstrainerQuery, PoolEnablerQuery, PoolProcessorEnablerQuery, PoolProcessorQuery, PriceEnablerQuery, PriceQuery, ProcessConstrainerEnablerQuery, ProcessConstrainerQuery, ProcessEnablerQuery, ProcessProcessorEnablerQuery, ProcessProcessorQuery, ProfileEntryEnablerQuery, ProvisionableEnablerQuery, ProvisionEnablerQuery, QueueConstrainerEnablerQuery, QueueConstrainerEnablerQuery, QueueConstrainerQuery, QueueConstrainerQuery, QueueEnablerQuery, QueueEnablerQuery, QueueProcessorEnablerQuery, QueueProcessorEnablerQuery, QueueProcessorQuery, QueueProcessorQuery, RaceConstrainerEnablerQuery, RaceConstrainerQuery, RaceProcessorEnablerQuery, RaceProcessorQuery, RecurringEventEnablerQuery, RecurringEventQuery, RelationshipEnablerQuery, RelevancyEnablerQuery, RequisiteQuery, RuleQuery, SequenceRuleEnablerQuery, SequenceRuleQuery, SignalEnablerQuery, SignalQuery, SpeedZoneEnablerQuery, SpeedZoneQuery, StepConstrainerEnablerQuery, StepConstrainerQuery, StepEnablerQuery, StepProcessorEnablerQuery, StepProcessorQuery, StepQuery, SubscriptionEnablerQuery, SupersedingEventEnablerQuery, SupersedingEventQuery, TodoProducerQuery, TriggerEnablerQuery, TriggerQuery, ValueEnablerQuery, VoteEnablerQuery
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 Details

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

    • matchConditionRecordType

      void matchConditionRecordType(Type conditionRecordType, boolean match)
      Matches a condition record type.
      Parameters:
      conditionRecordType - a condition record Type
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - conditionRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyConditionRecordType

      void matchAnyConditionRecordType(boolean match)
      Matches rules with any condition record type.
      Parameters:
      match - true to match rules with any condition record type, false to match rules with no condition record type
      Compliance:
      mandatory - This method must be implemented.

    • clearConditionRecordTypeTerms

      void clearConditionRecordTypeTerms()
      Clears the condition record Type query terms.
      Compliance:
      mandatory - This method must be implemented.