|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
---|
int getId()
void setId(int nId)
nId
- the task idITaskType getTaskType()
void setTaskType(ITaskType taskType)
taskType
- the task type objectfr.paris.lutece.portal.business.workflow.Action getAction()
void setAction(fr.paris.lutece.portal.business.workflow.Action action)
action
- the action associate to the taskvoid processTask(int nIdResourceHistory, javax.servlet.http.HttpServletRequest request, fr.paris.lutece.portal.service.plugin.Plugin plugin, java.util.Locale locale)
nIdResourceHistory
- the resource history idrequest
- the requestplugin
- pluginlocale
- localejava.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)
nIdResource
- the resource idstrResourceType
- the resource typerequest
- requestlocale
- localeplugin
- the plugin
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)
nIdResource
- the resource idstrResourceType
- the resource typerequest
- requestplugin
- pluginlocale
- locale
java.lang.String getDisplayConfigForm(javax.servlet.http.HttpServletRequest request, fr.paris.lutece.portal.service.plugin.Plugin plugin, java.util.Locale locale)
request
- requestplugin
- pluginlocale
- locale
java.lang.String doSaveConfig(javax.servlet.http.HttpServletRequest request, java.util.Locale locale, fr.paris.lutece.portal.service.plugin.Plugin plugin)
request
- requestlocale
- localeplugin
- plugin
java.lang.String getDisplayTaskInformation(int nIdHistory, javax.servlet.http.HttpServletRequest request, fr.paris.lutece.portal.service.plugin.Plugin plugin, java.util.Locale locale)
nIdHistory
- the document idrequest
- the requestplugin
- the pluginlocale
- locale
java.lang.String getTaskInformationXml(int nIdHistory, javax.servlet.http.HttpServletRequest request, fr.paris.lutece.portal.service.plugin.Plugin plugin, java.util.Locale locale)
nIdHistory
- the document idrequest
- the requestplugin
- the pluginlocale
- locale
void doRemoveTaskInformation(int nIdHistory, fr.paris.lutece.portal.service.plugin.Plugin plugin)
nIdHistory
- the document idplugin
- pluginvoid doRemoveConfig(fr.paris.lutece.portal.service.plugin.Plugin plugin)
plugin
- pluginboolean isConfigRequire()
boolean isFormTaskRequire()
java.lang.String getTitle(fr.paris.lutece.portal.service.plugin.Plugin plugin, java.util.Locale locale)
plugin
- pluginlocale
- locale
fr.paris.lutece.util.ReferenceList getTaskFormEntries(fr.paris.lutece.portal.service.plugin.Plugin plugin, java.util.Locale locale)
plugin
- pluginlocale
- locale
boolean isTaskForActionAutomatic()
void init()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |