Interface LogEntrySearchOrder

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

An interface for specifying the ordering of search results.

  • Method Details

    • orderByAgent

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

    • supportsAgentSearchOrder

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

    • getAgentSearchOrder

      AgentSearchOrder getAgentSearchOrder()
      Gets the agent search order.
      Returns:
      the agent search order
      Throws:
      IllegalStateException - supportsCreatorSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByIssue

      void orderByIssue(SearchOrderStyle style)
      Orders the results by the 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.

    • orderByDate

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

    • orderBySummary

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

    • orderByMessage

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

    • getLogEntrySearchOrderRecord

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