Package com.simplicite.bpm

Class Alert

java.lang.Object

com.simplicite.bpm.Alert

All Implemented Interfaces:

java.io.Serializable

public class Alert
extends java.lang.Object
implements java.io.Serializable

Workflow alert management

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static char	ACTION_ACTIVITYCANCEL	Cancel the activity
static char	ACTION_COMPENSATE	Launch the compensation process
static char	ACTION_MESSAGE	Send a message
static char	ACTION_PROCESSCANCEL	Cancel the process
static char	MEDIA_CUSTOM	Custom media
static char	MEDIA_EMAIL	Email media
static char	MEDIA_LOG	Log media
static char	MEDIA_SLACK	Slack media
static char	MEDIA_SMS	SMS media
static char	MEDIA_SOCIAL	Social post media
static char	MEDIA_TRELLO	Trello media
static char	RECIP_BCC	BCC recipient type
static char	RECIP_CC	CC recipient type
static char	RECIP_TO	TO recipient type
static int	TYPE_INFO	Info
static int	TYPE_WARN	Warning

Constructor Summary

Constructors

Constructor	Description
Alert(java.lang.String id, java.lang.String name, int quantity, int delay, java.lang.String action, int type)	Constructor

Method Summary

Modifier and Type	Method	Description
void	addContent(java.lang.String lang, java.lang.String subject, java.lang.String content)	Add a subject and a content for specified language
void	addMedia(char media)	Add a media
void	addRecipient(java.lang.String email, char type)	Add a recipient
java.util.List<java.lang.String>	getAllRecipents()	Get all recipients
java.lang.String	getContent(java.lang.String lang)	Get content for specified language
int	getDelay()	Get delay between 2 retry in minutes
java.lang.String	getId()	Get alert ID
java.lang.String	getName()	Get alert name
int	getQuantity()	Get alert quantity
java.util.List<java.lang.String>	getRecipentBCC()	Get BCC recipients
java.util.List<java.lang.String>	getRecipentCC()	Get CC recipients
java.util.List<java.lang.String>	getRecipentLanguages(Grant g)	Get all languages concerned by the alert
java.util.List<java.lang.String>	getRecipentTO()	Get TO recipients
java.lang.String	getSubject(java.lang.String lang)	Get subject for specified language
int	getType()	Get alert type
boolean	hasRecipient(java.lang.String email, char type)	Has a recipient?
boolean	isActivityCancelEnabled()	Is activity cancelation enabled?
boolean	isCompensationEnabled()	Is compensation enabled?
boolean	isMessageEnabled()	Is message enabled?
boolean	isProcessCancelEnabled()	Is process cancelation enabled?
java.lang.String	prepareText(java.lang.String text, ObjectDB obj)	Prepare text.
void	removeRecipient(java.lang.String email)	Remove a recipient
void	send(ActivityFile context, Grant g)	Activity transition callback
void	send(Processus p, java.lang.String pid, java.lang.String serial, Activity a, java.lang.String step, java.lang.String actName, java.lang.String aid, java.lang.String actSerial, Grant g)	Activity timeout
void	send(Processus p, java.lang.String pid, java.lang.String serial, Grant g)	Process timeout
void	send(ObjectDB obj)	Send the alert from an object.
void	send(ObjectDB obj, java.util.List<DocumentDB> docs)	Send the alert with additional attachments
void	send(java.lang.String subject, java.lang.String body, Grant grant, java.util.List<DocumentDB> docs)	Send the alert on each medias
void	send(java.lang.String subject, java.lang.String body, Grant grant, java.util.List<DocumentDB> docs, ObjectDB target)	Send the alert on each medias
void	setContent(java.lang.String lang, java.lang.String content)	Set content for specified language
void	setRecipentBCC(java.util.List<java.lang.String> bcc)	Set BCC recipients
void	setRecipentCC(java.util.List<java.lang.String> cc)	Set CC recipients
void	setRecipentTO(java.util.List<java.lang.String> to)	Set TO recipients
void	setSubject(java.lang.String lang, java.lang.String subject)	Set subject for specified language
void	setType(int type)	Set alert type

