Package org.ametys.plugins.workflow.dao

Class WorkflowPropertyDAO

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.workflow.dao.WorkflowPropertyDAO

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class WorkflowPropertyDAO
extends AbstractLogEnabled
implements Component, Serviceable

DAO for workflow element's meta attributes

Field Summary

Fields

Modifier and Type	Field	Description
protected WorflowRightHelper	_workflowRightHelper	The workflow right helper
protected WorkflowSessionHelper	_workflowSessionHelper	The workflow session helper
protected WorkflowStepDAO	_workflowStepDAO	The workflow step DAO
protected WorkflowTransitionDAO	_workflowTransitionDAO	The workflow transition DAO

Constructor Summary

Constructors

Constructor	Description
WorkflowPropertyDAO()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	addProperty(String workflowName, Integer stepId, Integer actionId, String name, String value)	Add a property to a workflow element
Map<String,Object>	deleteProperty(String workflowName, Integer stepId, Integer actionId, String name)	Remove a property from a workflow element
Map<String,Object>	editProperty(String workflowName, Integer stepId, Integer actionId, String oldName, String newName, String newValue)	Edit property in a workflow element
Map<String,Object>	getActionProperties(String workflowName, Integer actionId)	Get properties of current action
Set<String>	getPropertiesNames(String workflowName, Integer stepId, Integer actionId)	Get the used property names for current workflow element
Map<String,Object>	getStepProperties(String workflowName, Integer stepId)	Get properties of current step
void	service(ServiceManager smanager)

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

_workflowSessionHelper

protected WorkflowSessionHelper _workflowSessionHelper

The workflow session helper

_workflowRightHelper

protected WorflowRightHelper _workflowRightHelper

The workflow right helper

_workflowStepDAO

protected WorkflowStepDAO _workflowStepDAO

The workflow step DAO

_workflowTransitionDAO

protected WorkflowTransitionDAO _workflowTransitionDAO

The workflow transition DAO

Constructor Details

WorkflowPropertyDAO

public WorkflowPropertyDAO()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getStepProperties

public Map<String,Object> getStepProperties(String workflowName,
 Integer stepId)

Get properties of current step

Parameters:

workflowName - the workflow unique name

stepId - id of the current step

Returns:

a map of the properties

getActionProperties

public Map<String,Object> getActionProperties(String workflowName,
 Integer actionId)

Get properties of current action

Parameters:

workflowName - the workflow unique name

actionId - id of the current action

Returns:

a map of the properties

getPropertiesNames

public Set<String> getPropertiesNames(String workflowName,
 Integer stepId,
 Integer actionId)

Get the used property names for current workflow element

Parameters:

workflowName - unique name of current workflow

stepId - id of current step

actionId - id of current action, can be null if only a step is selected

Returns:

a set of the properties' names

addProperty

public Map<String,Object> addProperty(String workflowName,
 Integer stepId,
 Integer actionId,
 String name,
 String value)

Add a property to a workflow element

Parameters:

workflowName - unique name of current workflow

stepId - id of current step

actionId - id of current action, can be null if only a step is selected

name - the new name to save

value - the value to save

Returns:

the property's infos or an error message

editProperty

public Map<String,Object> editProperty(String workflowName,
 Integer stepId,
 Integer actionId,
 String oldName,
 String newName,
 String newValue)

Edit property in a workflow element

Parameters:

workflowName - unique name of current workflow

stepId - id of current step

actionId - id of current action, can be null if only a step is selected

oldName - the old name for this property

newName - the new name to save

newValue - the value to save

Returns:

the property's infos or an error message

deleteProperty

public Map<String,Object> deleteProperty(String workflowName,
 Integer stepId,
 Integer actionId,
 String name)

Remove a property from a workflow element

Parameters:

workflowName - unique name of current workflow

stepId - id of current step

actionId - id of current action, can be null if only a step is selected

name - the new name to save

Returns:

the property's parent infos or an error message