|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.alfresco.service.cmr.notification.NotificationContext
public class NotificationContext
Notification context. Provides the contextual information about a notification.
Constructor Summary | |
---|---|
NotificationContext()
Default constructor |
Method Summary | |
---|---|
void |
addTo(java.lang.String to)
|
java.lang.String |
getBody()
|
org.alfresco.service.cmr.repository.NodeRef |
getBodyTemplate()
|
org.alfresco.service.cmr.repository.NodeRef |
getDocument()
|
java.lang.String |
getFrom()
|
java.lang.String |
getSubject()
|
java.util.Map |
getTemplateArgs()
|
java.util.List |
getTo()
|
boolean |
isAsyncNotification()
|
boolean |
isIgnoreNotificationFailure()
|
void |
setAsyncNotification(boolean asyncNotification)
Indicates whether the notification will be sent asynchronously or not. |
void |
setBody(java.lang.String body)
Note: this takes presendence over the body template if both are set |
void |
setBodyTemplate(org.alfresco.service.cmr.repository.NodeRef bodyTemplate)
The body template is a node reference to a template that can be executed with the given template arguments to produce the body of the notification. |
void |
setDocument(org.alfresco.service.cmr.repository.NodeRef document)
Document that the notification relates to. |
void |
setFrom(java.lang.String from)
|
void |
setIgnoreNotificationFailure(boolean ignoreNotificationFailure)
Indicates whether to ignore a notification failure or not. |
void |
setSubject(java.lang.String subject)
|
void |
setTemplateArgs(java.util.Map templateArgs)
The template arguments are used as context for the body template when it is executed. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public NotificationContext()
Method Detail |
---|
public void setFrom(java.lang.String from)
from
- from authoritypublic java.lang.String getFrom()
String
from authoritypublic void addTo(java.lang.String to)
to
- to authoritiespublic java.util.List getTo()
List
<String
> to authoritiespublic void setSubject(java.lang.String subject)
subject
- subject of notificationpublic java.lang.String getSubject()
public void setBody(java.lang.String body)
body
- body of notification.public java.lang.String getBody()
String
body of notificationpublic void setBodyTemplate(org.alfresco.service.cmr.repository.NodeRef bodyTemplate)
bodyTemplate
- body templatepublic org.alfresco.service.cmr.repository.NodeRef getBodyTemplate()
NodeRef
body templatepublic void setTemplateArgs(java.util.Map templateArgs)
templateArgs
- template argumentspublic java.util.Map getTemplateArgs()
Map
<String
, Serializable
> template argumentspublic void setDocument(org.alfresco.service.cmr.repository.NodeRef document)
document
- related documentpublic org.alfresco.service.cmr.repository.NodeRef getDocument()
NodeRef
related documentpublic void setIgnoreNotificationFailure(boolean ignoreNotificationFailure)
ignoreNotificationFailure
- true if ignore notification failure, false otherwisepublic boolean isIgnoreNotificationFailure()
public void setAsyncNotification(boolean asyncNotification)
asyncNotification
- true if notification sent asynchronously, false otherwisepublic boolean isAsyncNotification()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |