Interface PostEntrySearchOrder

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

An interface for specifying the ordering of search results.

  • Method Details

    • orderByPost

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

    • supportsPostSearchOrder

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

    • getPostSearchOrder

      PostSearchOrder getPostSearchOrder()
      Gets the post order.
      Returns:
      the post search order
      Throws:
      UnimplementedException - supportsPostSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPostSearchOrder()} is {@code true} .

    • orderByAccount

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

    • supportsAccountSearchOrder

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

    • getAccountSearchOrder

      AccountSearchOrder getAccountSearchOrder()
      Gets the account order.
      Returns:
      the account search order
      Throws:
      UnimplementedException - supportsAccountSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAccountSearchOrder()} is {@code true} .

    • orderByActivity

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

    • supportsActivitySearchOrder

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

    • getActivitySearchOrder

      ActivitySearchOrder getActivitySearchOrder()
      Gets the activity search order.
      Returns:
      the activity search order
      Throws:
      UnimplementedException - supportsActivitySearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsActivitySearchOrder()} is {@code true} .

    • orderByAmount

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

    • orderByDebit

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

    • getPostEntrySearchOrderRecord

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