org.ametys.plugins.forms.workflow

Class FormEntriesWorkflowAction

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.WorkflowAction

org.ametys.plugins.forms.workflow.FormEntriesWorkflowAction

All Implemented Interfaces:

Initializable, Component, LogEnabled, Serviceable, Action

public class FormEntriesWorkflowAction
extends WorkflowAction

Action for executing a transition on a form entry workflow.

The following parameters are supported:

actionId

the id of the action to fire

Field Summary

Fields

Modifier and Type	Field and Description
private CurrentUserProvider	_currentUserProvider Helper to retrieve the current user
private FormPropertiesManager	_formPropertiesManager Component gathering utility methods to work with the forms JCR representations
private FormTableManager	_formTableManager Helper to manipulation the forms SQL tables
private JSONUtils	_jsonUtils Utility component for the handling of object represented in JSON
private UserManager	_userManager The users manager

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
FormEntriesWorkflowAction()

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<String,Object>	_getInputs(Redirector redirector, Map objectModel, String source, Parameters parameters) Provide the inputs to use.
protected long	_getWorkflowId(Map objectModel, String source, Parameters parameters) Provide the workflow id.
void	service(ServiceManager serviceManager)

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

_getActionResult, _getExceptionContext

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

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

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

Field Detail

_formPropertiesManager

private FormPropertiesManager _formPropertiesManager

Component gathering utility methods to work with the forms JCR representations

_formTableManager

private FormTableManager _formTableManager

Helper to manipulation the forms SQL tables

_currentUserProvider

private CurrentUserProvider _currentUserProvider

Helper to retrieve the current user

_userManager

private UserManager _userManager

The users manager

_jsonUtils

private JSONUtils _jsonUtils

Utility component for the handling of object represented in JSON

Constructor Detail

FormEntriesWorkflowAction

public FormEntriesWorkflowAction()

Method Detail

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class ServiceableAction

Throws:

ServiceException

_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.

Overrides:

_act in class WorkflowAction

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.

_getWorkflowId

protected long _getWorkflowId(Map objectModel,
                              String source,
                              Parameters parameters)

Description copied from class: WorkflowAction

Provide the workflow id.

Default implementation uses parameter workflowId.

Overrides:

_getWorkflowId in class WorkflowAction

Parameters:

objectModel - the current object model.

source - the current source.

parameters - the current parameters.

Returns:

the workflow id.

_getInputs

protected Map<String,Object> _getInputs(Redirector redirector,
                                        Map objectModel,
                                        String source,
                                        Parameters parameters)
                                 throws Exception

Description copied from class: AbstractWorkflowAction

Provide the inputs to use.

Default implementation provide the redirector.

Overrides:

_getInputs in class AbstractWorkflowAction

Parameters:

redirector - the redirector.

objectModel - the current object model.

source - the current source.

parameters - the current parameters.

Returns:

the inputs to use.

Throws:

Exception - if an error occurs.