org.ametys.plugins.workflow.cocoon

Class InitializeWorkflowAction

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.cocoon.acting.AbstractAction

org.apache.cocoon.acting.ServiceableAction

org.ametys.plugins.workflow.cocoon.AbstractWorkflowAction

org.ametys.plugins.workflow.cocoon.InitializeWorkflowAction

All Implemented Interfaces:

Initializable, Component, LogEnabled, Serviceable, Action

Direct Known Subclasses:

InitializeContentWorkflowAction

public class InitializeWorkflowAction
extends AbstractWorkflowAction

Action for initializing a workflow.

The following parameters are supported:

workflowName

the name of the workflow to instantiate

actionId

the id of the action to fire

Map returned contains the workflow id on successful creation (workflowId key) and throw an exception on error.

Field Summary

Fields inherited from class org.ametys.plugins.workflow.cocoon.AbstractWorkflowAction

_workflowProvider

Fields inherited from class org.apache.cocoon.acting.ServiceableAction

manager

Fields inherited from class org.apache.cocoon.acting.AbstractAction

EMPTY_MAP

Fields inherited from interface org.apache.cocoon.acting.Action

ROLE

Constructor Summary

Constructors

Constructor and Description
InitializeWorkflowAction()

Method Summary

Modifier and Type	Method and Description
protected Map	_act(Redirector redirector, Map objectModel, String source, Parameters parameters, int actionId, Map inputs) Initialize or act on a workflow instance.
protected Map	_getActionResult(Redirector redirector, Map objectModel, String source, Parameters parameters, long workflowId) Provides the action result after successful workflow instance creation.
protected String	_getExceptionContext(Map objectModel, String source, Parameters parameters) Provides the exception context for a more friendly error message.
protected String	_getWorkflowName(Map objectModel, String source, Parameters parameters) Provides the workflow name to use.

Methods inherited from class org.ametys.plugins.workflow.cocoon.AbstractWorkflowAction

_getActionId, _getFailConditions, _getInputs, _getWorkflowErrors, _getWorkflowWarns, _processInvalidActionException, _processWorkflowException, act, initialize

Methods inherited from class org.apache.cocoon.acting.ServiceableAction

service

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Constructor Detail

InitializeWorkflowAction

public InitializeWorkflowAction()

Method Detail

_act

protected Map _act(Redirector redirector,
                   Map objectModel,
                   String source,
                   Parameters parameters,
                   int actionId,
                   Map inputs)
            throws com.opensymphony.workflow.InvalidInputException,
                   com.opensymphony.workflow.WorkflowException

Description copied from class: AbstractWorkflowAction

Initialize or act on a workflow instance.

Specified by:

_act in class AbstractWorkflowAction

Parameters:

redirector - the redirector.

objectModel - the current object model.

source - the current source.

parameters - the current parameters.

actionId - the action id to use.

inputs - the inputs to use

Returns:

the action result.

Throws:

com.opensymphony.workflow.InvalidInputException - if the action id is not valid.

com.opensymphony.workflow.WorkflowException - if the action failed.

_getWorkflowName

protected String _getWorkflowName(Map objectModel,
                                  String source,
                                  Parameters parameters)

Provides the workflow name to use.

Parameters:

objectModel - the current object model.

source - the current source.

parameters - the current parameters.

Returns:

the workflow name.

_getActionResult

protected Map _getActionResult(Redirector redirector,
                               Map objectModel,
                               String source,
                               Parameters parameters,
                               long workflowId)

Provides the action result after successful workflow instance creation.

Default implementation provides a singleton Map with workflowId key and workflow id value.

Parameters:

redirector - the redirector.

objectModel - the current object model.

source - the current source.

parameters - the current parameters.

workflowId - the workflow instance id.

Returns:

the action result.

_getExceptionContext

protected String _getExceptionContext(Map objectModel,
                                      String source,
                                      Parameters parameters)

Description copied from class: AbstractWorkflowAction

Provides the exception context for a more friendly error message.

Specified by:

_getExceptionContext in class AbstractWorkflowAction

Parameters:

objectModel - the current object model.

source - the current source.

parameters - the current parameters.

Returns:

the message describing the exception context.