Interface TodoSearchOrder

All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidContainableSearchOrder, OsidExtensibleSearchOrder, OsidFederateableSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable
public interface TodoSearchOrder extends OsidObjectSearchOrder, OsidContainableSearchOrder, OsidTemporalSearchOrder, OsidFederateableSearchOrder

An interface for specifying the ordering of search results.

  • Method Details

    • orderByComplete

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

    • orderByPriority

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

    • orderByDueDate

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

    • getTodoSearchOrderRecord

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