java.lang.Object
- org.apache.hop.core.variables.Variables
- - org.apache.hop.workflow.Workflow

All Implemented Interfaces:

IExecutor, IExtensionData, IHasLogChannel, ILoggingObject, INamedParameterDefinitions, INamedParameters, IVariables, IWorkflowEngine<WorkflowMeta>

Direct Known Subclasses:

LocalWorkflowEngine
```
public abstract class Workflow
extends Variables
implements IVariables, INamedParameters, IHasLogChannel, ILoggingObject, IExecutor, IExtensionData, IWorkflowEngine<WorkflowMeta>
```
This class executes a workflow as defined by a WorkflowMeta object.
The definition of a Hop workflow is represented by a WorkflowMeta object. It is typically loaded from a .hwf file, or it is generated dynamically. The declared parameters of the workflow definition are then queried using listParameters() and assigned values using calls to setParameterValue(..).

Field Summary

Fields
Modifier and Type	Field	Description
`protected List<IActionListener>`	`actionListeners`
`protected LinkedList<ActionResult>`	`actionResults`	A flat list of results in THIS workflow, in the order of execution of actions
`protected Set<ActionMeta>`	`activeActions`
`static String`	`CONFIGURATION_IN_EXPORT_FILENAME`
`protected String`	`containerObjectId`
`protected AtomicInteger`	`errors`
`protected String`	`executingServer`
`protected String`	`executingUser`
`protected Date`	`executionEndDate`
`protected Date`	`executionStartDate`
`protected Map<String,Object>`	`extensionDataMap`
`protected boolean`	`interactive`
`protected ILogChannel`	`log`
`protected LogLevel`	`logLevel`
`protected int`	`maxActionsLogged`
`protected IHopMetadataProvider`	`metadataProvider`
`protected INamedParameters`	`namedParams`	Parameters of the workflow.
`protected ILoggingObject`	`parentLoggingObject`	The parent logging interface to reference
`protected IPipelineEngine`	`parentPipeline`	The parent pipeline
`protected IWorkflowEngine<WorkflowMeta>`	`parentWorkflow`	The workflow that's launching this (sub-) workflow.
`protected static Class<?>`	`PKG`
`protected Result`	`result`	The result of the workflow, after execution.
`protected List<RowMetaAndData>`	`sourceRows`	The rows that were passed onto this workflow by a previous pipeline.
`protected ActionMeta`	`startActionMeta`
`protected Result`	`startActionResult`
`protected AtomicInteger`	`status`	Int value for storage workflow statuses
`protected List<IExecutionFinishedListener<IWorkflowEngine<WorkflowMeta>>>`	`workflowFinishedListeners`
`protected WorkflowMeta`	`workflowMeta`
`protected WorkflowRunConfiguration`	`workflowRunConfiguration`
`protected List<IExecutionStartedListener<IWorkflowEngine<WorkflowMeta>>>`	`workflowStartedListeners`
`protected WorkflowTracker`	`workflowTracker`	Keep a list of the actions that were executed.

Constructor Summary

Constructors
Constructor Description

Workflow()

Workflow(WorkflowMeta workflowMeta)

