Interface OsidEnablerQuery

All Superinterfaces:
Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidRuleQuery, OsidTemporalQuery, Suppliable
All Known Subinterfaces:
ActionEnablerQuery, AuctionConstrainerEnablerQuery, AuctionProcessorEnablerQuery, AuditConstrainerEnablerQuery, AuditEnablerQuery, AuditProcessorEnablerQuery, AuthorizationEnablerQuery, AvailabilityEnablerQuery, BallotConstrainerEnablerQuery, BidEnablerQuery, BrokerConstrainerEnablerQuery, BrokerEnablerQuery, BrokerProcessorEnablerQuery, CanonicalUnitEnablerQuery, CanonicalUnitProcessorEnablerQuery, CatalogEnablerQuery, CommissionEnablerQuery, CommitmentEnablerQuery, CompositionEnablerQuery, ContactEnablerQuery, DemographicEnablerQuery, DeviceEnablerQuery, DispatchConstrainerEnablerQuery, DispatchEnablerQuery, DispatchProcessorEnablerQuery, EdgeEnablerQuery, HoldEnablerQuery, InputEnablerQuery, InquiryEnablerQuery, InstructionQuery, IssueConstrainerEnablerQuery, IssueEnablerQuery, IssueProcessorEnablerQuery, JobConstrainerEnablerQuery, JobProcessorEnablerQuery, ObstacleEnablerQuery, OfferingConstrainerEnablerQuery, OffsetEventEnablerQuery, OsidEffectuatorQuery, OsidOperatorQuery, OsidRuleApplicatorQuery, ParameterProcessorEnablerQuery, PoolConstrainerEnablerQuery, PoolEnablerQuery, PoolProcessorEnablerQuery, PriceEnablerQuery, ProcessConstrainerEnablerQuery, ProcessEnablerQuery, ProcessProcessorEnablerQuery, ProfileEntryEnablerQuery, ProvisionableEnablerQuery, ProvisionEnablerQuery, QueueConstrainerEnablerQuery, QueueConstrainerEnablerQuery, QueueEnablerQuery, QueueEnablerQuery, QueueProcessorEnablerQuery, QueueProcessorEnablerQuery, RaceConstrainerEnablerQuery, RaceProcessorEnablerQuery, RecurringEventEnablerQuery, RelationshipEnablerQuery, RelevancyEnablerQuery, RequisiteQuery, SequenceRuleEnablerQuery, SignalEnablerQuery, SpeedZoneEnablerQuery, StepConstrainerEnablerQuery, StepEnablerQuery, StepProcessorEnablerQuery, SubscriptionEnablerQuery, SupersedingEventEnablerQuery, TriggerEnablerQuery, ValueEnablerQuery, VoteEnablerQuery
public interface OsidEnablerQuery extends OsidRuleQuery, OsidTemporalQuery

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

  • Method Details

    • matchRequirement

      void matchRequirement(boolean match)
      Matches enablers that are requirements,
      Parameters:
      match - true if for a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyRequirement

      void matchAnyRequirement(boolean match)
      Match OsidEnablers with any requirement flag set.
      Parameters:
      match - true to match any requirement setting, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • clearRequirementTerms

      void clearRequirementTerms()
      Clears all requirement terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchScheduleId

      void matchScheduleId(Id scheduleId, boolean match)
      Match the Id of an associated schedule.
      Parameters:
      scheduleId - Id to match
      match - true if for a positive match, false for a negative match
      Throws:
      NullArgumentException - scheduleId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearScheduleIdTerms

      void clearScheduleIdTerms()
      Clears all schedule Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsScheduleQuery

      boolean supportsScheduleQuery()
      Tests if a ScheduleQuery for the rule is available.
      Returns:
      true if a schedule query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getScheduleQuery

      ScheduleQuery getScheduleQuery(boolean match)
      Gets the query for the schedule. Each retrieval performs a boolean OR .
      Parameters:
      match - true if for a positive match, false for a negative match
      Returns:
      the schedule query
      Throws:
      UnimplementedException - supportsScheduleQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsScheduleQuery()} is {@code true} .

    • matchAnySchedule

      void matchAnySchedule(boolean match)
      Match any associated schedule.
      Parameters:
      match - true to match any schedule, false to match no schedules
      Compliance:
      mandatory - This method must be implemented.

    • clearScheduleTerms

      void clearScheduleTerms()
      Clears all schedule terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchEventId

      void matchEventId(Id eventId, boolean match)
      Match the Id of an associated event.
      Parameters:
      eventId - Id to match
      match - true if for a positive match, false for a negative match
      Throws:
      NullArgumentException - eventId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearEventIdTerms

      void clearEventIdTerms()
      Clears all event Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsEventQuery

      boolean supportsEventQuery()
      Tests if a EventQuery for the rule is available.
      Returns:
      true if an event query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getEventQuery

      EventQuery getEventQuery(boolean match)
      Gets the query for the event. Each retrieval performs a boolean OR .
      Parameters:
      match - true if for a positive match, false for a negative match
      Returns:
      the event query
      Throws:
      UnimplementedException - supportsEventQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsEventQuery()} is {@code true} .

    • matchAnyEvent

      void matchAnyEvent(boolean match)
      Match any associated event.
      Parameters:
      match - true to match any event, false to match no events
      Compliance:
      mandatory - This method must be implemented.

    • clearEventTerms

      void clearEventTerms()
      Clears all recurirng event terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCyclicEventId

      void matchCyclicEventId(Id cyclicEventId, boolean match)
      Sets the cyclic event Id for this query.
      Parameters:
      cyclicEventId - the cyclic event Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - cyclicEventId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCyclicEventIdTerms

      void clearCyclicEventIdTerms()
      Clears the cyclic event Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsCyclicEventQuery

      boolean supportsCyclicEventQuery()
      Tests if a CyclicEventQuery is available.
      Returns:
      true if a cyclic event query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getCyclicEventQuery

      CyclicEventQuery getCyclicEventQuery()
      Gets the query for a cyclic event. Multiple retrievals produce a nested OR term.
      Returns:
      the cyclic event query
      Throws:
      UnimplementedException - supportsCyclicEventQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCyclicEventQuery()} is {@code true} .

    • matchAnyCyclicEvent

      void matchAnyCyclicEvent(boolean match)
      Matches any enabler with a cyclic event.
      Parameters:
      match - true to match any enablers with a cyclic event, false to match enablers with no cyclic events
      Compliance:
      mandatory - This method must be implemented.

    • clearCyclicEventTerms

      void clearCyclicEventTerms()
      Clears the cyclic event query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchTimePeriodId

      void matchTimePeriodId(Id timePeriodId, boolean match)
      Sets the time period Id for this query.
      Parameters:
      timePeriodId - the time period Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - timePeriodId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearTimePeriodIdTerms

      void clearTimePeriodIdTerms()
      Clears the time period Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsTimePeriodQuery

      boolean supportsTimePeriodQuery()
      Tests if a TimePeriod query is available.
      Returns:
      true if a time period query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getTimePeriodQuery

      TimePeriodQuery getTimePeriodQuery()
      Gets the query for a time period. Multiple retrievals produce a nested OR term.
      Returns:
      the time period query
      Throws:
      UnimplementedException - supportsTimePeriodQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsTimePeriodQuery()} is {@code true} .

    • matchAnyTimePeriod

      void matchAnyTimePeriod(boolean match)
      Matches any enabler with a time period.
      Parameters:
      match - true to match any enablers with a time period, false to match enablers with no time period
      Compliance:
      mandatory - This method must be implemented.

    • clearTimePeriodTerms

      void clearTimePeriodTerms()
      Clears the time period query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCyclicTimePeriodId

      void matchCyclicTimePeriodId(Id cyclicTimePeriodId, boolean match)
      Sets the cyclic time period Id for this query.
      Parameters:
      cyclicTimePeriodId - the cyclic time period Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - cyclicTmePeriodId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCyclicTimePeriodIdTerms

      void clearCyclicTimePeriodIdTerms()
      Clears the cyclic time period Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsCyclicTimePeriodQuery

      boolean supportsCyclicTimePeriodQuery()
      Tests if a CyclicTimePeriod query is available.
      Returns:
      true if a cyclic time period query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getCyclicTimePeriodQuery

      CyclicTimePeriodQuery getCyclicTimePeriodQuery()
      Gets the query for a cyclic time period. Multiple retrievals produce a nested OR term.
      Returns:
      the cyclic time period query
      Throws:
      UnimplementedException - supportsCyclicTimePeriodQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCyclicTimePeriodQuery()} is {@code true} .

    • matchAnyCyclicTimePeriod

      void matchAnyCyclicTimePeriod(boolean match)
      Matches any enabler with a cyclic time period.
      Parameters:
      match - true to match any enablers with a cyclic time period, false to match enablers with no cyclic time period
      Compliance:
      mandatory - This method must be implemented.

    • clearCyclicTimePeriodTerms

      void clearCyclicTimePeriodTerms()
      Clears the cyclic time period query terms.
      Compliance:
      mandatory - This method must be implemented.