Interface OsidRuleSearchOrder

All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidSearchOrder, Suppliable
All Known Subinterfaces:
ActionEnablerSearchOrder, AgendaSearchOrder, AuctionConstrainerEnablerSearchOrder, AuctionConstrainerSearchOrder, AuctionProcessorEnablerSearchOrder, AuctionProcessorSearchOrder, AuditConstrainerEnablerSearchOrder, AuditConstrainerSearchOrder, AuditEnablerSearchOrder, AuditProcessorEnablerSearchOrder, AuditProcessorSearchOrder, AuthorizationEnablerSearchOrder, AvailabilityEnablerSearchOrder, BallotConstrainerEnablerSearchOrder, BallotConstrainerSearchOrder, BidEnablerSearchOrder, BrokerConstrainerEnablerSearchOrder, BrokerConstrainerSearchOrder, BrokerEnablerSearchOrder, BrokerProcessorEnablerSearchOrder, BrokerProcessorSearchOrder, CanonicalUnitEnablerSearchOrder, CanonicalUnitProcessorEnablerSearchOrder, CanonicalUnitProcessorSearchOrder, CatalogEnablerSearchOrder, CheckSearchOrder, CommissionEnablerSearchOrder, CommitmentEnablerSearchOrder, CompositionEnablerSearchOrder, ContactEnablerSearchOrder, CourseRequirementSearchOrder, DemographicEnablerSearchOrder, DemographicSearchOrder, DeviceEnablerSearchOrder, DispatchConstrainerEnablerSearchOrder, DispatchConstrainerSearchOrder, DispatchEnablerSearchOrder, DispatchProcessorEnablerSearchOrder, DispatchProcessorSearchOrder, EdgeEnablerSearchOrder, FunctionSearchOrder, HoldEnablerSearchOrder, InputEnablerSearchOrder, InputSearchOrder, InquiryEnablerSearchOrder, InquirySearchOrder, InstructionSearchOrder, IssueConstrainerEnablerSearchOrder, IssueConstrainerSearchOrder, IssueEnablerSearchOrder, IssueProcessorEnablerSearchOrder, IssueProcessorSearchOrder, JobConstrainerEnablerSearchOrder, JobConstrainerSearchOrder, JobProcessorEnablerSearchOrder, JobProcessorSearchOrder, ObstacleEnablerSearchOrder, OfferingConstrainerEnablerSearchOrder, OfferingConstrainerSearchOrder, OffsetEventEnablerSearchOrder, OffsetEventSearchOrder, OsidConstrainerSearchOrder, OsidEffectuatorSearchOrder, OsidEnablerSearchOrder, OsidOperatorSearchOrder, OsidProcessorSearchOrder, OsidRuleApplicatorSearchOrder, ParameterProcessorEnablerSearchOrder, ParameterProcessorSearchOrder, ParameterSearchOrder, PoolConstrainerEnablerSearchOrder, PoolConstrainerSearchOrder, PoolEnablerSearchOrder, PoolProcessorEnablerSearchOrder, PoolProcessorSearchOrder, PriceEnablerSearchOrder, PriceSearchOrder, ProcessConstrainerEnablerSearchOrder, ProcessConstrainerSearchOrder, ProcessEnablerSearchOrder, ProcessProcessorEnablerSearchOrder, ProcessProcessorSearchOrder, ProfileEntryEnablerSearchOrder, ProvisionableEnablerSearchOrder, ProvisionEnablerSearchOrder, QueueConstrainerEnablerSearchOrder, QueueConstrainerEnablerSearchOrder, QueueConstrainerSearchOrder, QueueConstrainerSearchOrder, QueueEnablerSearchOrder, QueueEnablerSearchOrder, QueueProcessorEnablerSearchOrder, QueueProcessorEnablerSearchOrder, QueueProcessorSearchOrder, QueueProcessorSearchOrder, RaceConstrainerEnablerSearchOrder, RaceConstrainerSearchOrder, RaceProcessorEnablerSearchOrder, RaceProcessorSearchOrder, RecurringEventEnablerSearchOrder, RecurringEventSearchOrder, RelationshipEnablerSearchOrder, RelevancyEnablerSearchOrder, RequisiteSearchOrder, RuleSearchOrder, SequenceRuleEnablerSearchOrder, SequenceRuleSearchOrder, SignalEnablerSearchOrder, SignalSearchOrder, SpeedZoneEnablerSearchOrder, SpeedZoneSearchOrder, StepConstrainerEnablerSearchOrder, StepConstrainerSearchOrder, StepEnablerSearchOrder, StepProcessorEnablerSearchOrder, StepProcessorSearchOrder, StepSearchOrder, SubscriptionEnablerSearchOrder, SupersedingEventEnablerSearchOrder, SupersedingEventSearchOrder, TodoProducerSearchOrder, TriggerEnablerSearchOrder, TriggerSearchOrder, ValueEnablerSearchOrder, VoteEnablerSearchOrder
public interface OsidRuleSearchOrder extends OsidObjectSearchOrder, OsidOperableSearchOrder

An interface for specifying the ordering of search results.

  • Method Details

    • orderByRule

      void orderByRule(SearchOrderStyle style)
      Specifies a preference for ordering the results by the associated rule. The element of the rule to order is not specified but may be managed through a RuleSearchOrder .
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsRuleSearchOrder

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

    • getRuleSearchOrder

      RuleSearchOrder getRuleSearchOrder()
      Gets the search order for a rule.
      Returns:
      the rule search order
      Throws:
      UnimplementedException - supportsRuleSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRuleSearchOrder()} is {@code true} .