Interface HoldSearchOrder

All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidRelationshipSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable
public interface HoldSearchOrder extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

  • Method Details

    • orderByResource

      void orderByResource(SearchOrderStyle style)
      Orders the results by resource.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsResourceSearchOrder

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

    • getResourceSearchOrder

      ResourceSearchOrder getResourceSearchOrder()
      Gets the resource search order.
      Returns:
      the resource search order
      Throws:
      IllegalStateException - supportsResourceSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByIssue

      void orderByIssue(SearchOrderStyle style)
      Orders the results by issue.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsIssueSearchOrder

      boolean supportsIssueSearchOrder()
      Tests if an issue search order is available.
      Returns:
      true if an issue search order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getIssueSearchOrder

      IssueSearchOrder getIssueSearchOrder()
      Gets the issue search order.
      Returns:
      the issue search order
      Throws:
      IllegalStateException - supportsIssueSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • getHoldSearchOrderRecord

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