Workflow(WorkflowMeta workflowMeta, ILoggingObject parentLogging)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`activateParameters(IVariables variables)`
`void`	`addActionListener(IActionListener actionListener)`
`void`	`addErrors(int nrToAdd)`	Add a number of errors to the total number of erros that occured during execution.
`void`	`addParameterDefinition(String key, String defValue, String description)`
`void`	`addWorkflowFinishedListener(IExecutionFinishedListener<IWorkflowEngine<WorkflowMeta>> finishedListener)`
`void`	`addWorkflowStartedListener(IExecutionStartedListener<IWorkflowEngine<WorkflowMeta>> finishedListener)`
`boolean`	`beginProcessing()`	Handle logging at start
`void`	`clearParameterValues()`
`void`	`copyParametersFromDefinitions(INamedParameterDefinitions definitions)`
`Result`	`executeFromStart(int nr, Result result)`	Execute a workflow with previous results passed in. Execute called by ActionWorkflow: don't clear the actionResults.
`void`	`fireWorkflowFinishListeners()`
`void`	`fireWorkflowStartedListeners()`
`List<IActionListener>`	`getActionListeners()`
`List<ActionResult>`	`getActionResults()`	Gets a flat list of results in THIS workflow, in the order of execution of actions.
`Set<ActionMeta>`	`getActiveActions()`	Gets the activeJobEntryPipelines.
`String`	`getContainerId()`	Gets the serverObjectId.
`int`	`getErrors()`	Get the number of errors that happened in the workflow.
`String`	`getExecutingServer()`	Gets the executing server.
`String`	`getExecutingUser()`	Gets the executing user.
`Date`	`getExecutionEndDate()`	Gets executionEndDate
`Date`	`getExecutionStartDate()`	Gets executionStartDate
`Map<String,Object>`	`getExtensionDataMap()`
`String`	`getFilename()`	Gets the file name.
`ILogChannel`	`getLogChannel()`	Gets the log channel interface.
`String`	`getLogChannelId()`	Gets the log channel id.
`LogLevel`	`getLogLevel()`	Gets the logLevel.
`IHopMetadataProvider`	`getMetadataProvider()`	Gets metadataProvider
`String`	`getObjectCopy()`	Always returns null for Workflow.
`String`	`getObjectName()`	Gets the workflow name.
`LoggingObjectType`	`getObjectType()`	Gets LoggingObjectType.JOB, which is always the value for Workflow.
`String`	`getParameterDefault(String key)`
`String`	`getParameterDescription(String key)`
`String`	`getParameterValue(String key)`
`ILoggingObject`	`getParent()`	Gets parent logging object.
`ILoggingObject`	`getParentLoggingObject()`	Gets the parent logging object.
`IPipelineEngine`	`getParentPipeline()`
`IVariables`	`getParentVariables()`
`IWorkflowEngine<WorkflowMeta>`	`getParentWorkflow()`	Gets the parent workflow.
`Date`	`getRegistrationDate()`	Gets the registration date.
`Result`	`getResult()`
`List<RowMetaAndData>`	`getSourceRows()`	Gets sourceRows
`ActionMeta`	`getStartActionMeta()`	Gets the start action meta.
`Result`	`getStartActionResult()`
`String`	`getStatusDescription()`
`List<IExecutionFinishedListener<IWorkflowEngine<WorkflowMeta>>>`	`getWorkflowFinishedListeners()`	Gets workflowFinishedListeners
`WorkflowMeta`	`getWorkflowMeta()`
`String`	`getWorkflowName()`
`WorkflowRunConfiguration`	`getWorkflowRunConfiguration()`	Gets workflowRunConfiguration
`List<IExecutionStartedListener<IWorkflowEngine<WorkflowMeta>>>`	`getWorkflowStartedListeners()`	Gets workflowStartedListeners
`WorkflowTracker`	`getWorkflowTracker()`
`boolean`	`isActive()`
`boolean`	`isFinished()`
`boolean`	`isForcingSeparateLogging()`
`boolean`	`isGatheringMetrics()`
`boolean`	`isInitialized()`
`boolean`	`isInteractive()`	Gets the boolean value of interactive.
`boolean`	`isStopped()`
`String[]`	`listParameters()`
`void`	`removeActionListener(IActionListener actionListener)`
`void`	`removeAllParameters()`
`void`	`resetErrors()`	Set the number of occured errors to 0.
`protected void`	`setActive(boolean active)`
`void`	`setContainerId(String containerId)`	Sets the execution container object id (containerObjectId).
`void`	`setExecutingServer(String executingServer)`	Sets the executing server.
`void`	`setExecutingUser(String executingUser)`	Sets the executing user.
`void`	`setExecutionEndDate(Date executionEndDate)`
`void`	`setExecutionStartDate(Date executionStartDate)`
`void`	`setFinished(boolean finished)`
`void`	`setForcingSeparateLogging(boolean forcingSeparateLogging)`
`void`	`setGatheringMetrics(boolean gatheringMetrics)`
`protected void`	`setInitialized(boolean initialized)`
`void`	`setInteractive(boolean interactive)`	Sets the value of interactive.
`void`	`setInternalHopVariables()`
`static void`	`setInternalHopVariables(IVariables variables, String filename, String name)`	Sets the internal hop variables.
`void`	`setLogLevel(LogLevel logLevel)`	Sets the log level.
`void`	`setMetadataProvider(IHopMetadataProvider metadataProvider)`
`void`	`setParameterValue(String key, String value)`
`void`	`setParentLoggingObject(ILoggingObject parentLoggingObject)`
`void`	`setParentPipeline(IPipelineEngine parentPipeline)`
`void`	`setParentWorkflow(IWorkflowEngine<WorkflowMeta> parentWorkflow)`	Sets the parent workflow.
`void`	`setResult(Result result)`
`void`	`setSourceRows(List<RowMetaAndData> sourceRows)`
`void`	`setStartActionMeta(ActionMeta actionMeta)`	Sets the start action meta.
`void`	`setStartActionResult(Result startActionResult)`
`void`	`setStopped(boolean stopped)`	Sets the stopped.
`void`	`setWorkflowFinishedListeners(List<IExecutionFinishedListener<IWorkflowEngine<WorkflowMeta>>> workflowFinishedListeners)`
`void`	`setWorkflowMeta(WorkflowMeta workflowMeta)`
`void`	`setWorkflowRunConfiguration(WorkflowRunConfiguration workflowRunConfiguration)`
`void`	`setWorkflowStartedListeners(List<IExecutionStartedListener<IWorkflowEngine<WorkflowMeta>>> workflowStartedListeners)`
`void`	`setWorkflowTracker(WorkflowTracker workflowTracker)`
`Result`	`startExecution()`
`void`	`stopExecution()`	Stop all activity by setting the stopped property to true.
`String`	`toString()`	Gets the name property of the WorkflowMeta property.

