org.camunda.bpm.engine.history.HistoricJobLog Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of camunda-engine Show documentation
The Camunda BPMN engine + configurable support for GraalVM and support for CockroachDB.
The newest version!
/*
 * Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH
 * under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright
 * ownership. Camunda licenses this file to you under the Apache License,
 * Version 2.0; you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.camunda.bpm.engine.history;

import java.util.Date;

import org.camunda.bpm.engine.HistoryService;
import org.camunda.bpm.engine.runtime.Job;

/**
 * The {@link HistoricJobLog} is used to have a log containing
 * information about {@link Job job} execution. The log provides
 * details about the complete lifecycle of a {@link Job job}:
 * 
 *   job created
 *   job execution failed
 *   job execution successful
 *   job was deleted
 * 
 *
 * An instance of {@link HistoricJobLog} represents a state in
 * the lifecycle of a {@link Job job}.
 *
 * @author Roman Smirnov
 *
 * @since 7.3
 */
public interface HistoricJobLog {

  /**
   * Returns the unique identifier for this historic job log.
   */
  String getId();

  /**
   * Returns the time when this log occurred.
   */
  Date getTimestamp();

  /**
   * Returns the id of the associated job.
   */
  String getJobId();

  /**
   * Returns the due date of the associated job when this log occurred.
   */
  Date getJobDueDate();

  /**
   * Returns the retries of the associated job before the associated job has
   * been executed and when this log occurred.
   */
  int getJobRetries();

  /**
   * Returns the priority of the associated job when this log entry was created.
   *
   * @since 7.4
   */
  long getJobPriority();

  /**
   * Returns the message of the exception that occurred by executing the associated job.
   *
   * To get the full exception stacktrace,
   * use {@link HistoryService#getHistoricJobLogExceptionStacktrace(String)}
   */
  String getJobExceptionMessage();

  /**
   * Returns the id of the job definition on which the associated job was created.
   */
  String getJobDefinitionId();

  /**
   * Returns the job definition type of the associated job.
   */
  String getJobDefinitionType();

  /**
   * Returns the job definition configuration type of the associated job.
   */
  String getJobDefinitionConfiguration();

  /**
   * Returns the id of the activity on which the associated job was created.
   */
  String getActivityId();

  /**
   * Returns the specific execution id on which the associated job was created.
   */
  String getExecutionId();

  /**
   * Returns the specific root process instance id of the process instance
   * on which the associated job was created.
   */
  String getRootProcessInstanceId();

  /**
   * Returns the specific process instance id on which the associated job was created.
   */
  String getProcessInstanceId();

  /**
   * Returns the specific process definition id on which the associated job was created.
   */
  String getProcessDefinitionId();

  /**
   * Returns the specific process definition key on which the associated job was created.
   */
  String getProcessDefinitionKey();

  /**
   * Returns the specific deployment id on which the associated job was created.
   */
  String getDeploymentId();

  /**
   * Returns the id of the tenant this job log entry belongs to. Can be null
   * if the job log entry belongs to no single tenant.
   */
  public String getTenantId();

  /**
   * Returns true when this log represents
   * the creation of the associated job.
   */
  boolean isCreationLog();

  /**
   * Returns true when this log represents
   * the failed execution of the associated job.
   */
  boolean isFailureLog();

  /**
   * Returns true when this log represents
   * the successful execution of the associated job.
   */
  boolean isSuccessLog();

  /**
   * Returns true when this log represents
   * the deletion of the associated job.
   */
  boolean isDeletionLog();

  /** The time the historic job log will be removed. */
  Date getRemovalTime();

}