com.webmethods.portal.mech.subscription

Class NotificationHelper

java.lang.Object

com.webmethods.portal.mech.subscription.NotificationHelper

public class NotificationHelper
extends Object

This helper class is used to facilitate notification body rendering. It is always available in the page context under "helper" name.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_NOTIFICATION_SKIN
protected static Locale	EMPTY_LOCALE
protected IDigestDeliveryEvent	m_digestEvent
protected String	m_frontEndURL
protected DateFormat	m_fullDateFormat
protected String	m_language
protected Locale	m_locale
protected INotificationSourceEvent	m_notEvent
protected IThingID	m_oldParentID
protected String	m_oldParentName
protected String	m_oldParentURL
protected IThingID	m_parentID
protected String	m_parentName
protected String	m_parentURL
protected IPortalEvent	m_portalEvent
protected DateFormat	m_shortDateFormat
protected IThingID	m_skinID
protected String	m_thingDescription
protected IThingID	m_thingID
protected String	m_thingName
protected String	m_thingType
protected String	m_thingURL
protected String	m_time
protected String	m_userName
protected String	m_userURL
protected String	m_webServer

Constructor Summary

Constructors

Constructor and Description
NotificationHelper()
NotificationHelper(INotificationSourceEvent event, Locale locale)

Method Summary

Modifier and Type	Method and Description
int	getDeliveryModes()
String	getFrontEndURL()
DateFormat	getFullDateFormat()
Locale	getLocale()
String	getLocalizedMessage(Class<? extends ResourceBundle> bundleClass, String key, Object[] args)
String	getLocalizedMessage(String key, Object[] args)
INotificationSourceEvent	getNotificationSourceEvent()
String	getOldParentName() Null if old parent not applicable / does not exist.
String	getOldParentURL() Null if old parent is not de-referenceable.
String	getParentName() Null if parent not applicable / does not exist.
String	getParentURL() Null if parent is not de-referenceable.
DateFormat	getShortDateFormat()
IThingID	getSkinID()
String	getSkinProperty(String name)
List<IPortalEvent>	getSourceEvents()
String	getSystemTitle()
String	getThingDescription() Null if thing has no description.
String	getThingDescription(IThing thing)
String	getThingName()
String	getThingName(IThing thing)
String	getThingType()
String	getThingURL() Null if thing is not de-referenceable.
String	getTime()
String	getUserName() Null if user not applicable / does not exist.
String	getUserURL() Null if user not applicable / does not exist
String	getWebServer()
void	init(INotificationSourceEvent event, Locale locale)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_NOTIFICATION_SKIN

public static final String DEFAULT_NOTIFICATION_SKIN

See Also:

Constant Field Values

EMPTY_LOCALE

protected static final Locale EMPTY_LOCALE

m_fullDateFormat

protected DateFormat m_fullDateFormat

m_shortDateFormat

protected DateFormat m_shortDateFormat

m_frontEndURL

protected String m_frontEndURL

m_webServer

protected String m_webServer

m_skinID

protected IThingID m_skinID

m_notEvent

protected INotificationSourceEvent m_notEvent

m_digestEvent

protected IDigestDeliveryEvent m_digestEvent

m_portalEvent

protected IPortalEvent m_portalEvent

m_thingID

protected IThingID m_thingID

m_parentID

protected IThingID m_parentID

m_oldParentID

protected IThingID m_oldParentID

m_thingType

protected String m_thingType

m_thingURL

protected String m_thingURL

m_thingName

protected String m_thingName

m_thingDescription

protected String m_thingDescription

m_parentURL

protected String m_parentURL

m_parentName

protected String m_parentName

m_oldParentURL

protected String m_oldParentURL

m_oldParentName

protected String m_oldParentName

m_userName

protected String m_userName

m_userURL

protected String m_userURL

m_time

protected String m_time

m_locale

protected Locale m_locale

m_language

protected String m_language

Constructor Detail

NotificationHelper

public NotificationHelper()

NotificationHelper

public NotificationHelper(INotificationSourceEvent event,
                          Locale locale)
                   throws PortalException

Throws:

PortalException

Method Detail

init

public void init(INotificationSourceEvent event,
                 Locale locale)
          throws PortalException

Throws:

PortalException

getThingType

public String getThingType()
                    throws PortalException

Throws:

PortalException

getThingURL

public String getThingURL()
                   throws PortalException

Null if thing is not de-referenceable.

Throws:

PortalException

getThingName

public String getThingName()
                    throws PortalException

Throws:

PortalException

getThingDescription

public String getThingDescription()
                           throws PortalException

Null if thing has no description.

Throws:

PortalException

getParentURL

public String getParentURL()
                    throws PortalException

Null if parent is not de-referenceable.

Throws:

PortalException

getParentName

public String getParentName()
                     throws PortalException

Null if parent not applicable / does not exist.

Throws:

PortalException

getOldParentURL

public String getOldParentURL()
                       throws PortalException

Null if old parent is not de-referenceable.

Throws:

PortalException

getOldParentName

public String getOldParentName()
                        throws PortalException

Null if old parent not applicable / does not exist.

Throws:

PortalException

getUserName

public String getUserName()
                   throws PortalException

Null if user not applicable / does not exist.

Throws:

PortalException

getUserURL

public String getUserURL()
                  throws PortalException

Null if user not applicable / does not exist

Returns:

Throws:

PortalException

getTime

public String getTime()
               throws PortalException

Throws:

PortalException

getSystemTitle

public String getSystemTitle()
                      throws PortalException

Throws:

PortalException

getSkinProperty

public String getSkinProperty(String name)
                       throws PortalException

Throws:

PortalException

getSkinID

public IThingID getSkinID()
                   throws PortalException

Throws:

PortalException

getFrontEndURL

public String getFrontEndURL()
                      throws PortalException

Throws:

PortalException

getWebServer

public String getWebServer()
                    throws PortalException

Throws:

PortalException

getFullDateFormat

public DateFormat getFullDateFormat()
                             throws PortalException

Throws:

PortalException

getShortDateFormat

public DateFormat getShortDateFormat()
                              throws PortalException

Throws:

PortalException

getLocalizedMessage

public String getLocalizedMessage(String key,
                                  Object[] args)

getLocalizedMessage

public String getLocalizedMessage(Class<? extends ResourceBundle> bundleClass,
                                  String key,
                                  Object[] args)

getDeliveryModes

public int getDeliveryModes()
                     throws PortalException

Throws:

PortalException

getSourceEvents

public List<IPortalEvent> getSourceEvents()

getNotificationSourceEvent

public INotificationSourceEvent getNotificationSourceEvent()

getLocale

public Locale getLocale()

getThingName

public String getThingName(IThing thing)
                    throws PortalException

Throws:

PortalException

getThingDescription

public String getThingDescription(IThing thing)
                           throws PortalException

Throws:

PortalException