Interface PostSearchOrder

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

An interface for specifying the ordering of search results.

  • Method Details

    • orderByTimestamp

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

    • orderByPoster

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

    • supportsPosterSearchOrder

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

    • getPosterSearchOrder

      ResourceSearchOrder getPosterSearchOrder()
      Gets the poster order interface.
      Returns:
      the poster search order interface
      Throws:
      UnimplementedException - supportsPosterSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPosterSearchOrder()} is {@code true} .

    • orderByPostingAgent

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

    • supportsPostingAgentSearchOrder

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

    • getPostingAgentSearchOrder

      AgentSearchOrder getPostingAgentSearchOrder()
      Gets the posting agent search order interface.
      Returns:
      the posting agent search order interface
      Throws:
      UnimplementedException - supportsPostingAgentSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPostingAgentSearchOrder()} is {@code true} .

    • orderBySubjectLine

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

    • orderByText

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

    • getPostSearchOrderRecord

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