Interface AssetSearchOrder

All Superinterfaces:
Extensible, OsidAggregateableSearchOrder, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, OsidSourceableSearchOrder, Suppliable
public interface AssetSearchOrder extends OsidObjectSearchOrder, OsidAggregateableSearchOrder, OsidSourceableSearchOrder

An interface for specifying the ordering of search results.

  • Method Details

    • orderByTitle

      void orderByTitle(SearchOrderStyle style)
      Specifies a preference for ordering the result set by asset title.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByPublicDomain

      void orderByPublicDomain(SearchOrderStyle style)
      Specifies a preference for grouping the result set by published domain.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByCopyright

      void orderByCopyright(SearchOrderStyle style)
      Specifies a preference for grouping the result set by copyright.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByCopyrightRegistration

      void orderByCopyrightRegistration(SearchOrderStyle style)
      Specifies a preference for grouping the result set by copyright registration.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByDistributeVerbatim

      void orderByDistributeVerbatim(SearchOrderStyle style)
      Specifies a preference for grouping the result set by the ability to distribute copies.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByDistributeAlterations

      void orderByDistributeAlterations(SearchOrderStyle style)
      Specifies a preference for grouping the result set by the ability to distribute alterations.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByDistributeCompositions

      void orderByDistributeCompositions(SearchOrderStyle style)
      Specifies a preference for grouping the result set by the ability to distribute compositions.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderBySource

      void orderBySource(SearchOrderStyle style)
      Specifies a preference for ordering the result set by asset source.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsSourceSearchOrder

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

    • getSourceSearchOrder

      ResourceSearchOrder getSourceSearchOrder()
      Gets the source order.
      Returns:
      the resource search order for the source
      Throws:
      UnimplementedException - supportsSourceSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsSourceSearchOrder()} is {@code true} .

    • orderByCreatedDate

      void orderByCreatedDate(SearchOrderStyle style)
      Specifies a preference for ordering the result set by created date.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByPublished

      void orderByPublished(SearchOrderStyle style)
      Specifies a preference for grouping the result set by published status.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByPublishedDate

      void orderByPublishedDate(SearchOrderStyle style)
      Specifies a preference for ordering the result set by published date.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByPrincipalCreditString

      void orderByPrincipalCreditString(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the principal credits.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByTemporalCoverage

      void orderByTemporalCoverage(SearchOrderStyle style)
      Specifies a preference for ordering the result set by temporal coverage.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • getAssetSearchOrderRecord

      AssetSearchOrderRecord getAssetSearchOrderRecord(Type assetRecordType) throws OperationFailedException
      Gets the asset search order record corresponding to the given asset record Type . Multiple retrievals return the same underlying object.
      Parameters:
      assetRecordType - an asset record type
      Returns:
      the asset search order record
      Throws:
      NullArgumentException - assetRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(assetRecordType) is false
      Compliance:
      mandatory - This method must be implemented.