public interface INotificatorService extends IService
A notificator allows the sending of notification s to a recipient
via a given channel .
A notification represents some kind of message (e.g. a html-text). A
recipient is a destination (e.g. a person) to send the message to. The
channel specifies the transport mechanism to use (e.g. eMail).
Copyright 2004 SAP AG
Modifier and Type | Field and Description |
---|---|
static String |
ARCHIVING_APPROVAL_NOTIFICATION
id for ARCHIVING approval notificiation: a resource was submitted for archiving and the receiver has to approve.
|
static String |
ARCHIVING_CANCEL_APPROVAL_NOTIFICATION
id for ARCHIVING cancel approval notificiation:
|
static String |
ARCHIVING_FORCE_NOTIFICATION
id for ARCHIVING force approval notificiation:
|
static String |
ARCHIVING_NOTIFICATION
id for ARCHIVING notificiation: a resource was marked for archiving.
|
static String |
CUSTOM_PARAMETERS_TAG
id for custom parameters which are stored into configuration
|
static String |
ENCODING_DEFAULT
default encoding to use, when transforming Streams into Strings.
|
static String |
FILTERSCRIPT_NOTIFICATION
id for Filter Script notifications
|
static String |
NOTIFICATOR_SERVICE
Service ID
|
static String |
SUBSCRIPTION_NOTIFICATION
id for SUBSCRIPTION notificiation: a subscription generated an event.
|
static String |
SUBSCRIPTIONADMIN_NOTIFICATION
id for SUBSCRIPTIONADMIN notification: a subscription was created/deleted
or resources have been added to / removed from a subscription.
|
static String |
SUBSCRIPTIONBUNDLED_NOTIFICATION
id for SUBSCRIPTIONBUNDLED notificiation: a polling event trigged one or
more notifications.
|
static String |
WORKFLOW_NOTIFICATION
id for WORKFLOW notification: a document state changed and someone has to
do something (a workflow task is started)...
|
static String |
WORKFLOWRESULT_NOTIFICATION
id for WORKFLOWRESULT notification: someone did something with a workflow
document (a workflow task is completed).
|
Modifier and Type | Method and Description |
---|---|
Collection |
getChannels()
Get a list of available channels for this notificator.
|
String |
getDefaultFromAddress(IChannel channel)
Get the default from address for a channel.
|
void |
send(IRecipient recipient,
IChannel channel,
INotification notification)
Send a notification to a recipient via the specified channel.
|
void |
send(IRecipientList recipients,
IChannel channel,
INotification notification)
Send a notification to a list of recipients via the specified channel.
|
getDescription, getDescription, getID
static final String NOTIFICATOR_SERVICE
static final String ENCODING_DEFAULT
static final String ARCHIVING_NOTIFICATION
static final String ARCHIVING_APPROVAL_NOTIFICATION
static final String ARCHIVING_FORCE_NOTIFICATION
static final String ARCHIVING_CANCEL_APPROVAL_NOTIFICATION
static final String SUBSCRIPTION_NOTIFICATION
static final String SUBSCRIPTIONBUNDLED_NOTIFICATION
static final String SUBSCRIPTIONADMIN_NOTIFICATION
static final String WORKFLOW_NOTIFICATION
static final String WORKFLOWRESULT_NOTIFICATION
static final String CUSTOM_PARAMETERS_TAG
static final String FILTERSCRIPT_NOTIFICATION
Collection getChannels() throws WcmException
Collection
is a list of IChannel
s with
the valid channels for this notificator.WcmException
- Exception raised in failure situationWcmException
- if the list of channels can't be
retrieved.void send(IRecipient recipient, IChannel channel, INotification notification) throws WcmException
recipient
- a IRecipient
to send the notification to.channel
- a IChannel
to use for sending the notification.notification
- a INotification
to send.WcmException
- Exception raised in failure situationWcmException
- if the notification could not be sent.void send(IRecipientList recipients, IChannel channel, INotification notification) throws WcmException
recipients
- a IRecipientList
with recipients to send the notification to.channel
- a IChannel
to use for sending the notification.notification
- a INotification
to send.WcmException
- WcmExceptionString getDefaultFromAddress(IChannel channel) throws WcmException
channel
- a IChannel
to get the address for.String
with the from address for the given channel.WcmException
- Exception raised in failure situationAccess Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] KMC-CM
|
[sap.com] tc/km/frwk
|
api
|
EP-KM-CM
|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
Copyright 2018 SAP AG Complete Copyright Notice