Package org.ametys.plugins.repository.activities

Interface ActivityType

All Known Implementing Classes:

AbstractProjectsActivityType, AbstractWorkspacesActivityType, CalendarEventActivityType, ContentCommentedActivityType, DefaultActivityType, DocumentCommentedActivityType, DocumentsActivityType, MemberAddedActivityType, MinisiteActivityType, MinisitePageRenamedActivityType, NewsPublishedActivityType, PostCreatedActivityType, ResourceCreatedOrUpdatedActivityType, ResourceRenamedActivityType, TaskAssignedActivityType, TaskClosedStatusChangedActivityType, TasksActivityType, ThreadCreatedActivityType, ThreadsActivityType, WebContentActivityType

public interface ActivityType

Interface for activity types

Method Summary

Modifier and Type	Method	Description
default Map<String,Object>	additionnalDataToJSONForClient(Activity activity)	Retrieve data specific to the ActivityType that needs to be serialized but are not stored in the DataHolder.
Map<String,I18nizableText>	getSupportedEventTypes()	Get the ids of the supported event types
boolean	isMergeable(Activity activity1, Activity activity2)	Determines if two activities can be merged
Map<String,Object>	mergeActivities(List<Activity> activities)	Merge activities into one activity.
default void	setAdditionalActivityData(Activity activity, Map<String,Object> parameters)	Add the value specific to the activity type to the activity

Method Details

getSupportedEventTypes

Map<String,I18nizableText> getSupportedEventTypes()

Get the ids of the supported event types

Returns:

the ids of the supported event types

setAdditionalActivityData

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

Add the value specific to the activity type to the activity

Parameters:

activity - the activity

parameters - the activity parameters

Throws:

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

isMergeable

boolean isMergeable(Activity activity1,
 Activity activity2)

Determines if two activities can be merged

Parameters:

activity1 - The first activity

activity2 - The second activity

Returns:

true if the events can be merged

mergeActivities

Map<String,Object> mergeActivities(List<Activity> activities)

Merge activities into one activity. Be careful : be sure that the activities can be merged calling isMergeable method before

Parameters:

activities - The activities to merge

Returns:

Merged activities

additionnalDataToJSONForClient

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

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