Package com.jalios.jcms.alert

Class MailAlertChannel

java.lang.Object

com.jalios.jcms.alert.BasicAlertChannel

com.jalios.jcms.alert.MailAlertChannel

All Implemented Interfaces:

AlertChannel, PluginComponent

public class MailAlertChannel
extends BasicAlertChannel

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ALERT_ATTR
static java.lang.String	ALERT_CTXT	This MailPolicyFilter context key contains the alert.
static java.lang.String	DESCRIPTION_PROP
static java.lang.String	DISPLAY_ABSTRACT_PREFIX_PROP
static java.lang.String	EXPIRES_PROP
static java.lang.String	JSP_DEFAULT_PROP
static java.lang.String	JSP_PREFIX_PROP
static java.lang.String	LABEL_PROP
static java.lang.String	PREFIX_PROP
static java.lang.String	SUBJECT_DEFAULT_PROP
static java.lang.String	SUBJECT_PREFIX_PROP

Constructor Summary

Constructors

Constructor	Description
MailAlertChannel()

Method Summary

Modifier and Type	Method	Description
static boolean	displayAbstract(Alert alert)	Defines if abstract of the data should be displayed in the alert
java.lang.String	getDescription(java.lang.String userLang)	Returns the description of the AlertChannel.
java.lang.String	getIcon()	Returns the icon of the AlertChannel.
java.lang.String	getLabel(java.lang.String userLang)	Returns the label of the AlertChannel.
java.lang.String	getName()	Returns the internal name of the AlertChannel.
void	send(Alert alert)	Sends an alert.

Methods inherited from class com.jalios.jcms.alert.BasicAlertChannel

init, isAvailable, saveAlert

Methods inherited from class java.lang.Object

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

Field Detail

ALERT_ATTR

public static final java.lang.String ALERT_ATTR

See Also:

Constant Field Values

PREFIX_PROP

public static final java.lang.String PREFIX_PROP

See Also:

Constant Field Values

LABEL_PROP

public static final java.lang.String LABEL_PROP

See Also:

Constant Field Values

DESCRIPTION_PROP

public static final java.lang.String DESCRIPTION_PROP

See Also:

Constant Field Values

SUBJECT_PREFIX_PROP

public static final java.lang.String SUBJECT_PREFIX_PROP

See Also:

Constant Field Values

SUBJECT_DEFAULT_PROP

public static final java.lang.String SUBJECT_DEFAULT_PROP

See Also:

Constant Field Values

JSP_PREFIX_PROP

public static final java.lang.String JSP_PREFIX_PROP

See Also:

Constant Field Values

JSP_DEFAULT_PROP

public static final java.lang.String JSP_DEFAULT_PROP

See Also:

Constant Field Values

DISPLAY_ABSTRACT_PREFIX_PROP

public static final java.lang.String DISPLAY_ABSTRACT_PREFIX_PROP

See Also:

Constant Field Values

EXPIRES_PROP

public static final java.lang.String EXPIRES_PROP

See Also:

Constant Field Values

ALERT_CTXT

public static final java.lang.String ALERT_CTXT

This MailPolicyFilter context key contains the alert. Example of use in a MailPolicyFilter:

Alert alert = (Alert)context.get(MailAlertChannel.ALERT_CTXT);

See Also:

Constant Field Values

Constructor Detail

MailAlertChannel

public MailAlertChannel()

Method Detail

getName

public java.lang.String getName()

Description copied from interface: AlertChannel

Returns the internal name of the AlertChannel.

Returns:

the internal name of the AlertChannel.

getLabel

public java.lang.String getLabel(java.lang.String userLang)

Description copied from interface: AlertChannel

Returns the label of the AlertChannel.

Parameters:

userLang - the user language.

Returns:

the label of the AlertChannel.

getDescription

public java.lang.String getDescription(java.lang.String userLang)

Description copied from interface: AlertChannel

Returns the description of the AlertChannel.

Parameters:

userLang - the user language.

Returns:

the description of the AlertChannel.

getIcon

public java.lang.String getIcon()

Description copied from interface: AlertChannel

Returns the icon of the AlertChannel.

Specified by:

getIcon in interface AlertChannel

Overrides:

getIcon in class BasicAlertChannel

Returns:

the icon of the AlertChannel.

send

public void send(Alert alert)

Description copied from interface: AlertChannel

Sends an alert.

Parameters:

alert - the alert

displayAbstract

public static boolean displayAbstract(Alert alert)

Defines if abstract of the data should be displayed in the alert

Parameters:

alert - the Alert

Returns:

true if abstract should be displayed