Package com.inet.taskplanner.server.api.job

Class JobDefinition

java.lang.Object

com.inet.taskplanner.server.api.common.AbstractDefinition<JobDefinition>

com.inet.taskplanner.server.api.job.JobDefinition

@JsonData
public final class JobDefinition
extends AbstractDefinition<JobDefinition>

Definition of a job for a TaskDefinition with settings required for the job. A job does some work and often produces some Results which is than passed to the adjacent ResultActions.

Jobs are created from the definition roughly as:

 JobDefinition ——extensionName—⟶ JobFactory ——createFrom()—⟶ Job
 

To map from a JobDefinition to a JobFactory the method AbstractDefinition.getExtensionName() has to return a name for which a JobFactory is registered in the ServerPluginManager.
This definition also includes settings for the job, i.e. for a report-job the path to the rpt-file. The extension name and the valid properties are usually defined and documented in the corresponding JobFactory.

Since:

taskplanner 3.0

Constructor Summary

Constructors

Constructor	Description
JobDefinition(java.lang.String extensionName)	Creates a new JobDefinition instance.
JobDefinition(java.lang.String extensionName, java.util.Map<java.lang.String,java.lang.String> properties)	Creates a new JobDefinition instance.

Method Summary

Modifier and Type	Method	Description
JobDefinition	copyDefinition()	Makes a deep copy of this definition.
boolean	equals(java.lang.Object obj)
ConditionDefinition	getCondition()	Get the condition of this Job.
int	hashCode()
void	setCondition(ConditionDefinition condition)	Sets the condition of this JobDefinition.

Methods inherited from class com.inet.taskplanner.server.api.common.AbstractDefinition

copyDefinitions, getExtensionName, getProperties, getProperty, getUid, removeProperty, setProperty, setUid

Methods inherited from class java.lang.Object

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

Constructor Detail

JobDefinition

public JobDefinition(java.lang.String extensionName)

Creates a new JobDefinition instance.

Parameters:

extensionName - the unique extensionName, there must be a JobFactory for this extensionName.

Since:

taskplanner 3.0

JobDefinition

public JobDefinition(java.lang.String extensionName,
                     @Nullable
                     java.util.Map<java.lang.String,java.lang.String> properties)

Creates a new JobDefinition instance.

Parameters:

properties - the initial properties to be set, null will have no effect

extensionName - the unique extensionName, there must be a JobFactory for this extensionName.

Since:

taskplanner 3.0

Method Detail

getCondition

@Nullable
public ConditionDefinition getCondition()

Get the condition of this Job.

Returns:

the condition of this job, can be null.

Since:

taskplanner 3.0

setCondition

public void setCondition(@Nullable
                         ConditionDefinition condition)

Sets the condition of this JobDefinition. The condition defines if the result of this job must be handled or not.

Parameters:

condition - the condition to set

Since:

taskplanner 3.0

copyDefinition

public JobDefinition copyDefinition()

Makes a deep copy of this definition.

Specified by:

copyDefinition in class AbstractDefinition<JobDefinition>

Returns:

a deep copy of this definition.

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractDefinition<JobDefinition>

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class AbstractDefinition<JobDefinition>