Package org.kinotic.continuum.grind.api

Interface JobDefinition

All Superinterfaces:

HasSteps

All Known Implementing Classes:

DefaultJobDefinition

public interface JobDefinition
extends HasSteps

A JobDefinition provides a unit of work comprised of Task's and other JobDefinition For every JobDefinition a Spring ApplicationContext is provided, to allow Task's to automatically store and access data produced by Task's Created by Navid Mitchell on 3/19/20

Method Summary

Modifier and Type	Method	Description
static JobDefinition	create()	Create a new JobDefinition with a JobScope.CHILD and isParallel() is false
static JobDefinition	create(java.lang.String description)
static JobDefinition	create(java.lang.String description, boolean parallel)
static JobDefinition	create(java.lang.String description, JobScope jobScope)
static JobDefinition	create(java.lang.String description, JobScope jobScope, boolean parallel)
java.lang.String	getDescription()
JobScope	getScope()	The JobScope that will be used during the execution of this JobDefinition
java.util.List<Step>	getSteps()
boolean	isParallel()	If this JobDefinition supports running it's Task's in parallel
JobDefinition	jobDefinition(JobDefinition jobDefinition)	Adds a inner JobDefinition to this JobDefinition
JobDefinition	task(Task<?> task)	Adds a Task to the list of Task's that will be executed by this JobDefinition
JobDefinition	taskStoreResult(Task<?> task)	Adds a Task to the list of Task's that will be executed by this JobDefinition and stores the result of the Task execution within the context for this JobDefinition
JobDefinition	taskStoreResult(Task<?> task, java.lang.String variableName)	Adds a Task to the list of Task's that will be executed by this JobDefinition and stores the result of the Task execution within the context for this JobDefinition

Method Detail

getDescription

java.lang.String getDescription()

Returns:

the description of this JobDefinition

isParallel

boolean isParallel()

If this JobDefinition supports running it's Task's in parallel

Returns:

true if Tasks's can be run in parallel false if not

getScope

JobScope getScope()

The JobScope that will be used during the execution of this JobDefinition

Returns:

the JobScope the default is JobScope.CHILD

task

JobDefinition task(Task<?> task)

Adds a Task to the list of Task's that will be executed by this JobDefinition

Parameters:

task - to add

Returns:

this for fluent use

taskStoreResult

JobDefinition taskStoreResult(Task<?> task)

Adds a Task to the list of Task's that will be executed by this JobDefinition and stores the result of the Task execution within the context for this JobDefinition

Parameters:

task - to add

Returns:

this for fluent use

taskStoreResult

JobDefinition taskStoreResult(Task<?> task,
                              java.lang.String variableName)

Adds a Task to the list of Task's that will be executed by this JobDefinition and stores the result of the Task execution within the context for this JobDefinition

Parameters:

task - to add

variableName - the name to use when storing the Task result in the context for this JobDefinition

Returns:

this for fluent use

jobDefinition

JobDefinition jobDefinition(JobDefinition jobDefinition)

Adds a inner JobDefinition to this JobDefinition

Parameters:

jobDefinition - to add into this JobDefinition

Returns:

this for fluent use

getSteps

java.util.List<Step> getSteps()

Specified by:

getSteps in interface HasSteps

Returns:

the Step's defined for this JobDefinition

create

static JobDefinition create()

Create a new JobDefinition with a JobScope.CHILD and isParallel() is false

Returns:

the new JobDefinition

create

static JobDefinition create(java.lang.String description)

create

static JobDefinition create(java.lang.String description,
                            JobScope jobScope)

create

static JobDefinition create(java.lang.String description,
                            JobScope jobScope,
                            boolean parallel)

create

static JobDefinition create(java.lang.String description,
                            boolean parallel)