org.apache.fulcrum.osworkflow.example.modules.actions
Class WorkflowAction

java.lang.Object
  org.apache.turbine.modules.Assembler
      org.apache.turbine.modules.Action
          org.apache.turbine.modules.ActionEvent
              org.apache.turbine.util.velocity.VelocityActionEvent
                  org.apache.turbine.modules.actions.VelocityAction
                      org.apache.fulcrum.osworkflow.example.modules.actions.WorkflowAction

public class WorkflowAction

extends org.apache.turbine.modules.actions.VelocityAction

This action contains all the manipulations of a workflow. Look at the various doXXX methods to see what actions can be performed on workflows via this Action class.

Author:

Eric Pugh

Field Summary

Fields inherited from class org.apache.turbine.modules.ActionEvent

BUTTON, BUTTON_LENGTH, LENGTH, METHOD_NAME_LENGTH, METHOD_NAME_PREFIX

Constructor Summary

WorkflowAction()

Method Summary

void	doAction(org.apache.turbine.util.RunData data, org.apache.velocity.context.Context context) Perform an action for a workflow that moves it from one state to the next.
void	doLogin(org.apache.turbine.util.RunData data, org.apache.velocity.context.Context context) This logs you in as user "test".
void	doNew(org.apache.turbine.util.RunData data, org.apache.velocity.context.Context context) Create a new Workflow instance.
void	doPerform(org.apache.turbine.util.RunData data, org.apache.velocity.context.Context context) This guy deals with actions related to workflows.
void	doSetupuser(org.apache.turbine.util.RunData data, org.apache.velocity.context.Context context) This sets up the user "test/test" in OSWorkflow.
void	doViewdetail(org.apache.turbine.util.RunData data, org.apache.velocity.context.Context context) View the details of a specific workflow instance.
protected org.apache.fulcrum.osworkflow.WorkflowInstance	getWorkflowInstance(org.apache.turbine.util.RunData data, org.apache.velocity.context.Context context) Look up a workflow by the parameter "id".

Methods inherited from class org.apache.turbine.modules.actions.VelocityAction

doPerform, getContext, perform, setTemplate

Methods inherited from class org.apache.turbine.util.velocity.VelocityActionEvent

executeEvents

Methods inherited from class org.apache.turbine.modules.ActionEvent

considerKey, executeEvents, formatString

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowAction

public WorkflowAction()

Method Detail

doPerform

public void doPerform(org.apache.turbine.util.RunData data,
                      org.apache.velocity.context.Context context)
               throws java.lang.Exception

This guy deals with actions related to workflows.

Parameters:

data - Current RunData information

context - Context to populate

Throws:

java.lang.Exception - Thrown on error

doLogin

public void doLogin(org.apache.turbine.util.RunData data,
                    org.apache.velocity.context.Context context)
             throws java.lang.Exception

This logs you in as user "test". This is required because the example workflow can only be executed by user "test"

Parameters:

data - Current RunData information

context - Context to populate

Throws:

java.lang.Exception - Thrown on error

doSetupuser

public void doSetupuser(org.apache.turbine.util.RunData data,
                        org.apache.velocity.context.Context context)
                 throws java.lang.Exception

This sets up the user "test/test" in OSWorkflow. This is required because the example workflow only allows user test to create it! Also, it makes decisions based on the user test being in groups "foo","bars", and "bazs".

Parameters:

data - Current RunData information

context - Context to populate

Throws:

java.lang.Exception - Thrown on error

doNew

public void doNew(org.apache.turbine.util.RunData data,
                  org.apache.velocity.context.Context context)
           throws java.lang.Exception

Create a new Workflow instance.

Parameters:

data - Current RunData information

context - Context to populate

Throws:

java.lang.Exception - Thrown on error

doViewdetail

public void doViewdetail(org.apache.turbine.util.RunData data,
                         org.apache.velocity.context.Context context)
                  throws java.lang.Exception

View the details of a specific workflow instance.

Parameters:

data - Current RunData information

context - Context to populate

Throws:

java.lang.Exception - Thrown on error

doAction

public void doAction(org.apache.turbine.util.RunData data,
                     org.apache.velocity.context.Context context)
              throws java.lang.Exception

Perform an action for a workflow that moves it from one state to the next.

Parameters:

data - Current RunData information

context - Context to populate

Throws:

java.lang.Exception - Thrown on error

getWorkflowInstance

protected org.apache.fulcrum.osworkflow.WorkflowInstance getWorkflowInstance(org.apache.turbine.util.RunData data,
                                                                             org.apache.velocity.context.Context context)

Look up a workflow by the parameter "id". Creates a workflow instance object to facilitate looking things up.

Parameters:

data - Current RunData information

context - Context to populate

Returns:

a populated workflow instance