org.openlowcode.design.data.properties.workflow

Class UserTask

java.lang.Object

org.openlowcode.design.data.properties.workflow.WorkflowStep

org.openlowcode.design.data.properties.workflow.UserTask

public class UserTask
extends WorkflowStep

A user task is a workflow step where the user will make a choice on the workflow

Author:

Open Lowcode SAS

Constructor Summary

Constructors

Constructor and Description
UserTask(ComplexWorkflow parent, java.lang.String code, java.lang.String title, java.lang.String taskmessage, int delay, boolean delayindays, boolean notifyrecipientbymail, TaskUserSelector selector) creates a user task

Method Summary

Modifier and Type	Method and Description
UserTaskChoice	getChoiceAtIndex(int index) the task choice at the given index
java.lang.String	getCode() get the task code
int	getDelay()
int	getTaskChoiceNumber()
java.lang.String	gettaskid()
java.lang.String	getTaskmessage()
java.lang.String	getTitle()
TaskUserSelector	getUserSelector()
boolean	isDelayInDays()
void	registerToParentWorkflow() register the step in the parent workflow
void	setUserTaskChoice(UserTaskChoice taskchoice, WorkflowStep nextstep) sets a possible choice and associated next steps
void	writedeclaration(SourceGenerator sg, Module module, java.lang.String parentclass, java.lang.String lifecycleclass)
void	writeimport(SourceGenerator sg, Module module) writes the import for this workflow step
void	writeNextSteps(SourceGenerator sg, Module module) a recursive method writing the source code for the next steps of the workflow

Methods inherited from class org.openlowcode.design.data.properties.workflow.WorkflowStep

getParent, setSequence

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserTask

public UserTask(ComplexWorkflow parent,
                java.lang.String code,
                java.lang.String title,
                java.lang.String taskmessage,
                int delay,
                boolean delayindays,
                boolean notifyrecipientbymail,
                TaskUserSelector selector)

creates a user task

Parameters:

parent - the parent workflow

code - code of the user task (should be unique)

title - title of the task

taskmessage - the task message that will be displayed. It can potentially be rich-text using Open Lowcode rich-text language

delay - number of units (see below delayindays) for delay before task is considered late

delayindays - if true, delay is expressed in days, else in minutes

notifyrecipientbymail - if true, recipients will receive an e-mail (not: probably not used)

selector - a selector of the users the task should be sent to

Method Detail

gettaskid

public java.lang.String gettaskid()

Overrides:

gettaskid in class WorkflowStep

Returns:

the task id (based on the provided sequence)

getUserSelector

public TaskUserSelector getUserSelector()

Returns:

the task selector (determines next steps depending on user choice)

getDelay

public int getDelay()

Returns:

delay for the task

isDelayInDays

public boolean isDelayInDays()

Returns:

true if delay is in days, false if delay is in minutes

getTaskmessage

public java.lang.String getTaskmessage()

Returns:

get the task message (can be several lines)

getTitle

public java.lang.String getTitle()

Returns:

get the task title

getTaskChoiceNumber

public int getTaskChoiceNumber()

Returns:

the number of task choices

getChoiceAtIndex

public UserTaskChoice getChoiceAtIndex(int index)

the task choice at the given index

Parameters:

index - a number between 0 (included) and getTaskChoiceNumber (excluded)

Returns:

the task choice at the given index

setUserTaskChoice

public void setUserTaskChoice(UserTaskChoice taskchoice,
                              WorkflowStep nextstep)

sets a possible choice and associated next steps

Parameters:

taskchoice - task choice presented to the user

nextstep - next step for this choice

getCode

public java.lang.String getCode()

get the task code

Returns:

the task code

registerToParentWorkflow

public void registerToParentWorkflow()

Description copied from class: WorkflowStep

register the step in the parent workflow

Overrides:

registerToParentWorkflow in class WorkflowStep

writeimport

public void writeimport(SourceGenerator sg,
                        Module module)
                 throws java.io.IOException

Description copied from class: WorkflowStep

writes the import for this workflow step

Specified by:

writeimport in class WorkflowStep

Parameters:

sg - sourcce generator

module - parent module

Throws:

java.io.IOException - if anything bad happens in the workflow

writedeclaration

public void writedeclaration(SourceGenerator sg,
                             Module module,
                             java.lang.String parentclass,
                             java.lang.String lifecycleclass)
                      throws java.io.IOException

Specified by:

writedeclaration in class WorkflowStep

Throws:

java.io.IOException

writeNextSteps

public void writeNextSteps(SourceGenerator sg,
                           Module module)
                    throws java.io.IOException

Description copied from class: WorkflowStep

a recursive method writing the source code for the next steps of the workflow

Specified by:

writeNextSteps in class WorkflowStep

Parameters:

sg - source generator

module - parent module

Throws:

java.io.IOException - if anything bad happens in the workflow