com.sapportals.wcm.service.notificator
Interface INotification

[contained in: com.sap.netweaver.bc.rf.service.par - bc.rf.global.service.notificator_api.jar]

All Known Implementing Classes:

AbstractNotification

public interface INotification

This interface defines the notification s send by a notificator .

A notificaton represents some kind of 'form', e.g. a subscription notification. The layout (content) of this form (notification) might depend on the recipient and channel.
For example: a subscription notification, wich should be send to a german recipient by eMail should have some german html-content, while a subscription notification for an english recipient by SMS should have plain english text.

Copyright 2004 SAP AG

Method Summary

IContent	getContent(IRecipient recipient, IChannel channel, java.util.Properties properties) Get the content (depending on recipient and channel).
java.lang.String	getDescription() Get a displayable name (title).
java.lang.String	getDescription(java.util.Locale locale) Get a displayable name (title) for a specific locale.
java.lang.String	getFromAddress(IChannel channel) Get the 'from' address for a specific channel.
java.lang.String	getID() Get a system id for this notification.

Method Detail

getID

public java.lang.String getID()

Get a system id for this notification. For example 'subscription ' for a subcription notification.

Returns:

String is the system id.

getDescription

public java.lang.String getDescription()

Get a displayable name (title). For example 'Subscription Notification ' for a suscription notification.

Returns:

String is the displayable name.

getDescription

public java.lang.String getDescription(java.util.Locale locale)

Get a displayable name (title) for a specific locale.

Parameters:

locale - TBD: Description of the incoming method parameter

Returns:

String is the displayable name for the given locale.

getFromAddress

public java.lang.String getFromAddress(IChannel channel)

Get the 'from' address for a specific channel.

Parameters:

channel - a IChannel with the channel to get the from address for.

Returns:

a String with from address for the given channel.

getContent

public IContent getContent(IRecipient recipient,
                           IChannel channel,
                           java.util.Properties properties)
                    throws WcmException

Get the content (depending on recipient and channel).

Parameters:

recipient - TBD: Description of the incoming method parameter

channel - TBD: Description of the incoming method parameter

properties - TBD: Description of the incoming method parameter

Returns:

IContent is the content, wich should depend on the specified channel and the given recipient (e.g. content can differ for WAP- and eMail-channels, or it may depend on the receivers locale).

Throws:

WcmException - Exception raised in failure situation