org.activiti.engine.impl.persistence.entity.JobEntity 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

There is a newer version: 7.1.0.M6

/* 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.impl.persistence.entity;

import java.util.Date;

import org.activiti.engine.impl.db.Entity;
import org.activiti.engine.impl.db.HasRevision;
import org.activiti.engine.runtime.Job;

/**
 * Stub of the common parts of a Job. You will normally work with a subclass of JobEntity, such as {@link TimerEntity} or {@link MessageEntity}.
 *
 * @author Tom Baeyens
 * @author Nick Burch
 * @author Dave Syer
 * @author Frederik Heremans
 * @author Joram Barrez
 */
public interface JobEntity extends Job, Entity, HasRevision {
  
  boolean DEFAULT_EXCLUSIVE = true;
  int DEFAULT_RETRIES = 3;
  int MAX_EXCEPTION_MESSAGE_LENGTH = 255;

  void setExecution(ExecutionEntity execution);

  String getExceptionStacktrace();

  void setExceptionStacktrace(String exception);

  void setDuedate(Date duedate);

  void setExecutionId(String executionId);

  void setRetries(int retries);

  String getLockOwner();

  void setLockOwner(String claimedBy);

  Date getLockExpirationTime();

  void setLockExpirationTime(Date claimedUntil);

  void setProcessInstanceId(String processInstanceId);

  boolean isExclusive();

  void setExclusive(boolean isExclusive);

  void setProcessDefinitionId(String processDefinitionId);

  String getJobHandlerType();

  void setJobHandlerType(String jobHandlerType);

  String getJobHandlerConfiguration();

  void setJobHandlerConfiguration(String jobHandlerConfiguration);

  void setExceptionMessage(String exceptionMessage);

  String getJobType();

  void setJobType(String jobType);

  void setTenantId(String tenantId);

  ByteArrayRef getExceptionByteArrayRef();

}