ITaskComponent (Library Workflow Core 1.2.5-SNAPSHOT API)

All Superinterfaces:

org.springframework.beans.factory.InitializingBean

All Known Implementing Classes:

SimpleTaskComponent, TaskComponent
```
public interface ITaskComponent
extends org.springframework.beans.factory.InitializingBean
```
ITaskComponent

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`doSaveConfig(javax.servlet.http.HttpServletRequest request, Locale locale, ITask task)` Perform the task configuration
`String`	`doValidateTask(int nIdResource, String strResourceType, javax.servlet.http.HttpServletRequest request, Locale locale, ITask task)` validates the user input associated to the task
`String`	`getDisplayConfigForm(javax.servlet.http.HttpServletRequest request, Locale locale, ITask task)` Returns the informations which must be displayed in the task configuration
`String`	`getDisplayTaskForm(int nIdResource, String strResourceType, javax.servlet.http.HttpServletRequest request, Locale locale, ITask task)` Returns the informations which must be displayed in the tasks form
`String`	`getDisplayTaskInformation(int nIdHistory, javax.servlet.http.HttpServletRequest request, Locale locale, ITask task)` Return for a document the informations store during processing task
`String`	`getTaskInformationXml(int nIdHistory, javax.servlet.http.HttpServletRequest request, Locale locale, ITask task)` Return a xml which contains for a document the informations store during processing task
`boolean`	`isInvoked(String strKey)` Check if the component is invoked
`void`	`setTaskType(ITaskType taskType)` Set the task type

Methods inherited from interface org.springframework.beans.factory.InitializingBean
afterPropertiesSet

Method Detail

setTaskType
```
void setTaskType(ITaskType taskType)
```
Set the task type

Parameters:

taskType - the task type

isInvoked
```
boolean isInvoked(String strKey)
```
Check if the component is invoked

Parameters:

strKey - the key of the task

Returns:

true if it is invoked, false otherwise

getDisplayTaskForm

String getDisplayTaskForm(int nIdResource,
                          String strResourceType,
                          javax.servlet.http.HttpServletRequest request,
                          Locale locale,
                          ITask task)

Returns the informations which must be displayed in the tasks form

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

getDisplayConfigForm

String getDisplayConfigForm(javax.servlet.http.HttpServletRequest request,
                            Locale locale,
                            ITask task)

Returns the informations which must be displayed in the task configuration

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

getDisplayTaskInformation

String getDisplayTaskInformation(int nIdHistory,
                                 javax.servlet.http.HttpServletRequest request,
                                 Locale locale,
                                 ITask task)

Return for a document the informations store during processing task

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

getTaskInformationXml

String getTaskInformationXml(int nIdHistory,
                             javax.servlet.http.HttpServletRequest request,
                             Locale locale,
                             ITask task)

Return a xml which contains for a document the informations store during processing task

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

doValidateTask

String doValidateTask(int nIdResource,
                      String strResourceType,
                      javax.servlet.http.HttpServletRequest request,
                      Locale locale,
                      ITask task)

validates the user input associated to the task

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

doSaveConfig

String doSaveConfig(javax.servlet.http.HttpServletRequest request,
                    Locale locale,
                    ITask task)

Perform the task configuration

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

Interface ITaskComponent