fr.paris.lutece.plugins.workflowcore.service.action

Interface IActionService

All Known Implementing Classes:

ActionService

public interface IActionService

IActionService

Method Summary

Modifier and Type	Method and Description
void	create(Action action) Creation of an instance of action
void	createLinkedActions(Action action) Create the links between actions
void	decrementOrderByOne(int nOrder, int nIdWorkflow) decrements the order of all the next states after the one which will be removed
Action	findByPrimaryKey(int nIdAction) Load the Action Object
Action	findByPrimaryKeyWithoutIcon(int nIdAction) Load the Action Object without loading the contents of the icon
int	findMaximumOrderByWorkflowId(int nWorkflowId) return the maximum order number of that states in a given workflow
List<Action>	findStatesAfterOrder(int nOrder, int nIdWorkflow) Finds all the actions which have an order greater to a given order
List<Action>	findStatesBetweenOrders(int nOrder1, int nOrder2, int nIdWorkflow) Finds all the actions which have an order lower to a given order
List<Action>	getListActionByFilter(ActionFilter filter) Select actions by filter
Collection<Integer>	getListIdsLinkedAction(int nIdAction) Load the list of IDs linked to the given ID action.
void	initializeActionOrder(int nIdWorkflow) Initialize the display order of actions using their ids
void	remove(int nIdAction) Remove action which is specified in parameter
void	removeLinkedActions(int nIdAction) Remove the links between actions
void	update(Action action) Update of action which is specified in parameter

Method Detail

create

void create(Action action)

Creation of an instance of action

Parameters:

action - The instance of action which contains the informations to store

update

void update(Action action)

Update of action which is specified in parameter

Parameters:

action - The instance of action which contains the informations to update

remove

void remove(int nIdAction)

Remove action which is specified in parameter

Parameters:

nIdAction - The action id which contains the informations to remove

createLinkedActions

void createLinkedActions(Action action)

Create the links between actions

Parameters:

action - the action

removeLinkedActions

void removeLinkedActions(int nIdAction)

Remove the links between actions

Parameters:

nIdAction - the ID action

findByPrimaryKey

Action findByPrimaryKey(int nIdAction)

Load the Action Object

Parameters:

nIdAction - the action id

Returns:

the Action Object

findByPrimaryKeyWithoutIcon

Action findByPrimaryKeyWithoutIcon(int nIdAction)

Load the Action Object without loading the contents of the icon

Parameters:

nIdAction - the action id

Returns:

the Action Object

getListActionByFilter

List<Action> getListActionByFilter(ActionFilter filter)

Select actions by filter

Parameters:

filter - the action filter

Returns:

Action List

getListIdsLinkedAction

Collection<Integer> getListIdsLinkedAction(int nIdAction)

Load the list of IDs linked to the given ID action.

Parameters:

nIdAction - the ID action

Returns:

a list of IDs

findMaximumOrderByWorkflowId

int findMaximumOrderByWorkflowId(int nWorkflowId)

return the maximum order number of that states in a given workflow

Parameters:

nWorkflowId - the workflow id

Returns:

the maximum order of the states in the workflow

decrementOrderByOne

void decrementOrderByOne(int nOrder,
                         int nIdWorkflow)

decrements the order of all the next states after the one which will be removed

Parameters:

nOrder - the order

nIdWorkflow - the workflow id

findStatesBetweenOrders

List<Action> findStatesBetweenOrders(int nOrder1,
                                     int nOrder2,
                                     int nIdWorkflow)

Finds all the actions which have an order lower to a given order

Parameters:

nOrder1 - the order 1

nOrder2 - the order 2

nIdWorkflow - the workflow id

Returns:

List the list of all the actions

findStatesAfterOrder

List<Action> findStatesAfterOrder(int nOrder,
                                  int nIdWorkflow)

Finds all the actions which have an order greater to a given order

Parameters:

nOrder - the order

nIdWorkflow - the workflow id

Returns:

List the list of all the actions

initializeActionOrder

void initializeActionOrder(int nIdWorkflow)

Initialize the display order of actions using their ids

Parameters:

nIdWorkflow - the workflow id