Methods inherited from class java.lang.Object

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

Field Detail

ACTION_MESSAGE

public static final char ACTION_MESSAGE

Send a message

See Also:

Constant Field Values

ACTION_PROCESSCANCEL

public static final char ACTION_PROCESSCANCEL

Cancel the process

See Also:

Constant Field Values

ACTION_ACTIVITYCANCEL

public static final char ACTION_ACTIVITYCANCEL

Cancel the activity

See Also:

Constant Field Values

ACTION_COMPENSATE

public static final char ACTION_COMPENSATE

Launch the compensation process

See Also:

Constant Field Values

TYPE_INFO

public static final int TYPE_INFO

Info

See Also:

Constant Field Values

TYPE_WARN

public static final int TYPE_WARN

Warning

See Also:

Constant Field Values

RECIP_TO

public static final char RECIP_TO

TO recipient type

See Also:

Constant Field Values

RECIP_CC

public static final char RECIP_CC

CC recipient type

See Also:

Constant Field Values

RECIP_BCC

public static final char RECIP_BCC

BCC recipient type

See Also:

Constant Field Values

MEDIA_EMAIL

public static final char MEDIA_EMAIL

Email media

See Also:

Constant Field Values

MEDIA_LOG

public static final char MEDIA_LOG

Log media

See Also:

Constant Field Values

MEDIA_SMS

public static final char MEDIA_SMS

SMS media

See Also:

Constant Field Values

MEDIA_SOCIAL

public static final char MEDIA_SOCIAL

Social post media

See Also:

Constant Field Values

MEDIA_SLACK

public static final char MEDIA_SLACK

Slack media

See Also:

Constant Field Values

MEDIA_TRELLO

public static final char MEDIA_TRELLO

Trello media

See Also:

Constant Field Values

MEDIA_CUSTOM

public static final char MEDIA_CUSTOM

Custom media

See Also:

Constant Field Values

Constructor Detail

Alert

public Alert(java.lang.String id,
             java.lang.String name,
             int quantity,
             int delay,
             java.lang.String action,
             int type)

Constructor

Parameters:

id - Alert id

name - Alert name

quantity - Quantity of retry

delay - Delay between two retry

action - Multi-valued actions (ex: M;P)

type - Info or Warning

Method Detail

isMessageEnabled

public boolean isMessageEnabled()

Is message enabled?

Returns:

True if message is enabled

isProcessCancelEnabled

public boolean isProcessCancelEnabled()

Is process cancelation enabled?

Returns:

True if process cancelation is enabled

isActivityCancelEnabled

public boolean isActivityCancelEnabled()

Is activity cancelation enabled?

Returns:

True if activity cancelation is enabled

isCompensationEnabled

public boolean isCompensationEnabled()

Is compensation enabled?

Returns:

True if compensation is enabled

getId

public java.lang.String getId()

Get alert ID

Returns:

Alret ID

getName

public java.lang.String getName()

Get alert name

Returns:

Alert name

getType

public int getType()

Get alert type

Returns:

Alert type

setType

public void setType(int type)

Set alert type

Parameters:

type - Alert type

getQuantity

public int getQuantity()

Get alert quantity

Returns:

quantity

getDelay

public int getDelay()

Get delay between 2 retry in minutes

Returns:

Delay

getRecipentTO

public java.util.List<java.lang.String> getRecipentTO()

Get TO recipients

Returns:

TO recipient list

getRecipentCC

public java.util.List<java.lang.String> getRecipentCC()

Get CC recipients

Returns:

CC recipient list

getRecipentBCC

public java.util.List<java.lang.String> getRecipentBCC()

Get BCC recipients

Returns:

BSS recipient list

getAllRecipents

public java.util.List<java.lang.String> getAllRecipents()

Get all recipients

