fr.paris.lutece.plugins.workflow.business.task
Interface ITask

All Known Implementing Classes:
Task, TaskAssignment, TaskComment, TaskNotification

public interface ITask

ITask


Method Summary
 void doRemoveConfig(fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Remove the task configuration
 void doRemoveTaskInformation(int nIdHistory, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          remove taskInformation associate to the history
 java.lang.String doSaveConfig(javax.servlet.http.HttpServletRequest request, java.util.Locale locale, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Perform the task configuration
 java.lang.String doValidateTask(int nIdResource, java.lang.String strResourceType, javax.servlet.http.HttpServletRequest request, java.util.Locale locale, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          validates the user input associated to the task
 fr.paris.lutece.portal.business.workflow.Action getAction()
           
 java.lang.String getDisplayConfigForm(javax.servlet.http.HttpServletRequest request, fr.paris.lutece.portal.service.plugin.Plugin plugin, java.util.Locale locale)
          returns the informations which must be displayed in the task configuration
 java.lang.String getDisplayTaskForm(int nIdResource, java.lang.String strResourceType, javax.servlet.http.HttpServletRequest request, fr.paris.lutece.portal.service.plugin.Plugin plugin, java.util.Locale locale)
          returns the informations which must be displayed in the tasks form
 java.lang.String getDisplayTaskInformation(int nIdHistory, javax.servlet.http.HttpServletRequest request, fr.paris.lutece.portal.service.plugin.Plugin plugin, java.util.Locale locale)
          return for a document the informations store during processing task
 int getId()
           
 fr.paris.lutece.util.ReferenceList getTaskFormEntries(fr.paris.lutece.portal.service.plugin.Plugin plugin, java.util.Locale locale)
          returns the entries of the task form
 java.lang.String getTaskInformationXml(int nIdHistory, javax.servlet.http.HttpServletRequest request, fr.paris.lutece.portal.service.plugin.Plugin plugin, java.util.Locale locale)
          return a xml wich contains for a document the informations store during processing task
 ITaskType getTaskType()
           
 java.lang.String getTitle(fr.paris.lutece.portal.service.plugin.Plugin plugin, java.util.Locale locale)
          returns the task title
 void init()
          Initialize the task
 boolean isConfigRequire()
           
 boolean isFormTaskRequire()
           
 boolean isTaskForActionAutomatic()
           
 void processTask(int nIdResourceHistory, javax.servlet.http.HttpServletRequest request, fr.paris.lutece.portal.service.plugin.Plugin plugin, java.util.Locale locale)
          Process the task
 void setAction(fr.paris.lutece.portal.business.workflow.Action action)
          set the action associate to the task
 void setId(int nId)
          set the task id
 void setTaskType(ITaskType taskType)
          set the TaskType object
 

Method Detail

getId

int getId()
Returns:
the task Id

setId

void setId(int nId)
set the task id

Parameters:
nId - the task id

getTaskType

ITaskType getTaskType()
Returns:
the TaskType Object

setTaskType

void setTaskType(ITaskType taskType)
set the TaskType object

Parameters:
taskType - the task type object

getAction

fr.paris.lutece.portal.business.workflow.Action getAction()
Returns:
the action associate to the task

setAction

void setAction(fr.paris.lutece.portal.business.workflow.Action action)
set the action associate to the task

Parameters:
action - the action associate to the task

processTask

void processTask(int nIdResourceHistory,
                 javax.servlet.http.HttpServletRequest request,
                 fr.paris.lutece.portal.service.plugin.Plugin plugin,
                 java.util.Locale locale)
Process the task

Parameters:
nIdResourceHistory - the resource history id
request - the request
plugin - plugin
locale - locale

doValidateTask

java.lang.String doValidateTask(int nIdResource,
                                java.lang.String strResourceType,
                                javax.servlet.http.HttpServletRequest request,
                                java.util.Locale locale,
                                fr.paris.lutece.portal.service.plugin.Plugin plugin)
validates the user input associated to the task

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

getDisplayTaskForm

java.lang.String getDisplayTaskForm(int nIdResource,
                                    java.lang.String strResourceType,
                                    javax.servlet.http.HttpServletRequest request,
                                    fr.paris.lutece.portal.service.plugin.Plugin plugin,
                                    java.util.Locale locale)
returns the informations which must be displayed in the tasks form

Parameters:
nIdResource - the resource id
strResourceType - the resource type
request - request
plugin - plugin
locale - locale
Returns:
the information which must be displayed in the tasks form

getDisplayConfigForm

java.lang.String getDisplayConfigForm(javax.servlet.http.HttpServletRequest request,
                                      fr.paris.lutece.portal.service.plugin.Plugin plugin,
                                      java.util.Locale locale)
returns the informations which must be displayed in the task configuration

Parameters:
request - request
plugin - plugin
locale - locale
Returns:
the information which must be displayed in the task configuration

doSaveConfig

java.lang.String doSaveConfig(javax.servlet.http.HttpServletRequest request,
                              java.util.Locale locale,
                              fr.paris.lutece.portal.service.plugin.Plugin plugin)
Perform the task configuration

Parameters:
request - request
locale - locale
plugin - plugin
Returns:
the url to go after perform task configuration

getDisplayTaskInformation

java.lang.String getDisplayTaskInformation(int nIdHistory,
                                           javax.servlet.http.HttpServletRequest request,
                                           fr.paris.lutece.portal.service.plugin.Plugin plugin,
                                           java.util.Locale locale)
return for a document the informations store during processing task

Parameters:
nIdHistory - the document id
request - the request
plugin - the plugin
locale - locale
Returns:
the informations store during processing task

getTaskInformationXml

java.lang.String getTaskInformationXml(int nIdHistory,
                                       javax.servlet.http.HttpServletRequest request,
                                       fr.paris.lutece.portal.service.plugin.Plugin plugin,
                                       java.util.Locale locale)
return a xml wich contains for a document the informations store during processing task

Parameters:
nIdHistory - the document id
request - the request
plugin - the plugin
locale - locale
Returns:
the informations store during processing task

doRemoveTaskInformation

void doRemoveTaskInformation(int nIdHistory,
                             fr.paris.lutece.portal.service.plugin.Plugin plugin)
remove taskInformation associate to the history

Parameters:
nIdHistory - the document id
plugin - plugin

doRemoveConfig

void doRemoveConfig(fr.paris.lutece.portal.service.plugin.Plugin plugin)
Remove the task configuration

Parameters:
plugin - plugin

isConfigRequire

boolean isConfigRequire()
Returns:
true if the task use a configuration

isFormTaskRequire

boolean isFormTaskRequire()
Returns:
true if the task use a form

getTitle

java.lang.String getTitle(fr.paris.lutece.portal.service.plugin.Plugin plugin,
                          java.util.Locale locale)
returns the task title

Parameters:
plugin - plugin
locale - locale
Returns:
the task title

getTaskFormEntries

fr.paris.lutece.util.ReferenceList getTaskFormEntries(fr.paris.lutece.portal.service.plugin.Plugin plugin,
                                                      java.util.Locale locale)
returns the entries of the task form

Parameters:
plugin - plugin
locale - locale
Returns:
the entries of the task form

isTaskForActionAutomatic

boolean isTaskForActionAutomatic()
Returns:
true if the task may be use by automatic action

init

void init()
Initialize the task



Copyright © 2012 Mairie de Paris. All Rights Reserved.