WorkflowEngine (SeqWare 1.1.2 API)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Known Implementing Classes:

OozieWorkflowEngine, WhiteStarWorkflowEngine
```
public interface WorkflowEngine
```
WorkflowEngine interface.
This interface will eventually encompass all the methods that a workflow engine should have to implement including preparation of workflows and watching workflows. Currently, workflow status checker code still needs to be modified engine-by-engine.

Since:

1.1

Author:

yongliang

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getLookupToken()` An engine-specific token for this workflow run that can be used to lookup relevant runtime data.
`String`	`getWorkingDirectory()` The working directory for the prepared workflow run, or null if not yet prepared or if not applicable for the concrete engine.
`void`	`prepareWorkflow(AbstractWorkflowDataModel objectModel)` Prepare the workflow according to the info filled in the input objectModel.
`ReturnValue`	`runWorkflow()` Run the prepared workflow.
`ReturnValue`	`watchWorkflow(String jobToken)` Watch a workflow and return running information until it completes.

- Method Detail
  - prepareWorkflow
```
void prepareWorkflow(AbstractWorkflowDataModel objectModel)
```
    Prepare the workflow according to the info filled in the input objectModel.
    
    Parameters:
    objectModel - model of the workflow to prepare to run
  - runWorkflow
```
ReturnValue runWorkflow()
```
    Run the prepared workflow.
    
    Returns:
  - getLookupToken
```
String getLookupToken()
```
    An engine-specific token for this workflow run that can be used to lookup relevant runtime data.
    
    Returns:
    the token
  - getWorkingDirectory
```
String getWorkingDirectory()
```
    The working directory for the prepared workflow run, or null if not yet prepared or if not applicable for the concrete engine.
    
    Returns:
    the working directory, or null
  - watchWorkflow
```
ReturnValue watchWorkflow(String jobToken)
```
    Watch a workflow and return running information until it completes. The exact nature of the output is arbitrary and likely dependent on the workflow engine.
    
    Parameters:
    jobToken -
    
    Returns:

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2015 SeqWare. All rights reserved.