fr.paris.lutece.plugins.workflowcore.service.workflow

Interface IWorkflowService

All Known Implementing Classes:

WorkflowService

public interface IWorkflowService

WorkflowService

Method Summary

Modifier and Type	Method and Description
boolean	canAutomaticActionBeProcessed(int nIdResource, String strResourceType, int nIdAction) Check if an automatic action can be processed or not
boolean	canProcessAction(int nIdResource, String strResourceType, int nIdAction, Integer nExternalParentId) Check if the action can be proceed for the given resource
void	create(Workflow workflow) Creation of an instance of workflow
void	doProcessAction(int nIdResource, String strResourceType, int nIdAction, Integer nExternalParentId, javax.servlet.http.HttpServletRequest request, Locale locale, boolean bIsAutomatic, String strUserAccessCode) Deprecated.
default void	doProcessAction(int nIdResource, String strResourceType, int nIdAction, Integer nExternalParentId, javax.servlet.http.HttpServletRequest request, Locale locale, boolean bIsAutomatic, String strUserAccessCode, fr.paris.lutece.api.user.User user) Proceed action given in parameter
void	doProcessAutomaticReflexiveActions(int nIdResource, String strResourceType, int nIdState, Integer nIdExternalParent, Locale locale) Deprecated.
default void	doProcessAutomaticReflexiveActions(int nIdResource, String strResourceType, int nIdState, Integer nIdExternalParent, Locale locale, fr.paris.lutece.api.user.User user) Proceed automatic reflexive actions of state given in parameter
void	doRemoveWorkFlowResource(int nIdResource, String strResourceType) Remove in every workflows the resource specified in parameter
void	doRemoveWorkFlowResourceByListId(List<Integer> lListIdResource, String strResourceType, Integer nIdWorflow) Remove list of resource by list of id resource
void	executeActionAutomatic(int nIdResource, String strResourceType, int nIdWorkflow, Integer nExternalParentId) Deprecated.
default void	executeActionAutomatic(int nIdResource, String strResourceType, int nIdWorkflow, Integer nExternalParentId, fr.paris.lutece.api.user.User user) Execute action automatic
Workflow	findByPrimaryKey(int nIdWorkflow) Load the workflow Object
Collection<Action>	getActions(int nIdResource, String strResourceType, int nIdWorkflow) returns a list of actions possible for a given resource based on the status of the resource in the workflow, the user role and if the prerequisites are satisfied.
Map<Integer,List<Action>>	getActions(List<Integer> listIdResource, String strResourceType, Integer nIdExternalParentId, int nIdWorkflow) returns a list of actions possible for a given resource based on the status of the resource in the workflow and the user role
Collection<State>	getAllStateByWorkflow(int nIdWorkflow) returns all state of a given workflow
ResourceWorkflow	getInitialResourceWorkflow(int nIdResource, String strResourceType, Workflow workflow, Integer nExternalParentId) Create a ResourceWorkflow Object wich contains the association of resource and the initial state of the workflow
List<Workflow>	getListWorkflowsByFilter(WorkflowFilter filter) return the workflow list by filter
Map<String,String>	getMapTaskTypes(Locale locale) Return a map which contains the task types
List<Action>	getMassActions(int nIdWorkflow) Get the list of mass actions from a given id workflow
List<Action>	getMassActions(int nIdWorkflow, int stateId) Get the list of mass actions following a state from a given id workflow
List<Integer>	getResourceIdListByIdState(int nIdState, String strResourceType) Get the list of ids of resources of a given type that are in a given state
State	getState(int nIdResource, String strResourceType, int nIdWorkflow, Integer nIdExternalParentId) returns the state of a given resource
boolean	isDisplayTasksForm(int nIdAction, Locale locale) Return true if a form is associate to the action
void	remove(int nIdWorkflow) Remove workflow which is specified in parameter
void	update(Workflow workflow) Update of workflow which is specified in parameter

Method Detail

create

void create(Workflow workflow)

Creation of an instance of workflow

Parameters:

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

