org.activiti.engine.runtime.Job Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of activiti-engine Show documentation
The newest version!
/* Licensed under the Apache License, Version 2.0 (the "License");
 * 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.activiti.engine.runtime;

import java.util.Date;

import org.activiti.engine.ManagementService;
import org.activiti.engine.api.internal.Internal;

/**
 * Represents one job (timer, async job, etc.).
 *
 */
@Internal
public interface Job {
  
  String JOB_TYPE_TIMER = "timer";
  String JOB_TYPE_MESSAGE = "message";
  
  boolean DEFAULT_EXCLUSIVE = true;
  int MAX_EXCEPTION_MESSAGE_LENGTH = 255;

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

  /**
   * Returns the date on which this job is supposed to be processed.
   */
  Date getDuedate();

  /**
   * Returns the id of the process instance which execution created the job.
   */
  String getProcessInstanceId();

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

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

  /**
   * Returns the number of retries this job has left. Whenever the jobexecutor fails to execute the job, this value is decremented. When it hits zero, the job is supposed to be dead and not retried
   * again (ie a manual retry is required then).
   */
  int getRetries();

  /**
   * Returns the message of the exception that occurred, the last time the job was executed. Returns null when no exception occurred.
   * 
   * To get the full exception stacktrace, use {@link ManagementService#getJobExceptionStacktrace(String)}
   */
  String getExceptionMessage();

  /**
   * Get the tenant identifier for this job.
   */
  String getTenantId();
  
  /**
   * Is the job exclusive?
   */
  boolean isExclusive();
  
  /**
   * Get the job type for this job.
   */
  String getJobType();
  
  /**
   * Get the job handler type.
   */
  String getJobHandlerType();
  
  /**
   * Get the job configuration.
   */
  String getJobHandlerConfiguration();

}