org.openlowcode.server.data.workflowhelper

Class WorkflowCommons

java.lang.Object

org.openlowcode.server.data.workflowhelper.WorkflowCommons

public class WorkflowCommons
extends java.lang.Object

This class gathers procedures that are common to the different types of workflow in the application.

Author:

Open Lowcode SAS

Constructor Summary

Constructors

Constructor and Description
WorkflowCommons()

Method Summary

Modifier and Type	Method and Description
static void	assignTaskToAuthority(Task task, DataObjectId<Authority> authorityid, DataObjectId<Appuser> usertoexclude, java.lang.String emailtype, java.lang.String emailname, java.lang.String title, java.lang.String body, java.lang.String objectid, java.lang.String objectlabel, DataObjectId<Appuser> originator, DataObject<?> object) assigns a task to an authority
static void	assignTaskToUser(Task task, DataObjectId<Appuser> specificuser, java.lang.String emailtype, java.lang.String title, java.lang.String body, java.lang.String objectid, java.lang.String objectlabel, DataObjectId<Appuser> originator, java.lang.String notificationname, DataObject<?> object) assigns tasks to a user
static java.lang.String	generateObjectId(DataObject<?> object) generates a readable object id (number) if possible
static java.lang.String	generateObjectString(DataObject<?> object) generates a string identifying the object.
static void	sendNotification(java.lang.String title, java.lang.String bodytext, java.lang.String objectid, java.lang.String objectlabel, DataObjectId<Appuser> senderuserid, java.util.ArrayList<DataObjectId<Appuser>> users, java.lang.String emailtype, java.lang.String notificationname, java.lang.String modulename, boolean action) sends an e-mail notification for a workflow

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowCommons

public WorkflowCommons()

Method Detail

sendNotification

public static void sendNotification(java.lang.String title,
                                    java.lang.String bodytext,
                                    java.lang.String objectid,
                                    java.lang.String objectlabel,
                                    DataObjectId<Appuser> senderuserid,
                                    java.util.ArrayList<DataObjectId<Appuser>> users,
                                    java.lang.String emailtype,
                                    java.lang.String notificationname,
                                    java.lang.String modulename,
                                    boolean action)

sends an e-mail notification for a workflow

Parameters:

title - title of the notification

bodytext - body text

objectid - id of the object

objectlabel - label of the object

senderuserid - id of the user who sent the mail

users - users to the send e-mail to

emailtype - e-mail type

notificationname - name of notification

modulename - name of module

action - true if the e-mail if for action

assignTaskToUser

public static void assignTaskToUser(Task task,
                                    DataObjectId<Appuser> specificuser,
                                    java.lang.String emailtype,
                                    java.lang.String title,
                                    java.lang.String body,
                                    java.lang.String objectid,
                                    java.lang.String objectlabel,
                                    DataObjectId<Appuser> originator,
                                    java.lang.String notificationname,
                                    DataObject<?> object)

assigns tasks to a user

Parameters:

task - task to send

specificuser - user to send the task to

emailtype - type of e-mail

title - title of the e-mail

body - body of the e-mail

objectid - id of the object

objectlabel - label of the object

originator - originator of the task

notificationname - name of the notification

object - data object subject of the workflow

assignTaskToAuthority

public static void assignTaskToAuthority(Task task,
                                         DataObjectId<Authority> authorityid,
                                         DataObjectId<Appuser> usertoexclude,
                                         java.lang.String emailtype,
                                         java.lang.String emailname,
                                         java.lang.String title,
                                         java.lang.String body,
                                         java.lang.String objectid,
                                         java.lang.String objectlabel,
                                         DataObjectId<Appuser> originator,
                                         DataObject<?> object)

assigns a task to an authority

Parameters:

task - task

authorityid - id of the authority

usertoexclude - user to exclude. Typically, this happens when an user rejects a task, it is sent back to the group, with exception of the user having just rejected the task

emailtype - type of e-mail for notification

emailname - name of the e-mail

title - title of the e-mail

body - body of the e-mail

objectid - id of the object

objectlabel - label of the object

originator - originator for notification e-mail

object - data object the workflow is working on

generateObjectString

public static java.lang.String generateObjectString(DataObject<?> object)

generates a string identifying the object. This is typically number + name

Parameters:

object - the object to process

Returns:

the best object short string

generateObjectId

public static java.lang.String generateObjectId(DataObject<?> object)

generates a readable object id (number) if possible

Parameters:

object - data object

Returns:

the best object id available