Package org.kinotic.continuum.grind.internal.api

Class DefaultJobDefinition

java.lang.Object

org.kinotic.continuum.grind.internal.api.DefaultJobDefinition

All Implemented Interfaces:

HasSteps, JobDefinition

public class DefaultJobDefinition
extends java.lang.Object
implements JobDefinition

NOTE: should not be instantiated directly Created by Navid Mitchell on 3/19/20

Constructor Summary

Constructors

Constructor	Description
DefaultJobDefinition(java.lang.String description, JobScope jobScope, boolean parallel)

Method Summary

Modifier and Type	Method	Description
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

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultJobDefinition

public DefaultJobDefinition(java.lang.String description,
                            JobScope jobScope,
                            boolean parallel)

Method Detail

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface JobDefinition

Returns:

the description of this JobDefinition

isParallel

public boolean isParallel()

Description copied from interface: JobDefinition

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

Specified by:

isParallel in interface JobDefinition

Returns:

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

getScope

public JobScope getScope()

Description copied from interface: JobDefinition

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

Specified by:

getScope in interface JobDefinition

Returns:

the JobScope the default is JobScope.CHILD

task

public JobDefinition task(Task<?> task)

Description copied from interface: JobDefinition

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

Specified by:

task in interface JobDefinition

Parameters:

task - to add

Returns:

this for fluent use

taskStoreResult

public JobDefinition taskStoreResult(Task<?> task)

Description copied from interface: JobDefinition

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

Specified by:

taskStoreResult in interface JobDefinition

Parameters:

task - to add

Returns:

this for fluent use

taskStoreResult

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

Description copied from interface: JobDefinition

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

Specified by:

taskStoreResult in interface 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

public JobDefinition jobDefinition(JobDefinition jobDefinition)

Description copied from interface: JobDefinition

Adds a inner JobDefinition to this JobDefinition

Specified by:

jobDefinition in interface JobDefinition

Parameters:

jobDefinition - to add into this JobDefinition

Returns:

this for fluent use

getSteps

public java.util.List<Step> getSteps()

Specified by:

getSteps in interface HasSteps

Specified by:

getSteps in interface JobDefinition

Returns:

the Step's defined for this JobDefinition