Package org.opencastproject.job.api

Interface Incident

All Known Implementing Classes:
IncidentImpl
public interface Incident
Describes an incident relating to a Job.

  • Method Details

    • getId

      long getId()
      Return the incident id.

    • getJobId

      long getJobId()
      The job related to this incident.
      Returns:
      the job id

    • getServiceType

      String getServiceType()
      The service type on which the incident was occurring.
      Returns:
      the service type

    • getProcessingHost

      String getProcessingHost()
      The processing host running the job where the incident was occurring.
      Returns:
      the processing host

    • getTimestamp

      Date getTimestamp()
      The date where the incident was happening.
      Returns:
      the date

    • getSeverity

      Incident.Severity getSeverity()
      The severity of this incident.
      Returns:
      the severity

    • getCode

      String getCode()
      The unique code of this incident. Incident codes may be mapped to plain text, possibly localized. It is recommended to create codes after the schema service_type.number, e.g. org.opencastproject.service.1511
      Returns:
      the incident code
      See Also:

    • getDetails

      List<Tuple<String,String>> getDetails()
      List of additional technical information having a name and a text [(name, text)]. This may be an exception, an ffmpeg commandline, memory statistics, etc.
      Returns:
      a list of technical background information describing the incident in depth [(detail_name, detail)]

    • getDescriptionParameters

      Map<String,String> getDescriptionParameters()
      Named parameters describing the incident in more detail. These parameters may be used to construct a description message.
      Returns:
      the message parameters; parameter_name -> parameter_value