com.communote.plugins.activity.base.service.impl

Class ActivityServiceImpl

java.lang.Object

com.communote.plugins.activity.base.service.impl.ActivityServiceImpl

All Implemented Interfaces:

ActivityService

public class ActivityServiceImpl
extends Object
implements ActivityService

Service to manage activity definitions and configurations

Author:

Communote GmbH - http://www.communote.com/

See Also:

ActivityDefinition, ActivityConfiguration

Field Summary

Fields inherited from interface com.communote.plugins.activity.base.service.ActivityService

NOTE_PROPERTY_KEY_ACTIVITY, NOTE_PROPERTY_KEY_ACTIVITY_UNDELETABLE, NOTE_PROPERTY_VALUE_ACTIVITY, PROPERTY_KEY_GROUP

Constructor Summary

Constructors

Constructor and Description
ActivityServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	activateDeactivateActivitiesForTopic(Long topicId, Map<ActivityDefinition,Boolean> settings) Activate and deactivate activities for a given topic.
boolean	addDefinition(ActivityDefinition definition) Add an activity definition.
void	convertToActivityNote(NoteStoringTO noteTO, String templateId, String templatePropertiesJSON) Add the required properties to mark the note as an activity of the provided type.
List<Pair<ActivityDefinition,ActivityConfiguration>>	getActivities(Locale locale) Return pairs of associated activity definitions and configurations.
List<Pair<ActivityDefinition,Boolean>>	getActivitySettingsForTopic(Long topicId) Return a list of activities that can be configured per topic.
boolean	isActivityActive(String templateId, Long topicId) Return whether an activity is active for a given topic.
boolean	isActivityDeletableByUser(String templateId) Return whether an activity is defined or configured to be deletable by the owner of the activity message or the manager of the topic.
void	removeDefinition(String templateId) Remove an activity definition.
void	storeActivityConfigurations(List<ActivityConfiguration> configurations) Stores the provided activity configurations.

Methods inherited from class java.lang.Object

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

Constructor Detail

ActivityServiceImpl

public ActivityServiceImpl()

Method Detail

activateDeactivateActivitiesForTopic

public void activateDeactivateActivitiesForTopic(Long topicId,
                                                 Map<ActivityDefinition,Boolean> settings)
                                          throws NotFoundException,
                                                 AuthorizationException,
                                                 ActivityServiceException

Description copied from interface: ActivityService

Activate and deactivate activities for a given topic. Provided activities which cannot be configured per topic or whose definition was removed will be ignored. This operation replaces any previously stored active or inactive activities of the given topic, with the exception of those whose definition was removed.

Specified by:

activateDeactivateActivitiesForTopic in interface ActivityService

Parameters:

topicId - the ID of the topic for which the activities should be stored

settings - a mapping from activity ID (template ID) to the active state where true means the activity should be active and false inactive

Throws:

NotFoundException - if the topic does not exist

AuthorizationException - if the calling user is not manager of the topic

ActivityServiceException - in case the existing settings couldn't be read or the new settings couldn't be stored

See Also:

ActivityService.isActivityActive(String, Long)

addDefinition

public boolean addDefinition(ActivityDefinition definition)

Description copied from interface: ActivityService

Add an activity definition. A definition is identified by its templateID. If there is already a definition with that ID the new one will be ignored.

Specified by:

addDefinition in interface ActivityService

Parameters:

definition - the activity definition to add

Returns:

whether the definition was added

convertToActivityNote

public void convertToActivityNote(NoteStoringTO noteTO,
                                  String templateId,
                                  String templatePropertiesJSON)

Description copied from interface: ActivityService

Add the required properties to mark the note as an activity of the provided type. This method won't check whether the activity exists or is active. This will be done by a note storing pre-processor.

Specified by:

convertToActivityNote in interface ActivityService

Parameters:

noteTO - the transfer object to enhance

templateId - the ID of the activity

templatePropertiesJSON - optional string in JSON which should be passed to the template engine and can contain any additional data the template might need. Can be null.

