Interface LogEntryQuery

All Superinterfaces:
Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, Suppliable
public interface LogEntryQuery extends OsidObjectQuery

This is the query for searching log entries. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR .

  • Method Details

    • matchAgentId

      void matchAgentId(Id agentId, boolean match)
      Sets the agent Id for this query.
      Parameters:
      agentId - the agent Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - agentId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearAgentIdTerms

      void clearAgentIdTerms()
      Clears the agent Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsAgentQuery

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

    • getAgentQuery

      AgentQuery getAgentQuery()
      Gets the query for an agent. Multiple retrievals produce a nested OR term.
      Returns:
      the agent query
      Throws:
      UnimplementedException - supportsAgentQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAgentQuery()} is {@code true} .

    • clearAgentTerms

      void clearAgentTerms()
      Clears the agent query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchIssueId

      void matchIssueId(Id issueId, boolean match)
      Sets the issue Id for this query.
      Parameters:
      issueId - the issue Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - issueId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearIssueIdTerms

      void clearIssueIdTerms()
      Clears the issue Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsIssueQuery

      boolean supportsIssueQuery()
      Tests if an IssueQuery is available for an ending issue.
      Returns:
      true if an issue query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getIssueQuery

      IssueQuery getIssueQuery()
      Gets the query for an issue. Multiple retrievals produce a nested OR term.
      Returns:
      the issue query
      Throws:
      UnimplementedException - supportsIssueQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsIssueQuery()} is {@code true} .

    • clearIssueTerms

      void clearIssueTerms()
      Clears the issue query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchDate

      void matchDate(DateTime from, DateTime to, boolean match)
      Matches log entries that have the specified date inclusive.
      Parameters:
      from - starting range
      to - ending range
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - to is less than from
      NullArgumentException - from or to is null
      Compliance:
      mandatory - This method must be implemented.

    • clearDateTerms

      void clearDateTerms()
      Clears the date query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchSummary

      void matchSummary(String summary, Type stringMatchType, boolean match)
      Matches a summary.
      Parameters:
      summary - summary
      stringMatchType - a string match type
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - summary not of stringMatchType
      NullArgumentException - summary or stringMatchType is null
      UnsupportedException - stringMatchType not supported
      Compliance:
      mandatory - This method must be implemented.

    • matchAnySummary

      void matchAnySummary(boolean match)
      Matches log entries that has any summary.
      Parameters:
      match - true to match log entries with any summary, false to match log entries with no summary
      Compliance:
      mandatory - This method must be implemented.

    • clearSummaryTerms

      void clearSummaryTerms()
      Clears the summary query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchMessage

      void matchMessage(String message, Type stringMatchType, boolean match)
      Matches a message.
      Parameters:
      message - a message
      stringMatchType - a string match type
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - message not of stringMatchType
      NullArgumentException - message or stringMatchType is null
      UnsupportedException - stringMatchType not supported
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyMessage

      void matchAnyMessage(boolean match)
      Matches log entries that has any message.
      Parameters:
      match - true to match log entries with any message, false to match log entries with no message
      Compliance:
      mandatory - This method must be implemented.

    • clearMessageTerms

      void clearMessageTerms()
      Clears the message query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchFrontOfficeId

      void matchFrontOfficeId(Id frontOfficeId, boolean match)
      Sets the front office Id for this query to match log entries assigned to front offices.
      Parameters:
      frontOfficeId - the front office Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - frontOfficeId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearFrontOfficeIdTerms

      void clearFrontOfficeIdTerms()
      Clears the front office Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsFrontOfficeQuery

      boolean supportsFrontOfficeQuery()
      Tests if a FrontOfficeQuery is available.
      Returns:
      true if a front office query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getFrontOfficeQuery

      FrontOfficeQuery getFrontOfficeQuery()
      Gets the query for a front office. Multiple retrievals produce a nested OR term.
      Returns:
      the front office query
      Throws:
      UnimplementedException - supportsFrontOfficeQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsFrontOfficeQuery()} is {@code true} .

    • clearFrontOfficeTerms

      void clearFrontOfficeTerms()
      Clears the front office query terms.
      Compliance:
      mandatory - This method must be implemented.

    • getLogEntryQueryRecord

      LogEntryQueryRecord getLogEntryQueryRecord(Type logEntryRecordType) throws OperationFailedException
      Gets the log entry query record corresponding to the given LogEntry record Type .Multiple record retrievals produce a nested OR term.
      Parameters:
      logEntryRecordType - an log entry record type
      Returns:
      the log entry query record
      Throws:
      NullArgumentException - logEntryRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(logEntryRecordType) is false
      Compliance:
      mandatory - This method must be implemented.