Class 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 Details

    • JobDefinition

      public JobDefinition(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(String extensionName, @Nullable @Nullable Map<String,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 Details