Package org.ametys.plugins.workspaces.activities.documents

Class DocumentsActivityType

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.repository.activities.AbstractActivityType

org.ametys.plugins.workspaces.activities.AbstractWorkspacesActivityType

org.ametys.plugins.workspaces.activities.documents.DocumentsActivityType

All Implemented Interfaces:

ActivityType, LogEnabled, PluginAware, Configurable, Contextualizable, Serviceable

Direct Known Subclasses:

ResourceCreatedOrUpdatedActivityType, ResourceRenamedActivityType

public class DocumentsActivityType
extends AbstractWorkspacesActivityType

ActivityType implementation for documents-related activities

Nested Class Summary

Nested classes/interfaces inherited from class org.ametys.plugins.repository.activities.AbstractActivityType

AbstractActivityType.ActivityArguments

Field Summary

Fields

Modifier and Type	Field	Description
protected AmetysObjectResolver	_ametysObjectResolver	Resolver for Ametys objects
static final String	EVENT_CATEGORY_DOCUMENTS	Constant for event's category
static final String	FILE_DATA_NAME	data name for the activity file
static final String	FILES_DATA_NAME	data name for the activity files
static final String	PARENT_FOLDER	data name for the document parent folder name
static final String	PARENT_FOLDER_ID	data name for the document parent folder id
static final String	PARENT_FOLDER_PATH	data name for the parent folder path in explorer

Fields inherited from class org.ametys.plugins.workspaces.activities.AbstractWorkspacesActivityType

_context, _i18nUtils, _projectManager, _projectMemberManager, _resolver, _userManager, ACTIVITY_CONTEXT_PARAM, PROJECT_ACCESS, PROJECT_CATEGORY, PROJECT_NAME, PROJECT_TITLE, PROJECT_URL

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

_currentUserProvider, _pluginName, _userHelper

Constructor Summary

Constructors

Constructor	Description
DocumentsActivityType()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	additionnalDataToJSONForClient(Activity activity)	Retrieve data specific to the ActivityType that needs to be serialized but are not stored in the DataHolder.
Expression	getFilterPatternExpression(String pattern)	Get the expression to filter activity on pattern
Project	getProjectFromEvent(Event event)	Get the project from the event
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.
void	service(ServiceManager serviceManager)
void	setAdditionalActivityData(Activity activity, Map<String,Object> parameters)	Add the specific values to store in activity for this activity type
boolean	support(Event event)	true if the activity type support the event

Methods inherited from class org.ametys.plugins.workspaces.activities.AbstractWorkspacesActivityType

_addValueIfExists, _getProjectParameters, contextualize, getActivitiesArguments, getParentProject

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

configure, getId, getSupportedEventTypes, handleEvent, 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

PARENT_FOLDER_PATH

public static final String PARENT_FOLDER_PATH

data name for the parent folder path in explorer

See Also:

• Constant Field Values

PARENT_FOLDER_ID

public static final String PARENT_FOLDER_ID

data name for the document parent folder id

See Also:

• Constant Field Values

PARENT_FOLDER

public static final String PARENT_FOLDER

data name for the document parent folder name

See Also:

• Constant Field Values

FILE_DATA_NAME

public static final String FILE_DATA_NAME

data name for the activity file

See Also:

• Constant Field Values

FILES_DATA_NAME

public static final String FILES_DATA_NAME

data name for the activity files

See Also:

• Constant Field Values

EVENT_CATEGORY_DOCUMENTS

public static final String EVENT_CATEGORY_DOCUMENTS

Constant for event's category

See Also:

• Constant Field Values

_ametysObjectResolver

protected AmetysObjectResolver _ametysObjectResolver

Resolver for Ametys objects

Constructor Details

DocumentsActivityType

public DocumentsActivityType()

Method Details

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractWorkspacesActivityType

Throws:

ServiceException

support

public boolean support(Event event)

Description copied from interface: ActivityType

true if the activity type support the event

Parameters:

event - the event

Returns:

true if the activity type support the event

setAdditionalActivityData

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

Description copied from interface: ActivityType

Add the specific values to store in activity for this activity type

Specified by:

setAdditionalActivityData in interface ActivityType

Overrides:

setAdditionalActivityData in class AbstractWorkspacesActivityType

Parameters:

activity - 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

Specified by:

additionnalDataToJSONForClient in interface ActivityType

Overrides:

additionnalDataToJSONForClient in class AbstractWorkspacesActivityType

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 AbstractWorkspacesActivityType

Parameters:

activity1 - The first activity

activity2 - The second activity

Returns:

true if the events can be merged

getFilterPatternExpression

public Expression getFilterPatternExpression(String pattern)

Description copied from class: AbstractWorkspacesActivityType

Get the expression to filter activity on pattern

Specified by:

getFilterPatternExpression in class AbstractWorkspacesActivityType

Parameters:

pattern - the pattern expression

Returns:

the pattern expression

mergeActivities

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

Description copied from interface: ActivityType

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

Specified by:

mergeActivities in interface ActivityType

Overrides:

mergeActivities in class AbstractActivityType

Parameters:

activities - The activities to merge

Returns:

Merged activities

getProjectFromEvent

public Project getProjectFromEvent(Event event)

Description copied from class: AbstractWorkspacesActivityType

Get the project from the event

Specified by:

getProjectFromEvent in class AbstractWorkspacesActivityType

Parameters:

event - the event

Returns:

the project