Package org.exoplatform.commons.api.notification.plugin

Class AbstractNotificationChildPlugin

java.lang.Object

org.exoplatform.container.component.BaseComponentPlugin

org.exoplatform.commons.api.notification.plugin.BaseNotificationPlugin

org.exoplatform.commons.api.notification.plugin.AbstractNotificationChildPlugin

All Implemented Interfaces:

org.exoplatform.container.component.ComponentPlugin

public abstract class AbstractNotificationChildPlugin
extends BaseNotificationPlugin

Field Summary

Fields inherited from class org.exoplatform.container.component.BaseComponentPlugin

desc, name

Constructor Summary

Constructors

Constructor	Description
AbstractNotificationChildPlugin(org.exoplatform.container.xml.InitParams initParams)

Method Summary

Modifier and Type	Method	Description
protected String	getLanguage(NotificationInfo message)
List<String>	getParentPluginIds()	Gets the parents's id
groovy.text.Template	getTemplateEngine()	Get TemplateEngine of plugin
String	getTemplatePath()
abstract String	makeContent(NotificationContext ctx)
protected NotificationInfo	makeNotification(NotificationContext ctx)	Makes MessageInfo from given information what keep inside NotificationContext
void	setTemplateEngine(groovy.text.Template engine)	Set TemplateEngine for plugin
void	setTemplatePath(String templatePath)

Methods inherited from class org.exoplatform.commons.api.notification.plugin.BaseNotificationPlugin

buildNotification, end, getId, getKey, getOrganizationService, getPluginConfigs, isOldPlugin, isValid, setOldPlugin, start

Methods inherited from class org.exoplatform.container.component.BaseComponentPlugin

getDescription, getName, setDescription, setName

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractNotificationChildPlugin

public AbstractNotificationChildPlugin(org.exoplatform.container.xml.InitParams initParams)

Method Details

getParentPluginIds

public List<String> getParentPluginIds()

Gets the parents's id

Returns:

getLanguage

protected String getLanguage(NotificationInfo message)

Parameters:

message -

Returns:

makeNotification

protected NotificationInfo makeNotification(NotificationContext ctx)

Description copied from class: BaseNotificationPlugin

Makes MessageInfo from given information what keep inside NotificationContext

Specified by:

makeNotification in class BaseNotificationPlugin

Returns:

makeContent

public abstract String makeContent(NotificationContext ctx)

getTemplateEngine

public groovy.text.Template getTemplateEngine()

Get TemplateEngine of plugin

Returns:

the TemplateEngine

setTemplateEngine

public void setTemplateEngine(groovy.text.Template engine)

Set TemplateEngine for plugin

Parameters:

engine - the TemplateEngine to set

getTemplatePath

public String getTemplatePath()

setTemplatePath

public void setTemplatePath(String templatePath)