update

void update(Workflow workflow)

Update of workflow which is specified in parameter

Parameters:

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

remove

void remove(int nIdWorkflow)

Remove workflow which is specified in parameter

Parameters:

nIdWorkflow - the workflow to remove

findByPrimaryKey

Workflow findByPrimaryKey(int nIdWorkflow)

Load the workflow Object

Parameters:

nIdWorkflow - the workflow id

Returns:

the Workflow Object

getListWorkflowsByFilter

List<Workflow> getListWorkflowsByFilter(WorkflowFilter filter)

return the workflow list by filter

Parameters:

filter - the filter

Returns:

the workflow list

getActions

Collection<Action> getActions(int nIdResource,
                              String strResourceType,
                              int nIdWorkflow)

returns a list of actions possible for a given resource based on the status of the resource in the workflow, the user role and if the prerequisites are satisfied.

Parameters:

nIdResource - the resource id

strResourceType - the resource type

nIdWorkflow - the workflow id

Returns:

a list of Action

getActions

Map<Integer,List<Action>> getActions(List<Integer> listIdResource,
                                     String strResourceType,
                                     Integer nIdExternalParentId,
                                     int nIdWorkflow)

returns a list of actions possible for a given resource based on the status of the resource in the workflow and the user role

Parameters:

listIdResource - the list of resource id

strResourceType - the resource type

nIdExternalParentId - the external parent identifier

nIdWorkflow - the workflow id

Returns:

a list of Action

getState

State getState(int nIdResource,
               String strResourceType,
               int nIdWorkflow,
               Integer nIdExternalParentId)

returns the state of a given resource

Parameters:

nIdResource - the resource id

strResourceType - the resource type

nIdWorkflow - the workflow id

nIdExternalParentId - the external parent id

Returns:

the state of a given resource

getAllStateByWorkflow

Collection<State> getAllStateByWorkflow(int nIdWorkflow)

returns all state of a given workflow

Parameters:

nIdWorkflow - the workflow id

Returns:

the list of states of a given workflow

getMassActions

List<Action> getMassActions(int nIdWorkflow)

Get the list of mass actions from a given id workflow

Parameters:

nIdWorkflow - the id workflow

Returns:

a list of actions

getMassActions

List<Action> getMassActions(int nIdWorkflow,
                            int stateId)

Get the list of mass actions following a state from a given id workflow

Parameters:

nIdWorkflow - the workflow id

stateId - the state id

Returns:

the mass actions

getMapTaskTypes

Map<String,String> getMapTaskTypes(Locale locale)

Return a map which contains the task types

Parameters:

locale - the locale

Returns:

a reference list which contains the task types

getInitialResourceWorkflow

ResourceWorkflow getInitialResourceWorkflow(int nIdResource,
                                            String strResourceType,
                                            Workflow workflow,
                                            Integer nExternalParentId)

Create a ResourceWorkflow Object wich contains the association of resource and the initial state of the workflow

Parameters:

nIdResource - the resource id

strResourceType - the resource type

workflow - the workflow

nExternalParentId - the id external parent

Returns:

a ResourceWorkflow Object

isDisplayTasksForm

boolean isDisplayTasksForm(int nIdAction,
                           Locale locale)

Return true if a form is associate to the action

Parameters:

nIdAction - the action id

locale - the loacle

Returns:

true if a form is associate to the action

canProcessAction

boolean canProcessAction(int nIdResource,
                         String strResourceType,
                         int nIdAction,
                         Integer nExternalParentId)

Check if the action can be proceed for the given resource

Parameters:

nIdResource - the id resource

strResourceType - the resource type

nIdAction - the id action

nExternalParentId - the external parent id

Returns:

true if the action can proceed, false otherwise

doProcessAction

@Deprecated
void doProcessAction(int nIdResource,
                                 String strResourceType,
                                 int nIdAction,
                                 Integer nExternalParentId,
                                 javax.servlet.http.HttpServletRequest request,
                                 Locale locale,
                                 boolean bIsAutomatic,
                                 String strUserAccessCode)

