com.livinglogic.struts.workflow
Class WorkflowMapping

java.lang.Object
  org.apache.struts.config.ActionConfig
      org.apache.struts.action.ActionMapping
          com.livinglogic.struts.workflow.WorkflowMapping

All Implemented Interfaces:

Serializable

public class WorkflowMapping

extends org.apache.struts.action.ActionMapping

Implementation of enhanced ActionMapping. It defines the following custom properties:

• primaryWorkflow - The label of the workflow this action mapping belongs to.
• secondaryWorkflow - The label of a further workflow this action can depend on.
• prevState - The label of a state which may precede in the given workflow. This property can be set multiple times to allow multiple valid prevStates for a workflow.
• newState - The label of the state this action leads to in the given workflow. If not specified for a workflow the state is not changed upon action execution.
• nextState - The label of a state which may follow in the given workflow. This property can be set multiple times to allow multiple valid nextStates for an action.
• endWorkflow - If "true" (case insensitive string), the given workflow ends with this action. If this property is not given, it defaults to false.
• noWorkflowChecks - If "true" (case insensitive string), this action is ignored in terms of workflow checks, i. e. this action can be executed even if a currently active workflow defines a certain nextState condition, this action does not lead to. If this property is set, no other workflow properties are allowed to be set. It defaults to false.
• authClass - The name of the authentication class which checks if the user is allowed to execute the action.

Since:

$Name: $

Version:

$Revision: 1.3 $, $Date: 2004/04/08 14:58:23 $

Author:

M. Bauer, A. Lamm, $Author: jason_pratt $

See Also:

Serialized Form

Nested Class Summary

static class

WorkflowMapping.WorkflowData Class that holds mapping data for a labeled workflow

Field Summary

Fields inherited from class org.apache.struts.config.ActionConfig

attribute, configured, exceptions, forward, forwards, include, input, moduleConfig, multipartClass, name, parameter, path, prefix, roleNames, roles, scope, suffix, type, unknown, validate

Constructor Summary

WorkflowMapping()
Constructor

Method Summary

protected void	addWorkflow(String workflow) Register the label of a further workflow for this mapping.
String	getAuthClass() Return authClass for this mapping.
String	getPrimaryWorkflow() Returns the label of the workflow this mapping belongs to.
Collection	getWorkflows() Returns the labels of all workflows for this mapping.
boolean	hasNoWorkflowChecksSet() Return the noWorkflowChecks value for this mapping.
void	setAuthClass(String authClass) Set authClass for this mapping.
void	setEndWorkflow(String endWorkflow) Set the endWorkflow property for the latest registered workflow of this mapping.
void	setNewState(String newState) Set a newState for the latest registered workflow of this mapping, if not yet set.
void	setNextState(String nextState) Set a nextState for the latest registered workflow of this mapping.
void	setNoWorkflowChecks(String value) Set noWorkflowChecks value for this mapping.
void	setPrevState(String prevState) Set a prevState for the latest registered workflow of this mapping.
void	setPrimaryWorkflow(String primaryWorkflow) Register the label of the workflow this mapping belongs to.
void	setSecondaryWorkflow(String secondaryWorkflow) Register the label of a further workflow for this mapping.

Methods inherited from class org.apache.struts.action.ActionMapping

findException, findForward, findForwards, getInputForward

Methods inherited from class org.apache.struts.config.ActionConfig

addExceptionConfig, addForwardConfig, findExceptionConfig, findExceptionConfigs, findForwardConfig, findForwardConfigs, freeze, getApplicationConfig, getAttribute, getForward, getInclude, getInput, getModuleConfig, getMultipartClass, getName, getParameter, getPath, getPrefix, getRoleNames, getRoles, getScope, getSuffix, getType, getUnknown, getValidate, removeExceptionConfig, removeForwardConfig, setApplicationConfig, setAttribute, setForward, setInclude, setInput, setModuleConfig, setMultipartClass, setName, setParameter, setPath, setPrefix, setRoles, setScope, setSuffix, setType, setUnknown, setValidate, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowMapping

public WorkflowMapping()

Constructor

Method Detail

getWorkflows

public Collection getWorkflows()

Returns the labels of all workflows for this mapping.

getPrimaryWorkflow

public String getPrimaryWorkflow()

Returns the label of the workflow this mapping belongs to.

setPrimaryWorkflow

public void setPrimaryWorkflow(String primaryWorkflow)

Register the label of the workflow this mapping belongs to.

Parameters:

primaryWorkflow - the label of the workflow this mapping belongs to.

setSecondaryWorkflow

public void setSecondaryWorkflow(String secondaryWorkflow)

Register the label of a further workflow for this mapping.

Parameters:

secondaryWorkflow - the label of a further workflow for this mapping

addWorkflow

protected void addWorkflow(String workflow)

Register the label of a further workflow for this mapping.

Parameters:

workflow - the label of the additional workflow for this mapping

setPrevState

public void setPrevState(String prevState)

Set a prevState for the latest registered workflow of this mapping.

Parameters:

prevState - the prevState for this mapping

setNewState

public void setNewState(String newState)

Set a newState for the latest registered workflow of this mapping, if not yet set.

Parameters:

newState - the newState for this mapping

setNextState

public void setNextState(String nextState)

Set a nextState for the latest registered workflow of this mapping.

Parameters:

nextState - the nextState for this mapping

setEndWorkflow

public void setEndWorkflow(String endWorkflow)

Set the endWorkflow property for the latest registered workflow of this mapping.

Parameters:

endWorkflow - a String representing a boolean value: "true" (case insensitive) for true, any other String for false.

hasNoWorkflowChecksSet

public boolean hasNoWorkflowChecksSet()

Return the noWorkflowChecks value for this mapping.

setNoWorkflowChecks

public void setNoWorkflowChecks(String value)

Set noWorkflowChecks value for this mapping.

Parameters:

value - a String representing a boolean value: "true" (case insensitive) for true, any other String for false.

getAuthClass

public String getAuthClass()

Return authClass for this mapping.

setAuthClass

public void setAuthClass(String authClass)

Set authClass for this mapping.

Parameters:

authClass - the authClass for this mapping