public final class WorkflowService extends Object
Modifier and Type | Method and Description |
---|---|
boolean |
canProcessAction(int nIdResource,
String strResourceType,
int nIdAction,
Integer nExternalParentId,
javax.servlet.http.HttpServletRequest request,
boolean bIsAutomatic)
Check if the action can be proceed for the given resource
|
void |
doProcessAction(int nIdResource,
String strResourceType,
int nIdAction,
Integer nExternalParentId,
javax.servlet.http.HttpServletRequest request,
Locale locale,
boolean bIsAutomatic)
Proceed action given in parameter
|
void |
doProcessAutomaticReflexiveActions(int nIdResource,
String strResourceType,
int nIdState,
Integer nIdExternalParent,
Locale locale)
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 workflow by list id
|
String |
doSaveTasksForm(int nIdResource,
String strResourceType,
int nIdAction,
Integer nExternalParentId,
javax.servlet.http.HttpServletRequest request,
Locale locale)
Perform the information on the various tasks associated with the given action
specified in parameter
|
void |
executeActionAutomatic(int nIdResource,
String strResourceType,
int nIdWorkflow,
Integer nExternalParentId)
Execute action automatic
|
Collection<fr.paris.lutece.plugins.workflowcore.business.action.Action> |
getActions(int nIdResource,
String strResourceType,
int nIdWorkflow,
AdminUser user)
returns a list of actions possible for a given document based on the status
of the document in the workflow and the user role
|
Map<Integer,List<fr.paris.lutece.plugins.workflowcore.business.action.Action>> |
getActions(List<Integer> listIdResource,
String strResourceType,
Integer nIdExternalParentId,
int nIdWorkflow,
AdminUser user)
returns a list of actions possible for a given document based on the status
of the document in the workflow and the user role
|
Collection<fr.paris.lutece.plugins.workflowcore.business.state.State> |
getAllStateByWorkflow(int nIdWorkflow,
AdminUser user)
returns all state of a given workflow
|
List<Integer> |
getAuthorizedResourceList(String strResourceType,
int nIdWorkflow,
int nIdWorkflowState,
Integer nExternalParentId,
AdminUser user)
Get all authorized resource Id
|
List<Integer> |
getAuthorizedResourceList(String strResourceType,
int nIdWorkflow,
List<Integer> lListIdWorkflowState,
Integer nExternalParentId,
AdminUser user)
Get all authorized resource Id by list of state
|
String |
getDisplayDocumentHistory(int nIdResource,
String strResourceType,
int nIdWorkflow,
javax.servlet.http.HttpServletRequest request,
Locale locale)
returns the actions history performed on a resource
|
String |
getDisplayDocumentHistory(int nIdResource,
String strResourceType,
int nIdWorkflow,
javax.servlet.http.HttpServletRequest request,
Locale locale,
Map<String,Object> model,
String strTemplate)
returns the actions history performed on a resource
|
String |
getDisplayTasksForm(int nIdResource,
String strResourceType,
int nIdAction,
javax.servlet.http.HttpServletRequest request,
Locale locale)
returns the tasks form
|
String |
getDocumentHistoryXml(int nIdResource,
String strResourceType,
int nIdWorkflow,
javax.servlet.http.HttpServletRequest request,
Locale locale)
returns a xml wich contains the actions history performed on a resource
|
static WorkflowService |
getInstance()
Returns the unique instance of the service
|
List<fr.paris.lutece.plugins.workflowcore.business.action.Action> |
getMassActions(int nIdWorkflow)
Get the list of mass actions 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
|
fr.paris.lutece.plugins.workflowcore.business.state.State |
getState(int nIdResource,
String strResourceType,
int nIdWorkflow,
Integer nIdExternalParentId)
returns the state of a given document of the document in the workflow and the
user role
|
ReferenceList |
getWorkflowsEnabled(AdminUser user,
Locale locale)
return a reference list which contains a list enabled workflow
|
boolean |
isAuthorized(int nIdResource,
String strResourceType,
int nIdWorkflow,
AdminUser user)
Check that a given user is allowed to view a resource depending the state of
the resource
|
boolean |
isAvailable()
Check if the workflow service is available.
|
boolean |
isDisplayTasksForm(int nIdAction,
Locale locale)
return true if a form is associate to the action
|
public static WorkflowService getInstance()
public boolean isAvailable()
public Collection<fr.paris.lutece.plugins.workflowcore.business.action.Action> getActions(int nIdResource, String strResourceType, int nIdWorkflow, AdminUser user)
nIdResource
- the document idstrResourceType
- the document typeuser
- the adminUsernIdWorkflow
- the workflow idpublic Map<Integer,List<fr.paris.lutece.plugins.workflowcore.business.action.Action>> getActions(List<Integer> listIdResource, String strResourceType, Integer nIdExternalParentId, int nIdWorkflow, AdminUser user)
listIdResource
- the list of resource idstrResourceType
- the document typenIdExternalParentId
- the external parent identifiernIdWorkflow
- the workflow iduser
- the adminUserpublic boolean isDisplayTasksForm(int nIdAction, Locale locale)
nIdAction
- the action idlocale
- the loaclepublic void doProcessAction(int nIdResource, String strResourceType, int nIdAction, Integer nExternalParentId, javax.servlet.http.HttpServletRequest request, Locale locale, boolean bIsAutomatic)
nIdResource
- the resource idstrResourceType
- the resource typenIdAction
- the action idnExternalParentId
- the external parent idrequest
- the requestlocale
- localebIsAutomatic
- Is automaticpublic String getDisplayDocumentHistory(int nIdResource, String strResourceType, int nIdWorkflow, javax.servlet.http.HttpServletRequest request, Locale locale)
nIdResource
- the resource idstrResourceType
- the resource typerequest
- the requestnIdWorkflow
- the workflow idlocale
- the localepublic String getDisplayDocumentHistory(int nIdResource, String strResourceType, int nIdWorkflow, javax.servlet.http.HttpServletRequest request, Locale locale, Map<String,Object> model, String strTemplate)
nIdResource
- the resource idstrResourceType
- the resource typerequest
- the requestnIdWorkflow
- the workflow idlocale
- the localemodel
- The model to add to the default modelstrTemplate
- The templatepublic String getDocumentHistoryXml(int nIdResource, String strResourceType, int nIdWorkflow, javax.servlet.http.HttpServletRequest request, Locale locale)
nIdResource
- the resource idstrResourceType
- the resource typerequest
- the requestnIdWorkflow
- the workflow idlocale
- the localepublic String doSaveTasksForm(int nIdResource, String strResourceType, int nIdAction, Integer nExternalParentId, javax.servlet.http.HttpServletRequest request, Locale locale)
nIdResource
- the resource idstrResourceType
- the resource typenExternalParentId
- the external parent idrequest
- the requestnIdAction
- the action idlocale
- the localepublic List<Integer> getResourceIdListByIdState(int nIdState, String strResourceType)
nIdState
- The id of the state of resources to getstrResourceType
- The type of resources to getpublic void doRemoveWorkFlowResource(int nIdResource, String strResourceType)
nIdResource
- the resource idstrResourceType
- the resource typepublic void doRemoveWorkFlowResourceByListId(List<Integer> lListIdResource, String strResourceType, Integer nIdWorflow)
lListIdResource
- list of id resourcestrResourceType
- the ressource typenIdWorflow
- the workflow idpublic String getDisplayTasksForm(int nIdResource, String strResourceType, int nIdAction, javax.servlet.http.HttpServletRequest request, Locale locale)
nIdResource
- the document idstrResourceType
- the document typerequest
- the requestnIdAction
- the action idlocale
- the localepublic boolean isAuthorized(int nIdResource, String strResourceType, int nIdWorkflow, AdminUser user)
nIdResource
- the document idstrResourceType
- the document typeuser
- the AdminUsernIdWorkflow
- the workflow idpublic List<Integer> getAuthorizedResourceList(String strResourceType, int nIdWorkflow, int nIdWorkflowState, Integer nExternalParentId, AdminUser user)
strResourceType
- the resource typenIdWorkflow
- the workflow idnIdWorkflowState
- The workflow state id or -1 for all workflow statesnExternalParentId
- The external parent iduser
- the AdminUserpublic List<Integer> getAuthorizedResourceList(String strResourceType, int nIdWorkflow, List<Integer> lListIdWorkflowState, Integer nExternalParentId, AdminUser user)
strResourceType
- the resource typenIdWorkflow
- the workflow idlListIdWorkflowState
- The workflow state id or null for all
workflow statesnExternalParentId
- the externbal parent identifieruser
- the AdminUserpublic ReferenceList getWorkflowsEnabled(AdminUser user, Locale locale)
user
- the AdminUserlocale
- the localepublic Collection<fr.paris.lutece.plugins.workflowcore.business.state.State> getAllStateByWorkflow(int nIdWorkflow, AdminUser user)
user
- the adminUsernIdWorkflow
- the workflow idpublic fr.paris.lutece.plugins.workflowcore.business.state.State getState(int nIdResource, String strResourceType, int nIdWorkflow, Integer nIdExternalParentId)
nIdResource
- the document idstrResourceType
- the document typenIdWorkflow
- the workflow idnIdExternalParentId
- the external parent idpublic void executeActionAutomatic(int nIdResource, String strResourceType, int nIdWorkflow, Integer nExternalParentId)
nIdResource
- the document idstrResourceType
- the document typenIdWorkflow
- the workflow idnExternalParentId
- the external parent idpublic List<fr.paris.lutece.plugins.workflowcore.business.action.Action> getMassActions(int nIdWorkflow)
nIdWorkflow
- the id workflowpublic boolean canProcessAction(int nIdResource, String strResourceType, int nIdAction, Integer nExternalParentId, javax.servlet.http.HttpServletRequest request, boolean bIsAutomatic)
nIdResource
- the id resourcestrResourceType
- the resource typenIdAction
- the id actionnExternalParentId
- the external parent idrequest
- the HTTP requestbIsAutomatic
- is automatic actionpublic void doProcessAutomaticReflexiveActions(int nIdResource, String strResourceType, int nIdState, Integer nIdExternalParent, Locale locale)
nIdResource
- the resource idstrResourceType
- the resource typenIdState
- the state of the resource idnIdExternalParent
- the external parent id*locale
- localeCopyright © 2020 City of Paris. All rights reserved.