Interface LogEntry

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject
public interface LogEntry extends OsidObject

A log entry consists of a time, an agent, and a priority type.

  • Method Details

    • getPriority

      Type getPriority()
      Gets the priority level of this entry.
      Returns:
      the priority level
      Compliance:
      mandatory - This method must be implemented.

    • getTimestamp

      DateTime getTimestamp()
      Gets the time this entry was logged.
      Returns:
      the time stamp of this entry
      Compliance:
      mandatory - This method must be implemented.

    • getResourceId

      Id getResourceId()
      Gets the resource Id who created this entry.
      Returns:
      the resource Id
      Compliance:
      mandatory - This method must be implemented.

    • getResource

      Resource getResource() throws OperationFailedException
      Gets the Resource who created this entry.
      Returns:
      the Resource
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getAgentId

      Id getAgentId()
      Gets the agent Id who created this entry.
      Returns:
      the agent Id
      Compliance:
      mandatory - This method must be implemented.

    • getAgent

      Agent getAgent() throws OperationFailedException
      Gets the Agent who created this entry.
      Returns:
      the Agent
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getLogEntryRecord

      LogEntryRecord getLogEntryRecord(Type logEntryRecordType) throws OperationFailedException
      Gets the log entry record corresponding to the given LogEntry record Type .This method is used to retrieve an object implementing the requested record. The logEntryRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(logEntryRecordType) is true .
      Parameters:
      logEntryRecordType - the type of log entry record to retrieve
      Returns:
      the log entry record
      Throws:
      NullArgumentException - logEntryRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(logEntryRecordType) is false
      Compliance:
      mandatory - This method must be implemented.