Package com.jalios.jcms.alert

Class BasicAlertChannel

java.lang.Object

com.jalios.jcms.alert.BasicAlertChannel

All Implemented Interfaces:

AlertChannel, PluginComponent

Direct Known Subclasses:

MailAlertChannel, WebAlertChannel

public abstract class BasicAlertChannel
extends java.lang.Object
implements AlertChannel, PluginComponent

Field Summary

Fields inherited from interface com.jalios.jcms.plugin.PluginComponent

REVISION

Constructor Summary

Constructors

Constructor	Description
BasicAlertChannel()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getIcon()	Returns the icon of the AlertChannel.
boolean	init(Plugin plugin)	Initialize the component with the given plugin configuration
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.jalios.jcms.alert.AlertChannel

getDescription, getLabel, getName, send

Constructor Detail

BasicAlertChannel

public BasicAlertChannel()

Method Detail

getIcon

public java.lang.String getIcon()

Description copied from interface: AlertChannel

Returns the icon of the AlertChannel.

Specified by:

getIcon in interface AlertChannel

Returns:

the icon of the AlertChannel.

isAvailable

public boolean isAvailable(Member member)

Description copied from interface: AlertChannel

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

Specified by:

isAvailable in interface AlertChannel

Parameters:

member - the member

Returns:

true if this AlertChannel is available for the given Member.

saveAlert

public boolean saveAlert()

Description copied from interface: AlertChannel

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

Specified by:

saveAlert in interface AlertChannel

Returns:

true if the alerts of this channel must be saved.

init

public boolean init(Plugin plugin)

Description copied from interface: PluginComponent

Initialize the component with the given plugin configuration

Specified by:

init in interface PluginComponent

Parameters:

plugin - the calling plugin

Returns:

true if the component has been correctly initialized.