Interface OsidRelationshipSearchOrder

All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable
All Known Subinterfaces:
ActivityRegistrationSearchOrder, ActivitySearchOrder, AppointmentSearchOrder, AssessmentEntrySearchOrder, AuthorizationSearchOrder, AvailabilitySearchOrder, AwardEntrySearchOrder, BidSearchOrder, BudgetEntrySearchOrder, BudgetSearchOrder, CandidateSearchOrder, CommentSearchOrder, CommissionSearchOrder, CommitmentSearchOrder, ConferralSearchOrder, ContactSearchOrder, CourseEntrySearchOrder, CourseOfferingSearchOrder, CourseRegistrationSearchOrder, CredentialEntrySearchOrder, CreditSearchOrder, DeedSearchOrder, DocetSearchOrder, EdgeSearchOrder, EffortSearchOrder, EnrollmentSearchOrder, EntrySearchOrder, GradeEntrySearchOrder, HoldSearchOrder, InstructionSearchOrder, IssueSearchOrder, LeaseSearchOrder, LessonSearchOrder, OfferingSearchOrder, OrderItemSearchOrder, ParticipantSearchOrder, PathSearchOrder, PlanSearchOrder, ProficiencySearchOrder, ProfileEntrySearchOrder, ProgramEntrySearchOrder, ProgramOfferingSearchOrder, ProvisionableSearchOrder, ProvisionSearchOrder, RegistrationSearchOrder, RelationshipSearchOrder, RelevancySearchOrder, RequestSearchOrder, RequestTransactionSearchOrder, ResourceRelationshipSearchOrder, ResponseSearchOrder, RouteSearchOrder, SubscriptionSearchOrder, VoteSearchOrder
public interface OsidRelationshipSearchOrder extends OsidObjectSearchOrder, OsidTemporalSearchOrder

An interface for specifying the ordering of search results.

  • Method Details

    • orderByEndReason

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

    • supportsEndReasonSearchOrder

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

    • getEndReasonSearchOrder

      StateSearchOrder getEndReasonSearchOrder()
      Gets the search order for a state.
      Returns:
      the state search order
      Throws:
      UnimplementedException - supportsEndReasonSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsEndReasonSearchOrder()} is {@code true}.