Package de.uplanet.lucy.server.workflow.action

Class VelocityWorkflowAction

java.lang.Object

de.uplanet.lucy.server.workflow.action.AbstractWorkflowAction

de.uplanet.lucy.server.workflow.action.VelocityWorkflowAction

All Implemented Interfaces:

IActivatableWorkflowObject, INamedWorkflowObject, INeedWorkflow, INeedWorkflowDirectory, IWorkflowAction, IWorkflowObject, Serializable

public final class VelocityWorkflowAction
extends AbstractWorkflowAction
implements INeedWorkflowDirectory

See Also:

• Serialized Form

Field Summary

Fields inherited from interface de.uplanet.lucy.server.workflow.IWorkflowObject

GUID_COMPARATOR

Constructor Summary

Constructors

Constructor	Description
VelocityWorkflowAction(String p_strGuid)

Method Summary

Modifier and Type	Method	Description
String	getOutputEncoding()	Get the output file encoding.
String	getOutputPath()	Get the path of the output file.
String	getSharedStateVariableName()	Get the shared state variable name.
String	getVelocityInputPath()	Get the path of the Velocity template.
Path	getWorkflowDirectory()	Get the workflow directory.
WorkflowTransition	process(IWorkflowEvent p_evt, de.uplanet.lucy.server.workflow.IWorkflowProcessingContext p_wfCtx, de.uplanet.lucy.server.IProcessingContext p_ctx)	Process a workflow event in the given context.
void	setOutputEncoding(String p_strOutputEncoding)	Set the output file encoding.
void	setOutputPath(String p_strOutputPath)	Set the path of the output file.
void	setSharedStateVariableName(String p_strSharedStateVariableName)	Set the shared state variable name.
void	setVelocityInputPath(String p_strVelocityInputPath)	Set the path of the Velocity template.
void	setWorkflowDirectory(Path p_dir)	Set the workflow directory.

Methods inherited from class de.uplanet.lucy.server.workflow.action.AbstractWorkflowAction

getAfferentTransition, getEfferentTransition, getGuid, getName, getWorkflow, isActive, setActive, setAfferentTransition, setEfferentTransition, setName, setWorkflow, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

VelocityWorkflowAction

public VelocityWorkflowAction(String p_strGuid)

Method Details

getWorkflowDirectory

public Path getWorkflowDirectory()

Description copied from interface: INeedWorkflowDirectory

Get the workflow directory.

Specified by:

getWorkflowDirectory in interface INeedWorkflowDirectory

Returns:

The workflow directory.

setWorkflowDirectory

public void setWorkflowDirectory(Path p_dir)

Description copied from interface: INeedWorkflowDirectory

Set the workflow directory.

Specified by:

setWorkflowDirectory in interface INeedWorkflowDirectory

Parameters:

p_dir - The workflow directory.

getVelocityInputPath

public String getVelocityInputPath()

Get the path of the Velocity template.

Returns:

The path of the Velocity template.

setVelocityInputPath

public void setVelocityInputPath(String p_strVelocityInputPath)

Set the path of the Velocity template.

Parameters:

p_strVelocityInputPath - The path of the Velocity template.

getOutputPath

public String getOutputPath()

Get the path of the output file.

Returns:

The path of the output file.

setOutputPath

public void setOutputPath(String p_strOutputPath)

Set the path of the output file.

Parameters:

p_strOutputPath - The path of the output file.

getOutputEncoding

public String getOutputEncoding()

Get the output file encoding.

Returns:

The path of the output file.

setOutputEncoding

public void setOutputEncoding(String p_strOutputEncoding)

Set the output file encoding.

Parameters:

p_strOutputEncoding - The output file encoding.

getSharedStateVariableName

public String getSharedStateVariableName()

Get the shared state variable name.

Returns:

The shared state variable name.

setSharedStateVariableName

public void setSharedStateVariableName(String p_strSharedStateVariableName)

Set the shared state variable name.

Parameters:

p_strSharedStateVariableName - The shared state variable name.

process

public WorkflowTransition process(IWorkflowEvent p_evt,
 de.uplanet.lucy.server.workflow.IWorkflowProcessingContext p_wfCtx,
 de.uplanet.lucy.server.IProcessingContext p_ctx)
                           throws Exception

Description copied from interface: IWorkflowAction

Process a workflow event in the given context.

Normally, a workflow action should return its efferent transition, regardless whether it is active, or not.

Specified by:

process in interface IWorkflowAction

Parameters:

p_evt - The event to be processed.

p_wfCtx - The workflow processing context.

p_ctx - The processing context.

Returns:

The efferent transition, or null.

Throws:

InterruptedException - If processing of this action has been interrupted.

Exception - If an error occurred.