Interface OsidEnablerSearchOrder

All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidRuleSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable
All Known Subinterfaces:
ActionEnablerSearchOrder, AuctionConstrainerEnablerSearchOrder, AuctionProcessorEnablerSearchOrder, AuditConstrainerEnablerSearchOrder, AuditEnablerSearchOrder, AuditProcessorEnablerSearchOrder, AuthorizationEnablerSearchOrder, AvailabilityEnablerSearchOrder, BallotConstrainerEnablerSearchOrder, BidEnablerSearchOrder, BrokerConstrainerEnablerSearchOrder, BrokerEnablerSearchOrder, BrokerProcessorEnablerSearchOrder, CanonicalUnitEnablerSearchOrder, CanonicalUnitProcessorEnablerSearchOrder, CatalogEnablerSearchOrder, CommissionEnablerSearchOrder, CommitmentEnablerSearchOrder, CompositionEnablerSearchOrder, ContactEnablerSearchOrder, DemographicEnablerSearchOrder, DeviceEnablerSearchOrder, DispatchConstrainerEnablerSearchOrder, DispatchEnablerSearchOrder, DispatchProcessorEnablerSearchOrder, EdgeEnablerSearchOrder, HoldEnablerSearchOrder, InputEnablerSearchOrder, InquiryEnablerSearchOrder, InstructionSearchOrder, IssueConstrainerEnablerSearchOrder, IssueEnablerSearchOrder, IssueProcessorEnablerSearchOrder, JobConstrainerEnablerSearchOrder, JobProcessorEnablerSearchOrder, ObstacleEnablerSearchOrder, OfferingConstrainerEnablerSearchOrder, OffsetEventEnablerSearchOrder, OsidEffectuatorSearchOrder, OsidOperatorSearchOrder, OsidRuleApplicatorSearchOrder, ParameterProcessorEnablerSearchOrder, PoolConstrainerEnablerSearchOrder, PoolEnablerSearchOrder, PoolProcessorEnablerSearchOrder, PriceEnablerSearchOrder, ProcessConstrainerEnablerSearchOrder, ProcessEnablerSearchOrder, ProcessProcessorEnablerSearchOrder, ProfileEntryEnablerSearchOrder, ProvisionableEnablerSearchOrder, ProvisionEnablerSearchOrder, QueueConstrainerEnablerSearchOrder, QueueConstrainerEnablerSearchOrder, QueueEnablerSearchOrder, QueueEnablerSearchOrder, QueueProcessorEnablerSearchOrder, QueueProcessorEnablerSearchOrder, RaceConstrainerEnablerSearchOrder, RaceProcessorEnablerSearchOrder, RecurringEventEnablerSearchOrder, RelationshipEnablerSearchOrder, RelevancyEnablerSearchOrder, RequisiteSearchOrder, SequenceRuleEnablerSearchOrder, SignalEnablerSearchOrder, SpeedZoneEnablerSearchOrder, StepConstrainerEnablerSearchOrder, StepEnablerSearchOrder, StepProcessorEnablerSearchOrder, SubscriptionEnablerSearchOrder, SupersedingEventEnablerSearchOrder, TriggerEnablerSearchOrder, ValueEnablerSearchOrder, VoteEnablerSearchOrder
public interface OsidEnablerSearchOrder extends OsidRuleSearchOrder, OsidTemporalSearchOrder

An interface for specifying the ordering of search results.

  • Method Details

    • orderByRequirement

      void orderByRequirement(SearchOrderStyle style)
      Specifies a preference for ordering the results by the requirement flag.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderBySchedule

      void orderBySchedule(SearchOrderStyle style)
      Specifies a preference for ordering the results by the associated schedule.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsScheduleSearchOrder

      boolean supportsScheduleSearchOrder()
      Tests if a ScheduleSearchOrder is available.
      Returns:
      true if a schedule search order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getScheduleSearchOrder

      ScheduleSearchOrder getScheduleSearchOrder()
      Gets the search order for a schedule.
      Returns:
      the schedule search order
      Throws:
      UnimplementedException - supportsScheduleSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsScheduleSearchOrder()} is true.

    • orderByEvent

      void orderByEvent(SearchOrderStyle style)
      Specifies a preference for ordering the results by the associated event.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsEventSearchOrder

      boolean supportsEventSearchOrder()
      Tests if an EventSearchOrder is available.
      Returns:
      true if an event search order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getEventSearchOrder

      EventSearchOrder getEventSearchOrder()
      Gets the search order for an event.
      Returns:
      the event search order
      Throws:
      UnimplementedException - supportsEventSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsEventSearchOrder()} is true.

    • orderByCyclicEvent

      void orderByCyclicEvent(SearchOrderStyle style)
      Orders the results by cyclic event.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsCyclicEventSearchOrder

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

    • getCyclicEventSearchOrder

      CyclicEventSearchOrder getCyclicEventSearchOrder()
      Gets the cyclic event search order.
      Returns:
      the cyclic event search order
      Throws:
      IllegalStateException - supportsCyclicEventSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByTimePeriod

      void orderByTimePeriod(SearchOrderStyle style)
      Orders the results by time period.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsTimePeriodSearchOrder

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

    • getTimePeriodSearchOrder

      TimePeriodSearchOrder getTimePeriodSearchOrder()
      Gets the time period search order.
      Returns:
      the time period search order
      Throws:
      IllegalStateException - supportsTimePeriodSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByCyclicTimePeriod

      void orderByCyclicTimePeriod(SearchOrderStyle style)
      Orders the results by cyclic time period.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsCyclicTimePeriodSearchOrder

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

    • getCyclicTimePeriodSearchOrder

      CyclicTimePeriodSearchOrder getCyclicTimePeriodSearchOrder()
      Gets the cyclic time period search order.
      Returns:
      the cyclic time period search order
      Throws:
      IllegalStateException - supportsCyclicTimePeriodSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.