Methods inherited from class org.apache.hop.core.variables.Variables
copyFrom, getADefaultVariableSpace, getVariable, getVariable, getVariableBoolean, getVariableNames, initializeFrom, resolve, resolve, resolve, setParentVariables, setVariable, setVariables, shareWith

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.hop.core.variables.IVariables
copyFrom, getVariable, getVariable, getVariableBoolean, getVariableNames, initializeFrom, resolve, resolve, resolve, setParentVariables, setVariable, setVariables, shareWith

Methods inherited from interface org.apache.hop.workflow.engine.IWorkflowEngine
createDefaultWorkflowEngineRunConfiguration

- Field Detail
  - PKG
```
protected static Class<?> PKG
```
  - CONFIGURATION_IN_EXPORT_FILENAME
```
public static final String CONFIGURATION_IN_EXPORT_FILENAME
```
    See Also:
    
    Constant Field Values
  - log
```
protected ILogChannel log
```
  - workflowRunConfiguration
```
protected WorkflowRunConfiguration workflowRunConfiguration
```
  - logLevel
```
protected LogLevel logLevel
```
  - containerObjectId
```
protected String containerObjectId
```
  - workflowMeta
```
protected WorkflowMeta workflowMeta
```
  - errors
```
protected AtomicInteger errors
```
  - parentWorkflow
```
protected IWorkflowEngine<WorkflowMeta> parentWorkflow
```
    The workflow that's launching this (sub-) workflow. This gives us access to the whole chain, including the parent variables, etc.
  - parentPipeline
```
protected IPipelineEngine parentPipeline
```
    The parent pipeline
  - parentLoggingObject
```
protected ILoggingObject parentLoggingObject
```
    The parent logging interface to reference
  - workflowTracker
```
protected WorkflowTracker workflowTracker
```
    Keep a list of the actions that were executed. org.apache.hop.core.logging.CentralLogStore.getInstance()
  - actionResults
```
protected final LinkedList<ActionResult> actionResults
```
    A flat list of results in THIS workflow, in the order of execution of actions
  - executionStartDate
```
protected Date executionStartDate
```
  - executionEndDate
```
protected Date executionEndDate
```
  - sourceRows
```
protected List<RowMetaAndData> sourceRows
```
    The rows that were passed onto this workflow by a previous pipeline. These rows are passed onto the first workflow entry in this workflow (on the result object)
  - result
```
protected Result result
```
    The result of the workflow, after execution.
  - interactive
```
protected boolean interactive
```
  - workflowFinishedListeners
```
protected List<IExecutionFinishedListener<IWorkflowEngine<WorkflowMeta>>> workflowFinishedListeners
```
  - workflowStartedListeners
```
protected List<IExecutionStartedListener<IWorkflowEngine<WorkflowMeta>>> workflowStartedListeners
```
  - actionListeners
```
protected List<IActionListener> actionListeners
```
  - activeActions
```
protected Set<ActionMeta> activeActions
```
  - namedParams
```
protected INamedParameters namedParams
```
    Parameters of the workflow.
  - maxActionsLogged
```
protected int maxActionsLogged
```
  - startActionMeta
```
protected ActionMeta startActionMeta
```
  - startActionResult
```
protected Result startActionResult
```
  - executingServer
