org.apache.taverna.platform.run.api

Class RunProfile

java.lang.Object

org.apache.taverna.platform.run.api.RunProfile

public class RunProfile
extends Object

A RunProfile specifies the parameters required to run a Workflow.

Constructor Summary

Constructors

Constructor and Description
RunProfile(ExecutionEnvironment executionEnvironment, WorkflowBundle workflowBundle, Bundle dataBundle) Constructs a RunProfile that specifies the parameters required to run a Workflow.
RunProfile(ExecutionEnvironment executionEnvironment, WorkflowBundle workflowBundle, String workflowName, String profileName, Bundle dataBundle) Constructs a RunProfile that specifies the parameters required to run a Workflow.

Method Summary

Modifier and Type	Method and Description
Bundle	getDataBundle() Returns the Bundle containing the data values for the Workflow.
ExecutionEnvironment	getExecutionEnvironment() Returns the ExecutionEnvironment used to execute the Workflow.
String	getProfileName() Returns the name of the Profile to use when running the Workflow.
WorkflowBundle	getWorkflowBundle() Returns the WorkflowBundle.
String	getWorkflowName() Returns the name of the Workflow to run.
void	setDataBundle(Bundle dataBundle) Sets the Bundle containing the data values for the Workflow.
void	setExecutionEnvironment(ExecutionEnvironment executionEnvironment) Sets the ExecutionEnvironment used to execute the Workflow.
void	setProfileName(String profileName) Sets the name of the Profile to use when running the Workflow.
void	setWorkflowBundle(WorkflowBundle workflowBundle) Sets the WorkflowBundle containing the Workflow to run.
void	setWorkflowName(String workflowName) Sets the name of the Workflow to run.

Methods inherited from class java.lang.Object

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

Constructor Detail

RunProfile

public RunProfile(ExecutionEnvironment executionEnvironment,
                  WorkflowBundle workflowBundle,
                  Bundle dataBundle)

Constructs a RunProfile that specifies the parameters required to run a Workflow. The main Workflow and Profile from the WorkflowBundle are used.

Parameters:

executionEnvironment - the ExecutionEnvironment used to execute the Workflow

workflowBundle - the WorkflowBundle containing the Workflow to run

dataBundle - the Bundle containing the data values for the Workflow

RunProfile

public RunProfile(ExecutionEnvironment executionEnvironment,
                  WorkflowBundle workflowBundle,
                  String workflowName,
                  String profileName,
                  Bundle dataBundle)

Constructs a RunProfile that specifies the parameters required to run a Workflow.

Parameters:

executionEnvironment - the ExecutionEnvironment used to execute the Workflow

workflowBundle - the WorkflowBundle containing the Workflow to run

workflow - the Workflow to run. If null uses the main Workflow from the WorkflowBundle

profile - the Profile to use when running the Workflow. If null uses the main Profile from the WorkflowBundle

dataBundle - the Bundle containing the data values for the Workflow

Method Detail

getWorkflowBundle

public WorkflowBundle getWorkflowBundle()

Returns the WorkflowBundle.

Returns:

the WorkflowBundle

setWorkflowBundle

public void setWorkflowBundle(WorkflowBundle workflowBundle)

Sets the WorkflowBundle containing the Workflow to run.

Parameters:

workflowBundle - the WorkflowBundle containing the Workflow to run

getWorkflowName

public String getWorkflowName()

Returns the name of the Workflow to run. If no Workflow name is set the main Workflow from the WorkflowBundle will be run.

Returns:

the Workflow to run

setWorkflowName

public void setWorkflowName(String workflowName)

Sets the name of the Workflow to run. If no Workflow name is set the main Workflow from the WorkflowBundle will be run.

Parameters:

workflowName - the name of the Workflow to run

getProfileName

public String getProfileName()

Returns the name of the Profile to use when running the Workflow. If no Profile name is set the main Profile from the WorkflowBundle will be used.

Returns:

the Profile to use when running the Workflow

setProfileName

public void setProfileName(String profileName)

Sets the name of the Profile to use when running the Workflow.

If no Profile name is set the main Profile from the WorkflowBundle will be used.

Parameters:

profileName - the name of the Profile to use when running the Workflow

getDataBundle

public Bundle getDataBundle()

Returns the Bundle containing the data values for the Workflow.

Returns:

the Bundle containing the data values for the Workflow

setDataBundle

public void setDataBundle(Bundle dataBundle)

Sets the Bundle containing the data values for the Workflow.

Parameters:

dataBundle - the Bundle containing the data values for the Workflow

getExecutionEnvironment

public ExecutionEnvironment getExecutionEnvironment()

Returns the ExecutionEnvironment used to execute the Workflow.

Returns:

the ExecutionEnvironment used to execute the Workflow

setExecutionEnvironment

public void setExecutionEnvironment(ExecutionEnvironment executionEnvironment)

Sets the ExecutionEnvironment used to execute the Workflow.

Parameters:

executionEnvironment - the ExecutionEnvironment used to execute the Workflow