Package org.ametys.plugins.workspaces.activities

Class AbstractWorkspacesActivityType

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.repository.activities.DefaultActivityType

org.ametys.plugins.workspaces.activities.AbstractWorkspacesActivityType

All Implemented Interfaces:

ActivityType, LogEnabled, PluginAware, Configurable, Serviceable

Direct Known Subclasses:

AbstractProjectsActivityType, CalendarEventActivityType, DocumentsActivityType, MinisiteActivityType, TasksActivityType, ThreadsActivityType

public abstract class AbstractWorkspacesActivityType
extends DefaultActivityType

Class representing a generic activity type for workspaces

Field Summary

Fields

Modifier and Type	Field	Description
protected NotificationPreferencesHelper	_notificationPreferenceHelper	The notification preference helper
protected ProjectManager	_projectManager	The project manager
protected AmetysObjectResolver	_resolver	Resolver
static final String	PROJECT_ACCESS	Constant for project's access JSON key.
static final String	PROJECT_CATEGORY	Constant for project's category JSON key.
static final String	PROJECT_NAME	Constant for project's name JSON key.
static final String	PROJECT_TITLE	Constant for project's title JSON key.
static final String	PROJECT_URL	Constant for project's url JSON key.

Fields inherited from class org.ametys.plugins.repository.activities.DefaultActivityType

_currentUserProvider, _userHelper

Constructor Summary

Constructors

Constructor	Description
AbstractWorkspacesActivityType()

Method Summary

Modifier and Type	Method	Description
protected void	_addValueIfExists(Map<String,Object> json, Activity activity, String dataPath, String key)	Add the value of item if exists to JSON activity representation
Map<String,Object>	additionnalDataToJSONForClient(Activity activity)	Retrieve data specific to the ActivityType that needs to be serialized but are not stored in the DataHolder.
abstract String	getMailBodyURI(Activity activity)	Get the URI to resolve to get the mail body
protected Project	getParentProject(AmetysObject ao)	Helper method to retrieve the parent project of an ametys object
abstract Project	getProjectFromEvent(Event event)	Retrieve the project concerned by the event.
String	getSubjectI18nKey(Activity activity)	the subject key Warning : the key parameters are using index
List<String>	getSubjectI18nParams(Activity activity)	A list of string that will be used to parameterize the i18n key
abstract AmetysObject	getTargetAmetysObject(Activity activity)	Retrieve the ametys object targeted by this activity.
List<String>	getUsersEmailToNotify(Activity activity)	Get the user affected by this activity that requested to receive direct notification
boolean	isMergeable(Activity activity1, Activity activity2)	Determines if two activities can be merged
void	service(ServiceManager serviceManager)
void	setAdditionalActivityData(Activity activityNode, Map<String,Object> parameters)	Add the value specific to the activity type to the activity
boolean	support(Event event)	Check if an event with an id in the getSupportedEventType should actually leads to the creation of an activity

Methods inherited from class org.ametys.plugins.repository.activities.DefaultActivityType

configure, getSupportedEventTypes, mergeActivities, setPluginInfo

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

PROJECT_NAME

public static final String PROJECT_NAME

Constant for project's name JSON key. The value is a String.

See Also:

• Constant Field Values

PROJECT_TITLE

public static final String PROJECT_TITLE

Constant for project's title JSON key. The value is a String.

See Also:

• Constant Field Values

PROJECT_ACCESS

public static final String PROJECT_ACCESS

Constant for project's access JSON key. The value is a boolean.

See Also:

• Constant Field Values

PROJECT_URL

public static final String PROJECT_URL

Constant for project's url JSON key. The value is a String.

See Also:

• Constant Field Values

PROJECT_CATEGORY

public static final String PROJECT_CATEGORY

Constant for project's category JSON key. The value is a String.

See Also:

• Constant Field Values

_resolver

protected AmetysObjectResolver _resolver

Resolver

_projectManager

protected ProjectManager _projectManager

The project manager

_notificationPreferenceHelper

protected NotificationPreferencesHelper _notificationPreferenceHelper

The notification preference helper

Constructor Details

AbstractWorkspacesActivityType

public AbstractWorkspacesActivityType()

Method Details

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class DefaultActivityType

Throws:

ServiceException

setAdditionalActivityData

public void setAdditionalActivityData(Activity activityNode,
 Map<String,Object> parameters)
                               throws javax.jcr.RepositoryException

Description copied from interface: ActivityType

Add the value specific to the activity type to the activity

Parameters:

activityNode - the activity

parameters - the activity parameters

Throws:

javax.jcr.RepositoryException - if an error occurs while manipulating the repository

additionnalDataToJSONForClient

public Map<String,Object> additionnalDataToJSONForClient(Activity activity)

Description copied from interface: ActivityType

Retrieve data specific to the ActivityType that needs to be serialized but are not stored in the DataHolder. Those data will be added to the data of the dataHolder

Parameters:

activity - the activity to serialize

Returns:

a json map of the specific data

isMergeable

public boolean isMergeable(Activity activity1,
 Activity activity2)

Description copied from interface: ActivityType

Determines if two activities can be merged

Specified by:

isMergeable in interface ActivityType

Overrides:

isMergeable in class DefaultActivityType

Parameters:

activity1 - The first activity

activity2 - The second activity

Returns:

true if the events can be merged

_addValueIfExists

protected void _addValueIfExists(Map<String,Object> json,
 Activity activity,
 String dataPath,
 String key)

Add the value of item if exists to JSON activity representation

Parameters:

json - the JSON activity

activity - the activity

dataPath - the data path

key - the JSON key

support

public boolean support(Event event)

Check if an event with an id in the getSupportedEventType should actually leads to the creation of an activity

Parameters:

event - the event to test

Returns:

true if an activity should be created

getProjectFromEvent

public abstract Project getProjectFromEvent(Event event)

Retrieve the project concerned by the event. the event must be supported by the ActivityType.

Parameters:

event - an event supported by the activity type

Returns:

the targeted project

getParentProject

protected Project getParentProject(AmetysObject ao)

Helper method to retrieve the parent project of an ametys object

Parameters:

ao - the ametys object

Returns:

the parent project or null if the object doesn't have have project as parent

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

getSubjectI18nKey

public String getSubjectI18nKey(Activity activity)

the subject key Warning : the key parameters are using index

Parameters:

activity - the activity

Returns:

the i18nkey

getSubjectI18nParams

public List<String> getSubjectI18nParams(Activity activity)

A list of string that will be used to parameterize the i18n key

Parameters:

activity - the activity

Returns:

the list of parameters

getMailBodyURI

public abstract String getMailBodyURI(Activity activity)

Get the URI to resolve to get the mail body

Parameters:

activity - the activity

Returns:

the uri

getUsersEmailToNotify

public List<String> getUsersEmailToNotify(Activity activity)

Get the user affected by this activity that requested to receive direct notification

Parameters:

activity - the activity

Returns:

the email of the user to notify