fr.paris.lutece.portal.service.workflow
Interface IWorkflowService


public interface IWorkflowService

WorkflowService


Method Summary
 void doProcessAction(int nIdResource, java.lang.String strResourceType, int nIdAction, javax.servlet.http.HttpServletRequest request, java.util.Locale locale, boolean isAutomatic)
          Deprecated. 
 void doProcessAction(int nIdResource, java.lang.String strResourceType, int nIdAction, java.lang.Integer nExternalParentId, javax.servlet.http.HttpServletRequest request, java.util.Locale locale, boolean isAutomatic)
          Proceed action given in parameter
 void doRemoveWorkFlowResource(int nIdResource, java.lang.String strResourceType)
          Remove in all workflows the resource specified in parameter
 void doRemoveWorkFlowResourceByListId(java.util.List<java.lang.Integer> lListIdResource, java.lang.String strResourceType, java.lang.Integer nIdWorflow)
          Remove list of resource by list of id resource
 java.lang.String doSaveTasksForm(int nIdResource, java.lang.String strResourceType, int nIdAction, javax.servlet.http.HttpServletRequest request, java.util.Locale locale)
          Deprecated. 
 java.lang.String doSaveTasksForm(int nIdResource, java.lang.String strResourceType, int nIdAction, java.lang.Integer nExternalParentId, javax.servlet.http.HttpServletRequest request, java.util.Locale locale)
          Perform the information on the various tasks associated with the given action specified in parameter
 void executeActionAutomatic(int nIdResource, java.lang.String strResourceType, int nIdWorkflow)
          Deprecated. 
 void executeActionAutomatic(int nIdResource, java.lang.String strResourceType, int nIdWorkflow, java.lang.Integer nExternalParentId)
          Execute action automatic
 java.util.Collection<Action> getActions(int nIdResource, java.lang.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
 java.util.HashMap<java.lang.Integer,java.util.List<Action>> getActions(java.util.List<java.lang.Integer> listIdResource, java.lang.String strResourceType, java.lang.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
 java.util.Collection<State> getAllStateByWorkflow(int nIdWorkflow, AdminUser user)
          returns all state of a given workflow
 java.util.List<java.lang.Integer> getAuthorizedResourceList(java.lang.String strResourceType, int nIdWorkflow, int nIdWorkflowState, AdminUser user)
          Deprecated. 
 java.util.List<java.lang.Integer> getAuthorizedResourceList(java.lang.String strResourceType, int nIdWorkflow, int nIdWorkflowState, java.lang.Integer nExternalParentId, AdminUser user)
          Get all authorized resource Id
 java.util.List<java.lang.Integer> getAuthorizedResourceList(java.lang.String strResourceType, int nIdWorkflow, java.util.List<java.lang.Integer> lListIdWorkflowState, java.lang.Integer nExternalParentId, AdminUser user)
          Get all authorized resource Id
 java.lang.String getDisplayDocumentHistory(int nIdResource, java.lang.String strResourceType, int nIdWorkflow, javax.servlet.http.HttpServletRequest request, java.util.Locale locale)
          returns the actions history performed on a resource
 java.lang.String getDisplayTasksForm(int nIdResource, java.lang.String strResourceType, int nIdAction, javax.servlet.http.HttpServletRequest request, java.util.Locale locale)
          returns the tasks form
 java.lang.String getDocumentHistoryXml(int nIdResource, java.lang.String strResourceType, int nIdWorkflow, javax.servlet.http.HttpServletRequest request, java.util.Locale locale)
          returns a xml wich contains the actions history performed on a resource
 java.util.Collection<java.lang.Integer> getListIdRessourceByState(int nIdState, java.lang.String strResourceType, AdminUser user)
          Deprecated. 
 State getState(int nIdResource, java.lang.String strResourceType, int nIdWorkflow, AdminUser user)
          Deprecated. 
 State getState(int nIdResource, java.lang.String strResourceType, int nIdWorkflow, java.lang.Integer nIdExternalParentId, AdminUser user)
          returns the state of a given document
 ReferenceList getWorkflowsEnabled(AdminUser user, java.util.Locale locale)
          return a referencelist wich contains a list enabled workflow
 boolean isAuthorized(int nIdResource, java.lang.String strResourceType, int nIdWorkflow, AdminUser user)
          Check that a given user is allowed to view a resource depending the state of the resource
 boolean isDisplayTasksForm(int nIdAction, java.util.Locale locale)
          return true if a form is associate to the action
 

Method Detail

getActions

java.util.Collection<Action> getActions(int nIdResource,
                                        java.lang.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

Parameters:
nIdResource - the document id
strResourceType - the document type
user - the adminUser
nIdWorkflow - the workflow id
Returns:
a list of Action

getActions

java.util.HashMap<java.lang.Integer,java.util.List<Action>> getActions(java.util.List<java.lang.Integer> listIdResource,
                                                                       java.lang.String strResourceType,
                                                                       java.lang.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

Parameters:
listIdResource - the list of resource id
strResourceType - the document type
nIdExternalParentId - the external parent identifier
nIdWorkflow - the workflow id
user - the adminUser
Returns:
a list of Action

getState

@Deprecated
State getState(int nIdResource,
                          java.lang.String strResourceType,
                          int nIdWorkflow,
                          AdminUser user)
Deprecated. 

returns the state of a given document of the document in the workflow and the user role

Parameters:
nIdResource - the document id
strResourceType - the document type
nIdWorkflow - the workflow id
user - the adminUser
Returns:
the state of a given document

getState

State getState(int nIdResource,
               java.lang.String strResourceType,
               int nIdWorkflow,
               java.lang.Integer nIdExternalParentId,
               AdminUser user)
returns the state of a given document

Parameters:
nIdResource - the resource id
strResourceType - the resource type
nIdWorkflow - the workflow id
nIdExternalParentId - the external parent id
user - The user
Returns:
the state of a given document

isDisplayTasksForm

boolean isDisplayTasksForm(int nIdAction,
                           java.util.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

doProcessAction

@Deprecated
void doProcessAction(int nIdResource,
                                java.lang.String strResourceType,
                                int nIdAction,
                                javax.servlet.http.HttpServletRequest request,
                                java.util.Locale locale,
                                boolean isAutomatic)
Deprecated. 

Proceed action given in parameter

Parameters:
nIdResource - the resource id
strResourceType - the resource type
nIdAction - the action id
request - the request
locale - locale
isAutomatic - true if action is automatic

doProcessAction

void doProcessAction(int nIdResource,
                     java.lang.String strResourceType,
                     int nIdAction,
                     java.lang.Integer nExternalParentId,
                     javax.servlet.http.HttpServletRequest request,
                     java.util.Locale locale,
                     boolean isAutomatic)
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
isAutomatic - true if action is automatic

getDisplayDocumentHistory

java.lang.String getDisplayDocumentHistory(int nIdResource,
                                           java.lang.String strResourceType,
                                           int nIdWorkflow,
                                           javax.servlet.http.HttpServletRequest request,
                                           java.util.Locale locale)
returns the actions history performed on a resource

Parameters:
nIdResource - the resource id
strResourceType - the resource type
nIdWorkflow - the workflow id
request - the request
locale - the locale
Returns:
the history of actions performed on a resource

getDocumentHistoryXml

java.lang.String getDocumentHistoryXml(int nIdResource,
                                       java.lang.String strResourceType,
                                       int nIdWorkflow,
                                       javax.servlet.http.HttpServletRequest request,
                                       java.util.Locale locale)
returns a xml wich contains the actions history performed on a resource

Parameters:
nIdResource - the resource id
strResourceType - the resource type
nIdWorkflow - the workflow id
request - the request
locale - the locale
Returns:
a xml wich contains the history of actions performed on a resource

doSaveTasksForm

@Deprecated
java.lang.String doSaveTasksForm(int nIdResource,
                                            java.lang.String strResourceType,
                                            int nIdAction,
                                            javax.servlet.http.HttpServletRequest request,
                                            java.util.Locale locale)
Deprecated. 

Perform the information on the various tasks associated with the given action specified in parameter

Parameters:
nIdResource - the resource id
strResourceType - the resource type
nIdAction - the action id
request - the request
locale - the locale
Returns:
null if there is no error in the task form else return the error message url

doSaveTasksForm

java.lang.String doSaveTasksForm(int nIdResource,
                                 java.lang.String strResourceType,
                                 int nIdAction,
                                 java.lang.Integer nExternalParentId,
                                 javax.servlet.http.HttpServletRequest request,
                                 java.util.Locale locale)
Perform the information on the various tasks associated with the given action specified in parameter

Parameters:
nIdResource - the resource id
strResourceType - the resource type
nIdAction - the action id
nExternalParentId - the external parent id
request - the request
locale - the locale
Returns:
null if there is no error in the task form else return the error message url

doRemoveWorkFlowResource

void doRemoveWorkFlowResource(int nIdResource,
                              java.lang.String strResourceType)
Remove in all workflows the resource specified in parameter

Parameters:
nIdResource - the resource id
strResourceType - the resource type

doRemoveWorkFlowResourceByListId

void doRemoveWorkFlowResourceByListId(java.util.List<java.lang.Integer> lListIdResource,
                                      java.lang.String strResourceType,
                                      java.lang.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

getDisplayTasksForm

java.lang.String getDisplayTasksForm(int nIdResource,
                                     java.lang.String strResourceType,
                                     int nIdAction,
                                     javax.servlet.http.HttpServletRequest request,
                                     java.util.Locale locale)
returns the tasks form

Parameters:
nIdResource - the document id
strResourceType - the document type
nIdAction - the action id
request - the request
locale - the locale
Returns:
the tasks form associated to the action

isAuthorized

boolean isAuthorized(int nIdResource,
                     java.lang.String strResourceType,
                     int nIdWorkflow,
                     AdminUser user)
Check that a given user is allowed to view a resource depending the state of the resource

Parameters:
nIdResource - the document id
strResourceType - the document type
nIdWorkflow - the workflow id*
user - the AdminUser
Returns:
a list of Action

getAuthorizedResourceList

@Deprecated
java.util.List<java.lang.Integer> getAuthorizedResourceList(java.lang.String strResourceType,
                                                                       int nIdWorkflow,
                                                                       int nIdWorkflowState,
                                                                       AdminUser user)
Deprecated. 

Get all authorized resource Id

Parameters:
strResourceType - the resource type
nIdWorkflow - the workflow id
nIdWorkflowState - The workflow state id
user - the AdminUser
Returns:
a list resource id

getAuthorizedResourceList

java.util.List<java.lang.Integer> getAuthorizedResourceList(java.lang.String strResourceType,
                                                            int nIdWorkflow,
                                                            int nIdWorkflowState,
                                                            java.lang.Integer nExternalParentId,
                                                            AdminUser user)
Get all authorized resource Id

Parameters:
strResourceType - the resource type
nIdWorkflow - the workflow id
nIdWorkflowState - The workflow state id
nExternalParentId - The external parent id
user - the AdminUser
Returns:
The list

getAuthorizedResourceList

java.util.List<java.lang.Integer> getAuthorizedResourceList(java.lang.String strResourceType,
                                                            int nIdWorkflow,
                                                            java.util.List<java.lang.Integer> lListIdWorkflowState,
                                                            java.lang.Integer nExternalParentId,
                                                            AdminUser user)
Get all authorized resource Id

Parameters:
strResourceType - the resource type
nIdWorkflow - the workflow id
lListIdWorkflowState - The list workflow state id
nExternalParentId - he external parent id
user - the AdminUser
Returns:
The list

getWorkflowsEnabled

ReferenceList getWorkflowsEnabled(AdminUser user,
                                  java.util.Locale locale)
return a referencelist wich contains a list enabled workflow

Parameters:
user - the AdminUser
locale - the locale
Returns:
a referencelist wich contains a list enabled workflow

getAllStateByWorkflow

java.util.Collection<State> getAllStateByWorkflow(int nIdWorkflow,
                                                  AdminUser user)
returns all state of a given workflow

Parameters:
nIdWorkflow - the workflow id
user - the adminUser
Returns:
the state of a given document

getListIdRessourceByState

@Deprecated
java.util.Collection<java.lang.Integer> getListIdRessourceByState(int nIdState,
                                                                             java.lang.String strResourceType,
                                                                             AdminUser user)
Deprecated. 

WRONG : need to filter on workflow id return a list witch contains idRessource for a given state

Parameters:
nIdState - the id State
strResourceType - the resource type
user - the AdminUser
Returns:
a list witch contains idRessource

executeActionAutomatic

@Deprecated
void executeActionAutomatic(int nIdResource,
                                       java.lang.String strResourceType,
                                       int nIdWorkflow)
Deprecated. 

Execute action automatic

Parameters:
nIdResource - the document id
strResourceType - the document type
nIdWorkflow - the workflow id

executeActionAutomatic

void executeActionAutomatic(int nIdResource,
                            java.lang.String strResourceType,
                            int nIdWorkflow,
                            java.lang.Integer nExternalParentId)
Execute action automatic

Parameters:
nIdResource - the document id
strResourceType - the document type
nIdWorkflow - the workflow id
nExternalParentId - the external parent id


Copyright © 2011 Mairie de Paris. All Rights Reserved.