```
protected String executingServer
```
  - executingUser
```
protected String executingUser
```
  - extensionDataMap
```
protected Map<String,Object> extensionDataMap
```
  - status
```
protected AtomicInteger status
```
    Int value for storage workflow statuses
  - metadataProvider
```
protected IHopMetadataProvider metadataProvider
```
- Constructor Detail
  - Workflow
```
public Workflow(WorkflowMeta workflowMeta)
```
  - Workflow
```
public Workflow(WorkflowMeta workflowMeta,
                ILoggingObject parentLogging)
```
  - Workflow
```
public Workflow()
```
- Method Detail
  - toString
```
public String toString()
```
    Gets the name property of the WorkflowMeta property.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String name for the WorkflowMeta
  - getWorkflowName
```
public String getWorkflowName()
```
    Specified by:
    
    getWorkflowName in interface IWorkflowEngine<WorkflowMeta>
  - startExecution
```
public Result startExecution()
```
    Specified by:
    
    startExecution in interface IWorkflowEngine<WorkflowMeta>
  - executeFromStart
```
public Result executeFromStart(int nr,
                               Result result)
                        throws HopException
```
    Execute a workflow with previous results passed in.
    
    Execute called by ActionWorkflow: don't clear the actionResults.
    
    Parameters:
    
    nr - The action number
    
    result - the result of the previous execution
    
    Returns:
    
    Result of the workflow execution
    
    Throws:
    
    HopWorkflowException
    
    HopException
  - addWorkflowFinishedListener
```
public void addWorkflowFinishedListener(IExecutionFinishedListener<IWorkflowEngine<WorkflowMeta>> finishedListener)
```
    Specified by:
    
    addWorkflowFinishedListener in interface IWorkflowEngine<WorkflowMeta>
  - fireWorkflowFinishListeners
```
public void fireWorkflowFinishListeners()
                                 throws HopException
```
    Specified by:
    
    fireWorkflowFinishListeners in interface IWorkflowEngine<WorkflowMeta>
    
    Throws:
    
    HopException
  - addWorkflowStartedListener
```
public void addWorkflowStartedListener(IExecutionStartedListener<IWorkflowEngine<WorkflowMeta>> finishedListener)
```
    Specified by:
    
    addWorkflowStartedListener in interface IWorkflowEngine<WorkflowMeta>
  - fireWorkflowStartedListeners
```
public void fireWorkflowStartedListeners()
                                  throws HopException
```
    Specified by:
    
    fireWorkflowStartedListeners in interface IWorkflowEngine<WorkflowMeta>
    
    Throws:
    
    HopException
  - getErrors
```
public int getErrors()
```
    Get the number of errors that happened in the workflow.
    
    Returns:
    
    nr of error that have occurred during execution. During execution of a workflow the number can change.
  - resetErrors
```
public void resetErrors()
```
    Set the number of occured errors to 0.
  - addErrors
```
public void addErrors(int nrToAdd)
```
    Add a number of errors to the total number of erros that occured during execution.
    
    Parameters:
    
    nrToAdd - nr of errors to add.
  - beginProcessing
```
public boolean beginProcessing()
                        throws HopException
```
    Handle logging at start
    
    Returns:
    
    true if it went OK.
    
    Throws:
    
    HopException
  - isInitialized
