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 activitystatic char
ACTION_COMPENSATE
Launch the compensation processstatic char
ACTION_MESSAGE
Send a messagestatic char
ACTION_PROCESSCANCEL
Cancel the processstatic char
MEDIA_EMAIL
static char
MEDIA_LOG
static char
MEDIA_SMS
static char
RECIP_BCC
BCC recipient typestatic char
RECIP_CC
CC recipient typestatic char
RECIP_TO
TO recipient typestatic int
TYPE_INFO
Infostatic 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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addContent(java.lang.String lang, java.lang.String subject, java.lang.String content)
Add a content (HTML body)void
addMedia(char media)
Add a mediavoid
addRecipient(java.lang.String email, char type)
Add a recipientjava.util.List<java.lang.String>
getAllRecipents()
java.lang.String
getContent(java.lang.String lang)
int
getDelay()
Get delay between 2 retry in minutesjava.lang.String
getId()
Alert idjava.lang.String
getName()
Alert nameint
getQuantity()
Get alert quantityjava.util.List<java.lang.String>
getRecipentBCC()
java.util.List<java.lang.String>
getRecipentCC()
java.util.List<java.lang.String>
getRecipentLanguages(Grant g)
Get all languages concerned by the alertjava.util.List<java.lang.String>
getRecipentTO()
java.lang.String
getSubject(java.lang.String lang)
int
getType()
Alert typeboolean
hasRecipient(java.lang.String email, char type)
Has a recipient?boolean
isActivityCancelEnabled()
boolean
isCompensationEnabled()
boolean
isMessageEnabled()
boolean
isProcessCancelEnabled()
java.lang.String
prepareText(java.lang.String text, ObjectDB obj)
Prepare text.void
removeRecipient(java.lang.String email)
Remove a recipientvoid
send(ActivityFile context, Grant g)
Activity transition callbackvoid
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 timeoutvoid
send(Processus p, java.lang.String pid, java.lang.String serial, Grant g)
Process timeoutvoid
send(ObjectDB obj)
Send the alert from an object.void
send(ObjectDB obj, java.util.List<DocumentDB> docs)
Send the alert with additional attachmentsvoid
send(java.lang.String subject, java.lang.String body, Grant grant, java.util.List<DocumentDB> docs)
Send the alert on each mediasvoid
setContent(java.lang.String lang, java.lang.String text)
void
setRecipentBCC(java.util.List<java.lang.String> bcc)
void
setRecipentCC(java.util.List<java.lang.String> cc)
void
setRecipentTO(java.util.List<java.lang.String> to)
void
setSubject(java.lang.String lang, java.lang.String subject)
void
setType(int type)
-
-
-
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
- See Also:
- Constant Field Values
-
MEDIA_LOG
public static final char MEDIA_LOG
- See Also:
- Constant Field Values
-
MEDIA_SMS
public static final char MEDIA_SMS
- 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 idname
- Alert namequantity
- Quantity of retrydelay
- Delay between two retryaction
- Multi-valued actions (ex: M;P)type
- Info or Warning
-
-
Method Detail
-
isMessageEnabled
public boolean isMessageEnabled()
-
isProcessCancelEnabled
public boolean isProcessCancelEnabled()
-
isActivityCancelEnabled
public boolean isActivityCancelEnabled()
-
isCompensationEnabled
public boolean isCompensationEnabled()
-
getId
public java.lang.String getId()
Alert id- Returns:
- id
-
getName
public java.lang.String getName()
Alert name- Returns:
- name
-
getType
public int getType()
Alert type- Returns:
- type
-
setType
public void setType(int 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()
-
getRecipentCC
public java.util.List<java.lang.String> getRecipentCC()
-
getRecipentBCC
public java.util.List<java.lang.String> getRecipentBCC()
-
getAllRecipents
public java.util.List<java.lang.String> getAllRecipents()
-
setRecipentTO
public void setRecipentTO(java.util.List<java.lang.String> to)
-
setRecipentCC
public void setRecipentCC(java.util.List<java.lang.String> cc)
-
setRecipentBCC
public void setRecipentBCC(java.util.List<java.lang.String> bcc)
-
hasRecipient
public boolean hasRecipient(java.lang.String email, char type)
Has a recipient?- Parameters:
email
- User emailtype
- 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 emailtype
- 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 content (HTML body)- Parameters:
lang
- Langsubject
- Subjectcontent
- Content
-
getSubject
public java.lang.String getSubject(java.lang.String lang)
-
setSubject
public void setSubject(java.lang.String lang, java.lang.String subject)
-
getContent
public java.lang.String getContent(java.lang.String lang)
-
setContent
public void setContent(java.lang.String lang, java.lang.String text)
-
send
public void send(Processus p, java.lang.String pid, java.lang.String serial, Grant g)
Process timeout- Parameters:
p
- Processuspid
- Processus idserial
- serialg
- 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
- processuspid
- idserial
- seriala
- Activitystep
- StepactName
- Activity Nameaid
- Activity IdactSerial
- Activity Serialg
- Grant
-
prepareText
public java.lang.String prepareText(java.lang.String text, ObjectDB obj)
Prepare text.- Parameters:
text
- Textobj
- 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 objectdocs
- Optional additional documents
-
send
public void send(ActivityFile context, Grant g)
Activity transition callback- Parameters:
context
- ActivityFileg
- 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 subjectbody
- Alert contentgrant
- User rightsdocs
- Attachments
-
-