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 specifies an AND term while multiple invocations of the same method produce a nested OR .

  • Method Details

    • matchPriority

      void matchPriority(Type priorityType, boolean match)
      Matches a priority Type for the log entry.
      Parameters:
      priorityType - Type to match
      match - true if for a positive match, false for a negative match
      Throws:
      NullArgumentException - priorityType is null
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyPriority

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

    • clearPriorityTerms

      void clearPriorityTerms()
      Clears the priority terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchMinimumPriority

      void matchMinimumPriority(Type priorityType, boolean match)
      Matches a log entries including and above the given priority type.
      Parameters:
      priorityType - Type to match
      match - true if for a positive match, false for a negative match
      Throws:
      NullArgumentException - priorityType is null
      Compliance:
      mandatory - This method must be implemented.

    • clearMinimumPriorityTerms

      void clearMinimumPriorityTerms()
      Clears the minimum priority terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchTimestamp

      void matchTimestamp(DateTime startTime, DateTime endTime, boolean match)
      Matches the time of this log entry.
      Parameters:
      startTime - start time
      endTime - end time
      match - true if for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - startTime is greater than endTime
      NullArgumentException - startTime or endTime is null
      Compliance:
      mandatory - This method must be implemented.

    • clearTimestampTerms

      void clearTimestampTerms()
      Clears the timestamp terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchResourceId

      void matchResourceId(Id resourceId, boolean match)
      Matches a resource in this log entry.
      Parameters:
      resourceId - Id to match
      match - true if for a positive match, false for a negative match
      Throws:
      NullArgumentException - resourceId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearResourceIdTerms

      void clearResourceIdTerms()
      Clears the resource Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsResourceQuery

      boolean supportsResourceQuery()
      Tests if a ResourceQuery is available for querying agents.
      Returns:
      true if a resource query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getResourceQuery

      ResourceQuery getResourceQuery()
      Gets the query for a resource.
      Returns:
      the resource query
      Throws:
      UnimplementedException - supportsResourceQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsResourceQuery()} is {@code true} .

    • clearResourceTerms

      void clearResourceTerms()
      Clears the resource terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchAgentId

      void matchAgentId(Id agentId, boolean match)
      Matches an agent in this log entry.
      Parameters:
      agentId - Id to match
      match - true if 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 terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsAgentQuery

      boolean supportsAgentQuery()
      Tests if an AgentQuery is available for querying agents.
      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.
      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 terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchLogId

      void matchLogId(Id logId, boolean match)
      Matches a log.
      Parameters:
      logId - Id to match
      match - true if for a positive match, false for a negative match
      Throws:
      NullArgumentException - logId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearLogIdTerms

      void clearLogIdTerms()
      Clears the log Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsLogQuery

      boolean supportsLogQuery()
      Tests if a LogQuery is available for querying logs.
      Returns:
      true if a log query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getLogQuery

      LogQuery getLogQuery()
      Gets the query for a log.
      Returns:
      the log query
      Throws:
      UnimplementedException - supportsLogQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsLogQuery()} is {@code true} .

    • clearLogTerms

      void clearLogTerms()
      Clears the log terms.
      Compliance:
      mandatory - This method must be implemented.

    • getLogEntryQueryRecord

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