com.jalios.jcms.alert

Interface AlertChannel

All Known Implementing Classes:

BasicAlertChannel, MailAlertChannel, WebAlertChannel

public interface AlertChannel

Method Summary

Modifier and Type	Method and Description
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.
boolean	isAvailable(Member member) Returns true if this AlertChannel is available for the given Member.
boolean	saveAlert() Returns true if the alerts of this channel must be saved.
void	send(Alert alert) Sends an alert.

Method Detail

getName

java.lang.String getName()

Returns the internal name of the AlertChannel.

Returns:

the internal name of the AlertChannel.

Since:

jcms-8.0.0

getLabel

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

Returns the label of the AlertChannel.

Parameters:

userLang - the user language.

Returns:

the label of the AlertChannel.

Since:

jcms-8.0.0

getDescription

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

Returns the description of the AlertChannel.

Parameters:

userLang - the user language.

Returns:

the description of the AlertChannel.

Since:

jcms-8.0.0

getIcon

java.lang.String getIcon()

Returns the icon of the AlertChannel.

Returns:

the icon of the AlertChannel.

Since:

jcms-8.0.0

isAvailable

boolean isAvailable(Member member)

Returns true if this AlertChannel is available for the given Member.

Parameters:

member - the member

Returns:

true if this AlertChannel is available for the given Member.

Since:

jcms-8.0.0

send

void send(Alert alert)

Sends an alert.

Parameters:

alert - the alert

Since:

jcms-8.0.0

saveAlert

boolean saveAlert()

Returns true if the alerts of this channel must be saved.

Returns:

true if the alerts of this channel must be saved.

Since:

jcms-8.0.0