info.magnolia.module.workflow.commands
Class FlowCommand

java.lang.Object
  info.magnolia.commands.MgnlCommand
      info.magnolia.module.workflow.commands.FlowCommand

All Implemented Interfaces:

org.apache.commons.chain.Command

Direct Known Subclasses:

PathMappedFlowCommand

public class FlowCommand
extends MgnlCommand

Base command class for starting workflows.

Field Summary

Fields inherited from interface org.apache.commons.chain.Command

CONTINUE_PROCESSING, PROCESSING_COMPLETE

Constructor Summary

FlowCommand()

Method Summary

boolean	execute(Context ctx)
java.lang.String	getDialogName()
java.lang.String	getWorkflowName()
void	prepareLaunchItem(Context context, openwfe.org.engine.workitem.LaunchItem launchItem) The default implementation puts all the contexts attributes which are in the request scope into the work item.
void	release() If a clone is passivated we call this method.
void	setDialogName(java.lang.String dialogName)
void	setWorkflowName(java.lang.String flowName)

Methods inherited from class info.magnolia.commands.MgnlCommand

execute, isClone, isEnabled, setClone, setEnabled

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowCommand

public FlowCommand()

Method Detail

execute

public boolean execute(Context ctx)
                throws FlowDefinitionException

Specified by:

execute in class MgnlCommand

Throws:

FlowDefinitionException

prepareLaunchItem

public void prepareLaunchItem(Context context,
                              openwfe.org.engine.workitem.LaunchItem launchItem)

The default implementation puts all the contexts attributes which are in the request scope into the work item.

Parameters:

context -

launchItem -

getWorkflowName

public java.lang.String getWorkflowName()

setWorkflowName

public void setWorkflowName(java.lang.String flowName)

getDialogName

public java.lang.String getDialogName()

setDialogName

public void setDialogName(java.lang.String dialogName)

release

public void release()

Description copied from class: MgnlCommand

If a clone is passivated we call this method. Please clean up private properties.

Overrides:

release in class MgnlCommand