Interface OsidSourceableSearchOrder

All Superinterfaces:
OsidSearchOrder, Suppliable
All Known Subinterfaces:
AcademySearchOrder, AddressBookSearchOrder, AgencySearchOrder, AntimatroidSearchOrder, AssetSearchOrder, AuctionHouseSearchOrder, AuctionSearchOrder, AuditSearchOrder, BallotSearchOrder, BankSearchOrder, BillingSearchOrder, BinSearchOrder, BlogSearchOrder, BookSearchOrder, BrokerSearchOrder, BusinessSearchOrder, BusinessSearchOrder, CalendarSearchOrder, CampusSearchOrder, CatalogSearchOrder, CatalogueSearchOrder, ChecklistSearchOrder, CompositionSearchOrder, ConfigurationSearchOrder, ConvocationSearchOrder, CookbookSearchOrder, CourseCatalogSearchOrder, DepotSearchOrder, DictionarySearchOrder, DirectorySearchOrder, DispatchSearchOrder, DistributorSearchOrder, EngineSearchOrder, EngineSearchOrder, EntrySearchOrder, FamilySearchOrder, ForumSearchOrder, FoundrySearchOrder, FrontOfficeSearchOrder, GradebookSearchOrder, GraphSearchOrder, HierarchySearchOrder, InquestSearchOrder, IssueSearchOrder, JobSearchOrder, JournalSearchOrder, LogSearchOrder, MailboxSearchOrder, MapSearchOrder, ObjectiveBankSearchOrder, OfficeSearchOrder, OntologySearchOrder, OsidCatalogSearchOrder, OsidGovernatorSearchOrder, OublietteSearchOrder, PackageSearchOrder, PollsSearchOrder, PoolSearchOrder, PressSearchOrder, ProcessSearchOrder, ProcessSearchOrder, ProfileSearchOrder, PublisherSearchOrder, QueueSearchOrder, QueueSearchOrder, RaceSearchOrder, RealmSearchOrder, RecipeSearchOrder, RepositorySearchOrder, StoreSearchOrder, SystemSearchOrder, UtilitySearchOrder, VaultSearchOrder, WarehouseSearchOrder
public interface OsidSourceableSearchOrder extends OsidSearchOrder

An interface for specifying the ordering of search results.

  • Method Details

    • orderByProvider

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

    • supportsProviderSearchOrder

      boolean supportsProviderSearchOrder()
      Tests if a ProviderSearchOrder interface is available.
      Returns:
      true if a provider search order interface is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getProviderSearchOrder

      ResourceSearchOrder getProviderSearchOrder()
      Gets the search order interface for a provider.
      Returns:
      the provider search order interface
      Throws:
      UnimplementedException - supportsProviderSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProviderSearchOrder()} is {@code true} .