Interface LogEntry

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

A LogEntry is an entry of an issue.

  • Method Details

    • getAgentId

      Id getAgentId()
      Gets the Id of the agent.
      Returns:
      the agent Id
      Compliance:
      mandatory - This method must be implemented.

    • getAgent

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

    • getIssueId

      Id getIssueId()
      Gets the Id of the issue of this log entry.
      Returns:
      the issue Id
      Compliance:
      mandatory - This method must be implemented.

    • getIssue

      Issue getIssue() throws OperationFailedException
      Gets the issue of this log entry.
      Returns:
      the issue
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getDate

      DateTime getDate()
      Gets the date of this log entry.
      Returns:
      the date
      Compliance:
      mandatory - This method must be implemented.

    • getAction

      IssueAction getAction()
      Gets the action of this log entry.
      Returns:
      the issue action
      Compliance:
      mandatory - This method must be implemented.

    • getSummary

      DisplayText getSummary()
      Gets a summary header for this entry.
      Returns:
      the summary
      Compliance:
      mandatory - This method must be implemented.

    • getMessage

      DisplayText getMessage()
      Gets the text of this entry.
      Returns:
      the entry text
      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.