org.openemcee.microflow.usercore
Interface MicroflowTask

All Known Implementing Classes:

CallSubflowTask

public interface MicroflowTask

The MicroflowTask is the caore interface controller plugins in the OpenEmcee microflow framework. For more information please see the openemcee tutorial on our project website.

Author:

Scott Schenkein

Field Summary

static java.lang.String

VCS_ID Version control tag.

Method Summary

MicroflowTaskOutcome	executeTask(MicroflowData data) This method is where the callouts to model components occurrs, as well as determination of "outcome".
boolean	init(MicroflowParameters params) This method is called once, and only once, prior to calling execute task.

Field Detail

VCS_ID

public static final java.lang.String VCS_ID

Version control tag.

See Also:

Constant Field Values

Method Detail

init

public boolean init(MicroflowParameters params)

This method is called once, and only once, prior to calling execute task. It provides access to the parameters specified in the task definition in the Microflow job defintion XML document. If the initialization fails, the executeTask will not be called, and the calling Microflow will fail.

Parameters:

params - A MicroflowParameters object which contains any parameters specified in the microflow XML.

Returns:

True on successful initialization, false on failure.

executeTask

public MicroflowTaskOutcome executeTask(MicroflowData data)

This method is where the callouts to model components occurrs, as well as determination of "outcome". The result of a given outcome is specified in the Microflow XML. Please see the quickstart tutorial on our homepage. Note that business logic should not live in the MicroflowTask. Rather, the business logic should be encapsulated in "model" classes which are called from the microflow task.

Parameters:

data - This parameter provides access to the data associated with the current Microflow.

Returns:

This method returns a MicroflowTask explaining the outcome, perhaps "success", "failure", "communication_error", etc...