```
public boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface IWorkflowEngine<WorkflowMeta>
  - setInitialized
```
protected void setInitialized(boolean initialized)
```
  - isActive
```
public boolean isActive()
```
    Specified by:
    
    isActive in interface IWorkflowEngine<WorkflowMeta>
  - setActive
```
protected void setActive(boolean active)
```
  - isStopped
```
public boolean isStopped()
```
    Specified by:
    
    isStopped in interface IWorkflowEngine<WorkflowMeta>
  - stopExecution
```
public void stopExecution()
```
    Stop all activity by setting the stopped property to true.
    
    Specified by:
    
    stopExecution in interface IWorkflowEngine<WorkflowMeta>
  - setStopped
```
public void setStopped(boolean stopped)
```
    Sets the stopped.
    
    Specified by:
    
    setStopped in interface IWorkflowEngine<WorkflowMeta>
  - isFinished
```
public boolean isFinished()
```
    Specified by:
    
    isFinished in interface IWorkflowEngine<WorkflowMeta>
  - setFinished
```
public void setFinished(boolean finished)
```
    Specified by:
    
    setFinished in interface IWorkflowEngine<WorkflowMeta>
  - getWorkflowMeta
```
public WorkflowMeta getWorkflowMeta()
```
    Specified by:
    
    getWorkflowMeta in interface IWorkflowEngine<WorkflowMeta>
  - setWorkflowMeta
```
public void setWorkflowMeta(WorkflowMeta workflowMeta)
```
    Specified by:
    
    setWorkflowMeta in interface IWorkflowEngine<WorkflowMeta>
    
    Parameters:
    
    workflowMeta - The workflowMeta to set
  - getWorkflowTracker
```
public WorkflowTracker getWorkflowTracker()
```
    Specified by:
    
    getWorkflowTracker in interface IWorkflowEngine<WorkflowMeta>
  - setWorkflowTracker
```
public void setWorkflowTracker(WorkflowTracker workflowTracker)
```
  - getSourceRows
```
public List<RowMetaAndData> getSourceRows()
```
    Gets sourceRows
    
    Returns:
    
    value of sourceRows
  - setSourceRows
```
public void setSourceRows(List<RowMetaAndData> sourceRows)
```
    Specified by:
    
    setSourceRows in interface IWorkflowEngine<WorkflowMeta>
    
    Parameters:
    
    sourceRows - The sourceRows to set
  - getParentWorkflow
```
public IWorkflowEngine<WorkflowMeta> getParentWorkflow()
```
    Gets the parent workflow.
    
    Specified by:
    
    getParentWorkflow in interface IWorkflowEngine<WorkflowMeta>
    
    Returns:
    
    Returns the parentWorkflow
  - setParentWorkflow
```
public void setParentWorkflow(IWorkflowEngine<WorkflowMeta> parentWorkflow)
```
    Sets the parent workflow.
    
    Specified by:
    
    setParentWorkflow in interface IWorkflowEngine<WorkflowMeta>
    
    Parameters:
    
    parentWorkflow - The parentWorkflow to set.
  - getParentVariables
```
public IVariables getParentVariables()
```
    Specified by:
    
    getParentVariables in interface IVariables
    
    Overrides:
    
    getParentVariables in class Variables
  - getResult
```
public Result getResult()
```
    Specified by:
    
    getResult in interface IWorkflowEngine<WorkflowMeta>
  - setResult
```
public void setResult(Result result)
```
    Specified by:
    
    setResult in interface IWorkflowEngine<WorkflowMeta>
  - setInternalHopVariables
```
public void setInternalHopVariables()
```
    Specified by:
    
    setInternalHopVariables in interface IWorkflowEngine<WorkflowMeta>
  - setInternalHopVariables
```
public static final void setInternalHopVariables(IVariables variables,
                                                 String filename,
                                                 String name)
```
    Sets the internal hop variables.
    
    Parameters:
    
    variables - the variables in which we want to set the internal variables
    
    filename - the filename if there is any
    
    name - the name of the workflow
  - getStatusDescription
```
public String getStatusDescription()
```
    Specified by:
    
    getStatusDescription in interface IWorkflowEngine<WorkflowMeta>
  - addActionListener
```
public void addActionListener(IActionListener actionListener)
```
    Specified by:
    
    addActionListener in interface IWorkflowEngine<WorkflowMeta>
  - removeActionListener
```
public void removeActionListener(IActionListener actionListener)
```
  - getActionListeners
```
public List<IActionListener> getActionListeners()
```
    Specified by:
    
    getActionListeners in interface IWorkflowEngine<WorkflowMeta>
  - addParameterDefinition
```
public void addParameterDefinition(String key,
                                   String defValue,
                                   String description)
                            throws DuplicateParamException
```
    Specified by:
    
    addParameterDefinition in interface INamedParameterDefinitions
    
    Throws:
    
    DuplicateParamException
  - getParameterDescription
```
public String getParameterDescription(String key)
                               throws UnknownParamException
```
    Specified by:
    
    getParameterDescription in interface INamedParameterDefinitions
    
    Throws:
    
    UnknownParamException
  - getParameterDefault
```
public String getParameterDefault(String key)
                           throws UnknownParamException
```
    Specified by:
    
    getParameterDefault in interface INamedParameterDefinitions
    
    Throws:
    
    UnknownParamException
  - getParameterValue
```
public String getParameterValue(String key)
                         throws UnknownParamException
