org.camunda.bpm.engine.impl.jobexecutor

Class JobDeclaration<T extends JobEntity>

java.lang.Object

org.camunda.bpm.engine.impl.jobexecutor.JobDeclaration<T>

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

MessageJobDeclaration, TimerDeclarationImpl

public abstract class JobDeclaration<T extends JobEntity>
extends Object
implements Serializable

A job declaration is associated with an activity in the process definition graph. It provides data about Jobs which are to be created when executing this activity. It also acts as a factory for new Job Instances.

Author:

Daniel Meyer

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	activityId
protected boolean	exclusive
protected String	jobConfiguration
protected String	jobDefinitionId the id of the associated persistent jobDefinitionId
protected String	jobHandlerConfiguration
protected String	jobHandlerType
protected int	retries

Constructor Summary

Constructors

Constructor and Description
JobDeclaration(String jobHandlerType)

Method Summary

Methods

Modifier and Type	Method and Description
T	createJobInstance(ExecutionEntity execution)
String	getActivityId()
String	getJobConfiguration()
String	getJobDefinitionId()
String	getJobHandlerConfiguration()
String	getJobHandlerType()
int	getRetries()
boolean	isExclusive()
protected abstract T	newJobInstance(ExecutionEntity execution)
void	setActivityId(String activityId)
void	setExclusive(boolean exclusive)
void	setJobConfiguration(String jobConfiguration)
void	setJobDefinitionId(String jobDefinitionId)
void	setJobHandlerConfiguration(String jobHandlerConfiguration)
void	setJobHandlerType(String jobHandlerType)
void	setRetries(int retries)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

jobDefinitionId

protected String jobDefinitionId

the id of the associated persistent jobDefinitionId

jobHandlerType

protected String jobHandlerType

jobHandlerConfiguration

protected String jobHandlerConfiguration

jobConfiguration

protected String jobConfiguration

exclusive

protected boolean exclusive

retries

protected int retries

activityId

protected String activityId

Constructor Detail

JobDeclaration

public JobDeclaration(String jobHandlerType)

Method Detail

createJobInstance

public T createJobInstance(ExecutionEntity execution)

Parameters:

execution - can be null in case of a timer start event.

Returns:

the created Job instances

newJobInstance

protected abstract T newJobInstance(ExecutionEntity execution)

getJobDefinitionId

public String getJobDefinitionId()

setJobDefinitionId

public void setJobDefinitionId(String jobDefinitionId)

getJobHandlerType

public String getJobHandlerType()

getJobHandlerConfiguration

public String getJobHandlerConfiguration()

setJobHandlerConfiguration

public void setJobHandlerConfiguration(String jobHandlerConfiguration)

isExclusive

public boolean isExclusive()

setExclusive

public void setExclusive(boolean exclusive)

getRetries

public int getRetries()

setRetries

public void setRetries(int retries)

setJobHandlerType

public void setJobHandlerType(String jobHandlerType)

getActivityId

public String getActivityId()

setActivityId

public void setActivityId(String activityId)

getJobConfiguration

public String getJobConfiguration()

setJobConfiguration

public void setJobConfiguration(String jobConfiguration)