fr.paris.lutece.plugins.workflow.modules.taskcomment.business
Class TaskComment

java.lang.Object
  extended by fr.paris.lutece.plugins.workflow.business.task.Task
      extended by fr.paris.lutece.plugins.workflow.modules.taskcomment.business.TaskComment
All Implemented Interfaces:
ITask

public class TaskComment
extends Task

TaskComment


Constructor Summary
TaskComment()
           
 
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
 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
 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 idHistory, 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
 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
 
Methods inherited from class fr.paris.lutece.plugins.workflow.business.task.Task
getAction, getId, getTaskType, setAction, setId, setTaskType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TaskComment

public TaskComment()
Method Detail

init

public void init()
Description copied from interface: ITask
Initialize the task


doSaveConfig

public java.lang.String doSaveConfig(javax.servlet.http.HttpServletRequest request,
                                     java.util.Locale locale,
                                     fr.paris.lutece.portal.service.plugin.Plugin plugin)
Description copied from interface: ITask
Perform the task configuration

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

doValidateTask

public 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)
Description copied from interface: ITask
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

getDisplayConfigForm

public java.lang.String getDisplayConfigForm(javax.servlet.http.HttpServletRequest request,
                                             fr.paris.lutece.portal.service.plugin.Plugin plugin,
                                             java.util.Locale locale)
Description copied from interface: ITask
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

getDisplayTaskForm

public 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)
Description copied from interface: ITask
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

getDisplayTaskInformation

public java.lang.String getDisplayTaskInformation(int nIdHistory,
                                                  javax.servlet.http.HttpServletRequest request,
                                                  fr.paris.lutece.portal.service.plugin.Plugin plugin,
                                                  java.util.Locale locale)
Description copied from interface: ITask
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

processTask

public void processTask(int nIdResourceHistory,
                        javax.servlet.http.HttpServletRequest request,
                        fr.paris.lutece.portal.service.plugin.Plugin plugin,
                        java.util.Locale locale)
Description copied from interface: ITask
Process the task

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

doRemoveConfig

public void doRemoveConfig(fr.paris.lutece.portal.service.plugin.Plugin plugin)
Description copied from interface: ITask
Remove the task configuration

Parameters:
plugin - plugin

isConfigRequire

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

isFormTaskRequire

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

doRemoveTaskInformation

public void doRemoveTaskInformation(int nIdHistory,
                                    fr.paris.lutece.portal.service.plugin.Plugin plugin)
Description copied from interface: ITask
remove taskInformation associate to the history

Parameters:
nIdHistory - the document id
plugin - plugin

getTaskInformationXml

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

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

getTitle

public java.lang.String getTitle(fr.paris.lutece.portal.service.plugin.Plugin plugin,
                                 java.util.Locale locale)
Description copied from interface: ITask
returns the task title

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

getTaskFormEntries

public fr.paris.lutece.util.ReferenceList getTaskFormEntries(fr.paris.lutece.portal.service.plugin.Plugin plugin,
                                                             java.util.Locale locale)
Description copied from interface: ITask
returns the entries of the task form

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

isTaskForActionAutomatic

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


Copyright © 2012 Mairie de Paris. All Rights Reserved.