Interface OsidRequestSearchOrder

All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, Suppliable
All Known Subinterfaces:
RegistrationRequestSearchOrder
public interface OsidRequestSearchOrder extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

  • Method Details

    • orderByPostingDate

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

    • orderByRequester

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

    • supportsRequesterSearchOrder

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

    • getRequesterSearchOrder

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

    • orderBySubmittedDate

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

    • orderBySubmitter

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

    • supportsSubmitterSearchOrder

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

    • getSubmitterSearchOrder

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

    • orderBySubmittingAgent

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

    • supportsSubmittingAgentSearchOrder

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

    • getSubmittingAgentSearchOrder

      AgentSearchOrder getSubmittingAgentSearchOrder()
      Gets the search order for a submitting agent.
      Returns:
      the submitting agent search order
      Throws:
      UnimplementedException - supportsSubmittingAgentSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsSubmittingAgentSearchOrder()} is {@code true} .

    • orderByCanceledDate

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

    • orderByProcessedDate

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

    • orderByError

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

    • supportsErrorSearchOrder

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

    • getErrorSearchOrder

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