```
    Specified by:
    
    getParameterValue in interface INamedParameters
    
    Throws:
    
    UnknownParamException
  - listParameters
```
public String[] listParameters()
```
    Specified by:
    
    listParameters in interface INamedParameterDefinitions
  - setParameterValue
```
public void setParameterValue(String key,
                              String value)
                       throws UnknownParamException
```
    Specified by:
    
    setParameterValue in interface INamedParameters
    
    Throws:
    
    UnknownParamException
  - removeAllParameters
```
public void removeAllParameters()
```
    Specified by:
    
    removeAllParameters in interface INamedParameterDefinitions
    
    Specified by:
    
    removeAllParameters in interface INamedParameters
  - clearParameterValues
```
public void clearParameterValues()
```
    Specified by:
    
    clearParameterValues in interface INamedParameters
  - activateParameters
```
public void activateParameters(IVariables variables)
```
    Specified by:
    
    activateParameters in interface INamedParameters
  - copyParametersFromDefinitions
```
public void copyParametersFromDefinitions(INamedParameterDefinitions definitions)
```
    Specified by:
    
    copyParametersFromDefinitions in interface INamedParameters
  - getLogChannel
```
public ILogChannel getLogChannel()
```
    Gets the log channel interface.
    
    Specified by:
    
    getLogChannel in interface IHasLogChannel
    
    Specified by:
    
    getLogChannel in interface IWorkflowEngine<WorkflowMeta>
    
    Returns:
    
    ILogChannel
  - getObjectName
```
public String getObjectName()
```
    Gets the workflow name.
    
    Specified by:
    
    getObjectName in interface ILoggingObject
    
    Returns:
    
    workflowName
  - getObjectCopy
```
public String getObjectCopy()
```
    Always returns null for Workflow.
    
    Specified by:
    
    getObjectCopy in interface ILoggingObject
    
    Returns:
    
    null
  - getFilename
```
public String getFilename()
```
    Gets the file name.
    
    Specified by:
    
    getFilename in interface ILoggingObject
    
    Returns:
    
    the filename
  - getLogChannelId
```
public String getLogChannelId()
```
    Gets the log channel id.
    
    Specified by:
    
    getLogChannelId in interface ILoggingObject
    
    Returns:
    
    the logChannelId
  - getObjectType
```
public LoggingObjectType getObjectType()
```
    Gets LoggingObjectType.JOB, which is always the value for Workflow.
    
    Specified by:
    
    getObjectType in interface ILoggingObject
    
    Returns:
    
    LoggingObjectType LoggingObjectType.JOB
  - getParent
```
public ILoggingObject getParent()
```
    Gets parent logging object.
    
    Specified by:
    
    getParent in interface ILoggingObject
    
    Returns:
    
    parentLoggingObject
  - getLogLevel
```
public LogLevel getLogLevel()
```
    Gets the logLevel.
    
    Specified by:
    
    getLogLevel in interface ILoggingObject
    
    Returns:
    
    logLevel
  - setLogLevel
```
public void setLogLevel(LogLevel logLevel)
```
    Sets the log level.
    
    Specified by:
    
    setLogLevel in interface IWorkflowEngine<WorkflowMeta>
    
    Parameters:
    
    logLevel - the new log level
  - isInteractive
```
public boolean isInteractive()
```
    Gets the boolean value of interactive.
    
    Specified by:
    
    isInteractive in interface IWorkflowEngine<WorkflowMeta>
    
    Returns:
    
    the interactive
  - setInteractive
```
public void setInteractive(boolean interactive)
```
    Sets the value of interactive.
    
    Specified by:
    
    setInteractive in interface IWorkflowEngine<WorkflowMeta>
    
    Parameters:
    
    interactive - the interactive to set
  - getActiveActions
```
public Set<ActionMeta> getActiveActions()
```
    Gets the activeJobEntryPipelines.
    
    Specified by:
    
    getActiveActions in interface IWorkflowEngine<WorkflowMeta>
    
    Returns:
    
    the activeJobEntryPipelines
  - getActionResults
```
public List<ActionResult> getActionResults()
```
    Gets a flat list of results in THIS workflow, in the order of execution of actions.
    
    Specified by:
    
    getActionResults in interface IWorkflowEngine<WorkflowMeta>
    
    Returns:
    
    A flat list of results in THIS workflow, in the order of execution of actions
  - getContainerId
```
public String getContainerId()
```
    Gets the serverObjectId.
    
    Specified by:
    
    getContainerId in interface ILoggingObject
    
    Specified by:
    
    getContainerId in interface IWorkflowEngine<WorkflowMeta>
    
    Returns:
    
    the serverObjectId
  - setContainerId
```
public void setContainerId(String containerId)
```
    Sets the execution container object id (containerObjectId).
    
    Specified by:
    
    setContainerId in interface IWorkflowEngine<WorkflowMeta>
    
    Parameters:
    
    containerId - the execution container object id to set
  - getParentLoggingObject
```
public ILoggingObject getParentLoggingObject()
```
    Gets the parent logging object.
    
    Returns:
    
    the parent logging object
  - setParentLoggingObject
```
public void setParentLoggingObject(ILoggingObject parentLoggingObject)
```
    Parameters:
    
    parentLoggingObject - The parentLoggingObject to set
  - getRegistrationDate
```
public Date getRegistrationDate()
```
    Gets the registration date. For workflow, this always returns null
    
    Specified by:
    
    getRegistrationDate in interface ILoggingObject
    
    Returns:
    
    null
  - getStartActionMeta
```
public ActionMeta getStartActionMeta()
```
    Gets the start action meta.
    
    Returns:
    
    the startActionMeta
  - setStartActionMeta
```
public void setStartActionMeta(ActionMeta actionMeta)
```
    Sets the start action meta.
    
    Specified by:
    
    setStartActionMeta in interface IWorkflowEngine<WorkflowMeta>
    
    Parameters:
    
    actionMeta - the startActionMeta to set
  - getExecutingServer
```
public String getExecutingServer()
```
    Gets the executing server.
    
    Specified by:
    
    getExecutingServer in interface IExecutor
    
    Returns:
    
    the executingServer
  - setExecutingServer
```
public void setExecutingServer(String executingServer)
```
    Sets the executing server.
    
    Specified by:
    
    setExecutingServer in interface IExecutor
    
    Parameters:
    
    executingServer - the executingServer to set
  - getExecutingUser
```
public String getExecutingUser()
```
    Gets the executing user.
    
    Specified by:
    
    getExecutingUser in interface IExecutor
    
    Returns:
    
    the executingUser
  - setExecutingUser
```
public void setExecutingUser(String executingUser)
```
    Sets the executing user.
    
    Specified by:
    
    setExecutingUser in interface IExecutor
    
    Parameters:
    
    executingUser - the executingUser to set
  - isGatheringMetrics
```
public boolean isGatheringMetrics()
```
    Specified by:
    
    isGatheringMetrics in interface ILoggingObject
  - setGatheringMetrics
```
public void setGatheringMetrics(boolean gatheringMetrics)
```
    Specified by:
    
    setGatheringMetrics in interface ILoggingObject
  - isForcingSeparateLogging
```
public boolean isForcingSeparateLogging()
```
    Specified by:
    
    isForcingSeparateLogging in interface ILoggingObject
  - setForcingSeparateLogging
```
public void setForcingSeparateLogging(boolean forcingSeparateLogging)
```
    Specified by:
    
    setForcingSeparateLogging in interface ILoggingObject
  - getParentPipeline
```
public IPipelineEngine getParentPipeline()
```
    Specified by:
    
    getParentPipeline in interface IWorkflowEngine<WorkflowMeta>
  - setParentPipeline
```
public void setParentPipeline(IPipelineEngine parentPipeline)
```
    Specified by:
    
    setParentPipeline in interface IWorkflowEngine<WorkflowMeta>
  - getExtensionDataMap
```
public Map<String,Object> getExtensionDataMap()
```
    Specified by:
    
    getExtensionDataMap in interface IExtensionData
    
    Specified by:
    
    getExtensionDataMap in interface IWorkflowEngine<WorkflowMeta>
  - getStartActionResult
```
public Result getStartActionResult()
```
  - setStartActionResult
```
public void setStartActionResult(Result startActionResult)
```
  - getExecutionStartDate
```
public Date getExecutionStartDate()
```
    Gets executionStartDate
    
    Specified by:
    
    getExecutionStartDate in interface IWorkflowEngine<WorkflowMeta>
    
    Returns:
    
    value of executionStartDate
  - setExecutionStartDate
```
public void setExecutionStartDate(Date executionStartDate)
```
    Parameters:
    
    executionStartDate - The executionStartDate to set
  - getExecutionEndDate
```
public Date getExecutionEndDate()
```
    Gets executionEndDate
    
    Specified by:
    
    getExecutionEndDate in interface IWorkflowEngine<WorkflowMeta>
    
    Returns:
    
    value of executionEndDate
  - setExecutionEndDate
```
public void setExecutionEndDate(Date executionEndDate)
```
    Parameters:
    
    executionEndDate - The executionEndDate to set
  - getWorkflowFinishedListeners
```
public List<IExecutionFinishedListener<IWorkflowEngine<WorkflowMeta>>> getWorkflowFinishedListeners()
```
    Gets workflowFinishedListeners
    
    Specified by:
    
    getWorkflowFinishedListeners in interface IWorkflowEngine<WorkflowMeta>
    
    Returns:
    
    value of workflowFinishedListeners
  - setWorkflowFinishedListeners
```
public void setWorkflowFinishedListeners(List<IExecutionFinishedListener<IWorkflowEngine<WorkflowMeta>>> workflowFinishedListeners)
```
    Parameters:
    
    workflowFinishedListeners - The workflowFinishedListeners to set
  - getWorkflowStartedListeners
```
public List<IExecutionStartedListener<IWorkflowEngine<WorkflowMeta>>> getWorkflowStartedListeners()
```
    Gets workflowStartedListeners
    
    Specified by:
    
    getWorkflowStartedListeners in interface IWorkflowEngine<WorkflowMeta>
    
    Returns:
    
    value of workflowStartedListeners
  - setWorkflowStartedListeners
```
public void setWorkflowStartedListeners(List<IExecutionStartedListener<IWorkflowEngine<WorkflowMeta>>> workflowStartedListeners)
```
    Parameters:
    
    workflowStartedListeners - The workflowStartedListeners to set
  - getWorkflowRunConfiguration
```
public WorkflowRunConfiguration getWorkflowRunConfiguration()
```
    Gets workflowRunConfiguration
    
    Specified by:
    
    getWorkflowRunConfiguration in interface IWorkflowEngine<WorkflowMeta>
    
    Returns:
    
    value of workflowRunConfiguration
  - setWorkflowRunConfiguration
```
public void setWorkflowRunConfiguration(WorkflowRunConfiguration workflowRunConfiguration)
```
    Specified by:
    
    setWorkflowRunConfiguration in interface IWorkflowEngine<WorkflowMeta>
    
    Parameters:
    
    workflowRunConfiguration - The workflowRunConfiguration to set
  - getMetadataProvider
```
public IHopMetadataProvider getMetadataProvider()
```
    Gets metadataProvider
    
    Specified by:
    
    getMetadataProvider in interface IWorkflowEngine<WorkflowMeta>
    
    Returns:
    
    value of metadataProvider
  - setMetadataProvider
```
public void setMetadataProvider(IHopMetadataProvider metadataProvider)
```
    Specified by:
    
    setMetadataProvider in interface IWorkflowEngine<WorkflowMeta>
    
    Parameters:
    
    metadataProvider - The metadataProvider to set

Constructor	Description
`Workflow()`
`Workflow(WorkflowMeta workflowMeta)`
`Workflow(WorkflowMeta workflowMeta, ILoggingObject parentLogging)`

Class Workflow

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.apache.hop.core.variables.Variables

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.hop.core.variables.IVariables

Methods inherited from interface org.apache.hop.workflow.engine.IWorkflowEngine

Field Detail

PKG

CONFIGURATION_IN_EXPORT_FILENAME

log

workflowRunConfiguration

logLevel

containerObjectId

workflowMeta

errors

parentWorkflow

parentPipeline

parentLoggingObject

workflowTracker

actionResults

executionStartDate

executionEndDate

sourceRows

result

interactive

workflowFinishedListeners

workflowStartedListeners

actionListeners

activeActions

namedParams

maxActionsLogged

startActionMeta

startActionResult

executingServer

executingUser

extensionDataMap

status

metadataProvider

Constructor Detail

Workflow

Workflow

Workflow

Method Detail

toString

getWorkflowName

startExecution

executeFromStart

addWorkflowFinishedListener

fireWorkflowFinishListeners

addWorkflowStartedListener

fireWorkflowStartedListeners

getErrors

resetErrors

addErrors

beginProcessing

isInitialized

setInitialized

isActive

setActive

isStopped

stopExecution

setStopped

isFinished

setFinished

getWorkflowMeta

setWorkflowMeta

getWorkflowTracker

setWorkflowTracker

getSourceRows

setSourceRows

getParentWorkflow

setParentWorkflow

getParentVariables

getResult

setResult

setInternalHopVariables

setInternalHopVariables

getStatusDescription