com.communote.plugins.activity.base.service

Interface ActivityService

All Known Implementing Classes:

ActivityServiceImpl

public interface ActivityService

Service to manage activity definitions and configurations

Author:

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

See Also:

ActivityDefinition, ActivityConfiguration

Field Summary

Fields

Modifier and Type	Field and Description
static String	NOTE_PROPERTY_KEY_ACTIVITY Key of the note property which marks a note as an activity.
static String	NOTE_PROPERTY_KEY_ACTIVITY_UNDELETABLE Key of the note property which marks an activity as not deletable.
static String	NOTE_PROPERTY_VALUE_ACTIVITY Value of the note property which marks a note as an activity.
static String	PROPERTY_KEY_GROUP the key group to be used for properties related to activities

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.

Field Detail

NOTE_PROPERTY_KEY_ACTIVITY

static final String NOTE_PROPERTY_KEY_ACTIVITY

Key of the note property which marks a note as an activity.

See Also:

Constant Field Values

NOTE_PROPERTY_KEY_ACTIVITY_UNDELETABLE

static final String NOTE_PROPERTY_KEY_ACTIVITY_UNDELETABLE

Key of the note property which marks an activity as not deletable.

See Also:

Constant Field Values

NOTE_PROPERTY_VALUE_ACTIVITY

static final String NOTE_PROPERTY_VALUE_ACTIVITY

Value of the note property which marks a note as an activity.

See Also:

Constant Field Values

PROPERTY_KEY_GROUP

static final String PROPERTY_KEY_GROUP

the key group to be used for properties related to activities

See Also:

Constant Field Values

Method Detail

activateDeactivateActivitiesForTopic

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

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.

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:

isActivityActive(String, Long)

addDefinition

boolean addDefinition(ActivityDefinition definition)

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.

Parameters:

definition - the activity definition to add

Returns:

whether the definition was added

convertToActivityNote

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

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.

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

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

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.

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

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

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.

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

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

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.

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

boolean isActivityDeletableByUser(String templateId)
                           throws ActivityServiceException

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.

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

void removeDefinition(String templateId)

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

Parameters:

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

storeActivityConfigurations

void storeActivityConfigurations(List<ActivityConfiguration> configurations)
                          throws ActivityServiceException

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.

Parameters:

configurations - the configurations to store

Throws:

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