Interface PackageSearchOrder

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

An interface for specifying the ordering of search results.

  • Method Details

    • orderByVersion

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

    • orderByCopyright

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

    • orderByRequiresLicenseAcknowledgement

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

    • orderByCreator

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

    • supportsCreatorSearchOrder

      boolean supportsCreatorSearchOrder()
      Tests if a ResourceSearchOrder is available for creator resources.
      Returns:
      true if a creator resource search order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getCreatorSearchOrder

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

    • orderByReleaseDate

      void orderByReleaseDate(SearchOrderStyle style)
      Specified a preference for ordering results by the release date.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByURL

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

    • getPackageSearchOrderRecord

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