getActivities

public List<Pair<ActivityDefinition,ActivityConfiguration>> getActivities(Locale locale)
                                                                   throws ActivityServiceException

Description copied from interface: ActivityService

Return pairs of associated activity definitions and configurations. For activities which were not configured yet, the pair will contain a default configuration which is derived from the definition. In case the definition of an activity was already removed the pair will only contain the configuration and the left side will be null.

Specified by:

getActivities in interface ActivityService

Parameters:

locale - if not null the result will be sorted alphabetically by the name (or static name if the definition is missing) and by internal

Returns:

a list of available activities

Throws:

ActivityServiceException - in case the stored activity configurations couldn't be loaded

getActivitySettingsForTopic

public List<Pair<ActivityDefinition,Boolean>> getActivitySettingsForTopic(Long topicId)
                                                                   throws NotFoundException,
                                                                          AuthorizationException,
                                                                          ActivityServiceException

Description copied from interface: ActivityService

Return a list of activities that can be configured per topic. The result is a list of pairs where the left part is the definition and the right denotes whether the activity is active for the topic. For activities that were not yet configured for the topic the right part contains a default value. Activities which are deactivated by configuration will not be included.

Specified by:

getActivitySettingsForTopic in interface ActivityService

Parameters:

topicId - the ID of the topic for which the activities should be retrieved

Returns:

the activities with a flag denoting whether they are active or not

Throws:

NotFoundException - in case the topic was not found

AuthorizationException - in case the current user has no read access to the topic

ActivityServiceException - in case the stored activity configurations couldn't be loaded

isActivityActive

public boolean isActivityActive(String templateId,
                                Long topicId)
                         throws AuthorizationException,
                                NotFoundException,
                                ActivityServiceException

Description copied from interface: ActivityService

Return whether an activity is active for a given topic. An activity is active if the definition was not removed and the configuration states that the activity is active. If the activity supports a configuration per topic it is considered as active if the previous conditions hold and the activity was marked as active for the given topic or was not yet configured for that topic at all.

Specified by:

isActivityActive in interface ActivityService

Parameters:

templateId - the ID of the activity definition

topicId - the ID of the topic, can be null but the return value will be false if the activity can be configured per topic

Returns:

whether an activity is active for the topic

Throws:

AuthorizationException - if the user is not authorized to read the topic

NotFoundException - if the topic does not exist

ActivityServiceException - in case the stored activity configurations couldn't be loaded

isActivityDeletableByUser

public boolean isActivityDeletableByUser(String templateId)
                                  throws ActivityServiceException

Description copied from interface: ActivityService

Return whether an activity is defined or configured to be deletable by the owner of the activity message or the manager of the topic. In case there is no configuration and no definition it is assumed the activity existed but the definition was removed and no configuration had been created. Therefore the default value defined by ActivityDefinition.DEFAULT_DELETABLE_BY_USER is returned.

Specified by:

isActivityDeletableByUser in interface ActivityService

Parameters:

templateId - the ID of the activity

Returns:

true if the users can delete activity messages, false otherwise

Throws:

ActivityServiceException - in case the configuration couldn't be loaded

removeDefinition

public void removeDefinition(String templateId)

Description copied from interface: ActivityService

Remove an activity definition. The configuration associated with the definition will not be removed.

Specified by:

removeDefinition in interface ActivityService

Parameters:

templateId - the ID of the definition to remove. In case there is no definition for the ID, nothing will happen.

storeActivityConfigurations

public void storeActivityConfigurations(List<ActivityConfiguration> configurations)
                                 throws ActivityServiceException

Description copied from interface: ActivityService

Stores the provided activity configurations. This replaces all previously stored configurations. So if for instance the provided list does not contain some of the previously stored configurations these configurations will be removed. To remove all configurations an empty list can be used.

Specified by:

storeActivityConfigurations in interface ActivityService

Parameters:

configurations - the configurations to store

Throws:

ActivityServiceException - in case the storing of the configurations failed or a configuration was invalid