Returns:

Recipient list

setRecipentTO

public void setRecipentTO(java.util.List<java.lang.String> to)

Set TO recipients

Parameters:

to - TO recipients list

setRecipentCC

public void setRecipentCC(java.util.List<java.lang.String> cc)

Set CC recipients

Parameters:

cc - CC recipients list

setRecipentBCC

public void setRecipentBCC(java.util.List<java.lang.String> bcc)

Set BCC recipients

Parameters:

bcc - BCC recipients list

hasRecipient

public boolean hasRecipient(java.lang.String email,
                            char type)

Has a recipient?

Parameters:

email - User email

type - RECIP_TO, RECIP_CC or RECIP_BCC

Returns:

Has Recipient

addRecipient

public void addRecipient(java.lang.String email,
                         char type)

Add a recipient

Parameters:

email - user email

type - RECIP_TO, RECIP_CC or RECIP_BCC

removeRecipient

public void removeRecipient(java.lang.String email)

Remove a recipient

Parameters:

email - user email

addMedia

public void addMedia(char media)

Add a media

Parameters:

media - media type

addContent

public void addContent(java.lang.String lang,
                       java.lang.String subject,
                       java.lang.String content)

Add a subject and a content for specified language

Parameters:

lang - Lang

subject - Subject

content - Content

getSubject

public java.lang.String getSubject(java.lang.String lang)

Get subject for specified language

Parameters:

lang - Language

Returns:

Subject

setSubject

public void setSubject(java.lang.String lang,
                       java.lang.String subject)

Set subject for specified language

Parameters:

lang - Language

subject - Subject

getContent

public java.lang.String getContent(java.lang.String lang)

Get content for specified language

Parameters:

lang - Language

Returns:

Content

setContent

public void setContent(java.lang.String lang,
                       java.lang.String content)

Set content for specified language

Parameters:

lang - Language

content - Content

send

public void send(Processus p,
                 java.lang.String pid,
                 java.lang.String serial,
                 Grant g)

Process timeout

Parameters:

p - Process

pid - Process id

serial - serial

g - Grant

send

public void send(Processus p,
                 java.lang.String pid,
                 java.lang.String serial,
                 Activity a,
                 java.lang.String step,
                 java.lang.String actName,
                 java.lang.String aid,
                 java.lang.String actSerial,
                 Grant g)

Activity timeout

Parameters:

p - process

pid - id

serial - serial

a - Activity

step - Step

actName - Activity Name

aid - Activity Id

actSerial - Activity Serial

g - Grant

prepareText

public java.lang.String prepareText(java.lang.String text,
                                    ObjectDB obj)

Prepare text.

Parameters:

text - Text

obj - Object

Returns:

Prepared text

getRecipentLanguages

public java.util.List<java.lang.String> getRecipentLanguages(Grant g)

Get all languages concerned by the alert

Parameters:

g - User's rights

Returns:

All languages concerned by the alert

send

public void send(ObjectDB obj)

Send the alert from an object. State transition callback, State timeout or specific usage.

Parameters:

obj - Selected business object

send

public void send(ObjectDB obj,
                 java.util.List<DocumentDB> docs)

Send the alert with additional attachments

Parameters:

obj - Selected business object

docs - Optional additional documents

send

public void send(ActivityFile context,
                 Grant g)

Activity transition callback

Parameters:

context - ActivityFile

g - Grant

send

public void send(java.lang.String subject,
                 java.lang.String body,
                 Grant grant,
                 java.util.List<DocumentDB> docs)

Send the alert on each medias

Parameters:

subject - Main subject

body - Alert content

grant - User rights

docs - Optional attachments

send

public void send(java.lang.String subject,
                 java.lang.String body,
                 Grant grant,
                 java.util.List<DocumentDB> docs,
                 ObjectDB target)

Send the alert on each medias

Parameters:

subject - Main subject

body - Alert content

grant - User rights

docs - Optional attachments

target - Optional target object