Package org.ametys.plugins.workspaces.activities

Class AbstractWorkspacesActivityNotifier

java.lang.Object

org.ametys.plugins.workspaces.activities.AbstractWorkspacesActivityNotifier

All Implemented Interfaces:

PluginAware, ActivityNotifier, Contextualizable, Serviceable

Direct Known Subclasses:

CalendarEventActivityNotifier, DocumentsActivityNotifier, MemberAddedActivityNotifier, MinisiteActivityNotifier, TasksActivityNotifier, ThreadsActivityNotifier, WebContentActivityNotifier

public abstract class AbstractWorkspacesActivityNotifier
extends Object
implements ActivityNotifier, Serviceable, PluginAware, Contextualizable

Abstract class representing a activity notifier for workspaces

Field Summary

Fields

Modifier and Type	Field	Description
protected Context	_context	The context
protected I18nUtils	_i18nUtils	The i18n utils
protected NotificationPreferencesHelper	_notificationPreferenceHelper	The notification preference helper
protected String	_pluginName	The plugin name
protected ProjectManager	_projectManager	The project manager
protected RenderingContextHandler	_renderingContextHandler	The rendering context handler
protected AmetysObjectResolver	_resolver	The Ametys Object resolver
protected RightManager	_rightManager	The right manager
protected SourceResolver	_srcResolver	The source resolver
protected UserManager	_userManager	The user manager

Constructor Summary

Constructors

Constructor	Description
AbstractWorkspacesActivityNotifier()

Method Summary

Modifier and Type	Method	Description
protected String	_getSubjectI18nKey(Activity activity)	Get the subject i18n key
void	contextualize(Context context)
abstract String	getMailBodyURI(Activity activity)	Get the URI to resolve to get the mail body
String	getMailHtmlBody(Activity activity)	Get the mail body as html from the activity
String	getMailSubject(Activity activity)	Get the mail subject from the activity
String	getMailTextBody(Activity activity)	Get the mail body to text format from the activity
List<String>	getSubjectI18nParams(Activity activity)	Get the subject i18n parameters
abstract AmetysObject	getTargetAmetysObject(Activity activity)	Retrieve the ametys object targeted by this activity.
List<String>	getUsersEmailToNotify(Activity activity)	Get the list of user email to notify for a given activity
void	service(ServiceManager manager)
void	setPluginInfo(String pluginName, String featureName, String id)	Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.web.activities.notify.ActivityNotifier

isAsync, support

Field Details

_rightManager

protected RightManager _rightManager

The right manager

_notificationPreferenceHelper

protected NotificationPreferencesHelper _notificationPreferenceHelper

The notification preference helper

_userManager

protected UserManager _userManager

The user manager

_projectManager

protected ProjectManager _projectManager

The project manager

_i18nUtils

protected I18nUtils _i18nUtils

The i18n utils

_renderingContextHandler

protected RenderingContextHandler _renderingContextHandler

The rendering context handler

_srcResolver

protected SourceResolver _srcResolver

The source resolver

_resolver

protected AmetysObjectResolver _resolver

The Ametys Object resolver

_pluginName

protected String _pluginName

The plugin name

_context

protected Context _context

The context

Constructor Details

AbstractWorkspacesActivityNotifier

public AbstractWorkspacesActivityNotifier()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

setPluginInfo

public void setPluginInfo(String pluginName,
 String featureName,
 String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

getUsersEmailToNotify

public List<String> getUsersEmailToNotify(Activity activity)

Description copied from interface: ActivityNotifier

Get the list of user email to notify for a given activity

Specified by:

getUsersEmailToNotify in interface ActivityNotifier

Parameters:

activity - the activity

Returns:

the list of user email to notify

getTargetAmetysObject

public abstract AmetysObject getTargetAmetysObject(Activity activity)

Retrieve the ametys object targeted by this activity. This method is intended for right computation purposes.

Parameters:

activity - the activity

Returns:

the target

getMailSubject

public String getMailSubject(Activity activity)

Description copied from interface: ActivityNotifier

Get the mail subject from the activity

Specified by:

getMailSubject in interface ActivityNotifier

Parameters:

activity - the activity

Returns:

the mail subject

_getSubjectI18nKey

protected String _getSubjectI18nKey(Activity activity)

Get the subject i18n key

Parameters:

activity - the activity

Returns:

the subject i18n key

getSubjectI18nParams

public List<String> getSubjectI18nParams(Activity activity)

Get the subject i18n parameters

Parameters:

activity - the activity

Returns:

the subject i18n parameters

getMailTextBody

public String getMailTextBody(Activity activity)

Description copied from interface: ActivityNotifier

Get the mail body to text format from the activity

Specified by:

getMailTextBody in interface ActivityNotifier

Parameters:

activity - the activity

Returns:

the mail body to text format. Can be null.

getMailHtmlBody

public String getMailHtmlBody(Activity activity)

Description copied from interface: ActivityNotifier

Get the mail body as html from the activity

Specified by:

getMailHtmlBody in interface ActivityNotifier

Parameters:

activity - the activity

Returns:

the mail body as html. Can be null.

getMailBodyURI

public abstract String getMailBodyURI(Activity activity)

Get the URI to resolve to get the mail body

Parameters:

activity - the activity

Returns:

the uri