Deprecated.

Proceed action given in parameter

Parameters:

nIdResource - the resource id

strResourceType - the resource type

nIdAction - the action id

nExternalParentId - the external parent id*

request - the request

locale - locale

bIsAutomatic - true if action is automatic

strUserAccessCode - the user access code

doProcessAction

default void doProcessAction(int nIdResource,
                             String strResourceType,
                             int nIdAction,
                             Integer nExternalParentId,
                             javax.servlet.http.HttpServletRequest request,
                             Locale locale,
                             boolean bIsAutomatic,
                             String strUserAccessCode,
                             fr.paris.lutece.api.user.User user)

Proceed action given in parameter

Parameters:

nIdResource - the resource id

strResourceType - the resource type

nIdAction - the action id

nExternalParentId - the external parent id*

request - the request

locale - locale

bIsAutomatic - true if action is automatic

strUserAccessCode - the user access code

the - user the user

doProcessAutomaticReflexiveActions

@Deprecated
void doProcessAutomaticReflexiveActions(int nIdResource,
                                                    String strResourceType,
                                                    int nIdState,
                                                    Integer nIdExternalParent,
                                                    Locale locale)

Deprecated.

Proceed automatic reflexive actions of state given in parameter

Parameters:

nIdResource - the resource id

strResourceType - the resource type

nIdState - the state id

nIdExternalParent - the external parent id*

locale - locale

doProcessAutomaticReflexiveActions

default void doProcessAutomaticReflexiveActions(int nIdResource,
                                                String strResourceType,
                                                int nIdState,
                                                Integer nIdExternalParent,
                                                Locale locale,
                                                fr.paris.lutece.api.user.User user)

Proceed automatic reflexive actions of state given in parameter

Parameters:

nIdResource - the resource id

strResourceType - the resource type

nIdState - the state id

nIdExternalParent - the external parent id*

locale - locale

user - the user

doRemoveWorkFlowResource

void doRemoveWorkFlowResource(int nIdResource,
                              String strResourceType)

Remove in every workflows the resource specified in parameter

Parameters:

nIdResource - the resource id

strResourceType - the resource type

doRemoveWorkFlowResourceByListId

void doRemoveWorkFlowResourceByListId(List<Integer> lListIdResource,
                                      String strResourceType,
                                      Integer nIdWorflow)

Remove list of resource by list of id resource

Parameters:

lListIdResource - the list of resource id

strResourceType - the resource type

nIdWorflow - the workflow id

getResourceIdListByIdState

List<Integer> getResourceIdListByIdState(int nIdState,
                                         String strResourceType)

Get the list of ids of resources of a given type that are in a given state

Parameters:

nIdState - The id of the state of resources to get

strResourceType - The type of resources to get

Returns:

The list of resources matching both given state id and resource given. Return an empty list if no resource was found, or if the state does not exist.

executeActionAutomatic

@Deprecated
void executeActionAutomatic(int nIdResource,
                                        String strResourceType,
                                        int nIdWorkflow,
                                        Integer nExternalParentId)

Deprecated.

Execute action automatic

Parameters:

nIdResource - the resource id

strResourceType - the resource type

nIdWorkflow - the workflow id

nExternalParentId - the external parent id

executeActionAutomatic

default void executeActionAutomatic(int nIdResource,
                                    String strResourceType,
                                    int nIdWorkflow,
                                    Integer nExternalParentId,
                                    fr.paris.lutece.api.user.User user)

Execute action automatic

Parameters:

nIdResource - the resource id

strResourceType - the resource type

nIdWorkflow - the workflow id

nExternalParentId - the external parent id

user - the user

canAutomaticActionBeProcessed

boolean canAutomaticActionBeProcessed(int nIdResource,
                                      String strResourceType,
                                      int nIdAction)

Check if an automatic action can be processed or not

Parameters:

nIdResource - The id of the resource

strResourceType - The resource type

nIdAction - The id of the action

Returns:

True if the action can be processed, false otherwise