Package org.ametys.cms.workflow.history

Class WorkflowHistoryHelper

java.lang.Object

org.ametys.cms.workflow.history.WorkflowHistoryHelper

All Implemented Interfaces:

Component, Serviceable

public class WorkflowHistoryHelper
extends Object
implements Component, Serviceable

This action returns the workflow history of a element with workflow

Field Summary

Fields

Modifier and Type	Field	Description
protected UserHelper	_userHelper	The user helper
static final String	ROLE	The component role.

Constructor Summary

Constructors

Constructor	Description
WorkflowHistoryHelper()

Method Summary

Modifier and Type	Method	Description
WorkflowHistory	getWorkflowHistory(ElementWithWorkflow objectWithWorkflow, long workflowId, com.opensymphony.workflow.Workflow workflow, int initialActionId)	Get the workflow history
Map<String,Object>	historyStep2Json(HistoryStep historyStep)	History step 2 JSON
void	service(ServiceManager manager)

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

The component role.

_userHelper

protected UserHelper _userHelper

The user helper

Constructor Details

WorkflowHistoryHelper

public WorkflowHistoryHelper()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getWorkflowHistory

public WorkflowHistory getWorkflowHistory(ElementWithWorkflow objectWithWorkflow,
 long workflowId,
 com.opensymphony.workflow.Workflow workflow,
 int initialActionId)
                                   throws ProcessingException,
javax.jcr.RepositoryException

Get the workflow history

Parameters:

objectWithWorkflow - the object with workflow

workflowId - the workflow id

workflow - the workflow

initialActionId - the initial action id

Returns:

a workflow history

Throws:

ProcessingException - if a procession error occurred

javax.jcr.RepositoryException - if a repository error occurred

historyStep2Json

public Map<String,Object> historyStep2Json(HistoryStep historyStep)
                                    throws javax.jcr.RepositoryException

History step 2 JSON

Parameters:

historyStep - the history step

Returns:

the JSON map of the history step

Throws:

javax.jcr.RepositoryException - if a repository error occurred