com.communote.plugins.activity.base.data

Class ActivityDefinition

java.lang.Object

com.communote.server.core.template.NoteTemplateDefinition

com.communote.plugins.activity.base.data.ActivityDefinition

public class ActivityDefinition
extends NoteTemplateDefinition

An ActivityDefinition is a special kind of a template definition which defines an activity or activity type.

Activities result from actions which were conducted by a user and are visualized by a template note with that user being the author. The different types of actions like creating a topic or editing the permissions are modeled by distinctive activities which are instances of the activity definition with a unique ID (the templateId).

As soon as an ActivityDefiniton is added to the ActivityService activity messages for that type can be created. Activity messages are template notes which have the templateId of the definition and additionally have a note property that marks the note as an activity.

The ActivityDefinition defines the default properties of an activity and the activity messages. Some of these settings can be overwritten by an ActivityConfiguration with the same identifier (templateId). The definition is only available as long as it is registered to the ActivityService which is usually the time the providing plugin is deployed. The configuration on the other hand can be persisted.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_DELETABLE_BY_USER the default value for all definitions that do not set the deletableByUser flag

Constructor Summary

Constructors

Constructor and Description
ActivityDefinition(String templateId, boolean external, boolean configurablePerTopic, boolean isDeactivatableByManager) Create a new activity template definition.
ActivityDefinition(String templateId, LocalizedMessage templateName, LocalizedMessage template, boolean external, boolean configurablePerTopic) Create a new activity template definition with a default expiration timeout of 180 days.
ActivityDefinition(String templateId, LocalizedMessage templateName, LocalizedMessage template, boolean external, boolean configurablePerTopic, boolean isDeactivatableByManager) Create a new activity template definition with a default expiration timeout of 180 days.
ActivityDefinition(String templateId, LocalizedMessage templateName, LocalizedMessage template, long expirationTimeout, boolean external, boolean configurablePerTopic) Create a new activity template definition.
ActivityDefinition(String templateId, LocalizedMessage templateName, LocalizedMessage template, long expirationTimeout, boolean external, boolean configurablePerTopic, boolean isDeactivatableByManager) Create a new activity template definition.
ActivityDefinition(String templateId, long expirationTimeout, boolean external, boolean configurablePerTopic, boolean isDeactivatableByManager) Create a new activity template definition.

Method Summary

Modifier and Type	Method and Description
LocalizedMessage	getDescription()
String	getStaticName()
boolean	isActive()
boolean	isConfigurablePerTopic()
boolean	isDeactivatableByManager() Return whether the client manager should be allowed to deactivate the activity.
boolean	isDeletable()
boolean	isDeletableByUser()
boolean	isExternal()
void	setActive(boolean active) Set whether the activity should be active.
void	setDeactivatableByManager(boolean deactivatable) Set whether the client manager should be allowed to deactivate the activity.
void	setDeletable(boolean isDeletable)
void	setDeletableByUser(boolean deletableByUser) Set whether authorized users are allowed to delete the messages of this activity.
void	setDescription(LocalizedMessage description) Set the description of the activity.
void	setStaticName(String staticName) Set the display name of the activity which should be shown when the localized name is not accessible anymore, for example after the definition was removed.

Methods inherited from class com.communote.server.core.template.NoteTemplateDefinition

addTemplate, getExpirationTimeout, getTemplate, getTemplate, getTemplateId, getTemplateName, hasTemplate, removeTemplate, setExpirationTimeout, setPropertiesValidator, validateProperties

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DELETABLE_BY_USER

public static final boolean DEFAULT_DELETABLE_BY_USER

the default value for all definitions that do not set the deletableByUser flag

See Also:

isDeletableByUser(), Constant Field Values

Constructor Detail

ActivityDefinition

public ActivityDefinition(String templateId,
                          boolean external,
                          boolean configurablePerTopic,
                          boolean isDeactivatableByManager)

Create a new activity template definition. This assumes the keys for the activities name and template are the activities id suffixed with ".name" and ".template"

Parameters:

templateId - an ID which uniquely identifies the activity

external - whether activity messages of this type are created by external systems

configurablePerTopic - whether the activity can be activated or deactivated per topic by the topic manager

isDeactivatableByManager - Set to true, if this activity is deactivatable.

ActivityDefinition

public ActivityDefinition(String templateId,
                          LocalizedMessage templateName,
                          LocalizedMessage template,
                          boolean external,
                          boolean configurablePerTopic)

Create a new activity template definition with a default expiration timeout of 180 days.

Parameters:

templateId - an ID which uniquely identifies the activity

templateName - a localizable name of the activity

template - the actual template. This will be the default template.

external - whether activity messages of this type are created by external systems

configurablePerTopic - whether the activity can be activated or deactivated per topic by the topic manager

ActivityDefinition

public ActivityDefinition(String templateId,
                          LocalizedMessage templateName,
                          LocalizedMessage template,
                          boolean external,
                          boolean configurablePerTopic,
                          boolean isDeactivatableByManager)

Create a new activity template definition with a default expiration timeout of 180 days.

Parameters:

templateId - an ID which uniquely identifies the activity

templateName - a localizable name of the activity

template - the actual template. This will be the default template.

external - whether activity messages of this type are created by external systems

configurablePerTopic - whether the activity can be activated or deactivated per topic by the topic manager

isDeactivatableByManager - Set to true, if this activity is deactivatable.

ActivityDefinition

public ActivityDefinition(String templateId,
                          LocalizedMessage templateName,
                          LocalizedMessage template,
                          long expirationTimeout,
                          boolean external,
                          boolean configurablePerTopic)

Create a new activity template definition.

Parameters:

templateId - an ID which uniquely identifies the activity

templateName - a localizable name of the activity

template - the actual template. This will be the default template.

expirationTimeout - a timeout in milliseconds after which activity messages should expire

external - whether activity messages of this type are created by external systems

configurablePerTopic - whether the activity can be activated or deactivated per topic by the topic manager

ActivityDefinition

public ActivityDefinition(String templateId,
                          LocalizedMessage templateName,
                          LocalizedMessage template,
                          long expirationTimeout,
                          boolean external,
                          boolean configurablePerTopic,
                          boolean isDeactivatableByManager)

Create a new activity template definition.

Parameters:

templateId - an ID which uniquely identifies the activity

templateName - a localizable name of the activity

template - the actual template. This will be the default template.

expirationTimeout - a timeout in milliseconds after which activity messages should expire

external - whether activity messages of this type are created by external systems

configurablePerTopic - whether the activity can be activated or deactivated per topic by the topic manager

isDeactivatableByManager - Set to true, if this activity is deactivatable.

ActivityDefinition

public ActivityDefinition(String templateId,
                          long expirationTimeout,
                          boolean external,
                          boolean configurablePerTopic,
                          boolean isDeactivatableByManager)

Create a new activity template definition. This assumes the keys for the activities name and template are the activities id suffixed with ".name" and ".template"

Parameters:

templateId - an ID which uniquely identifies the activity

expirationTimeout - a timeout in milliseconds after which activity messages should expire

external - whether activity messages of this type are created by external systems

configurablePerTopic - whether the activity can be activated or deactivated per topic by the topic manager

isDeactivatableByManager - Set to true, if this activity is deactivatable.

Method Detail

getDescription

public LocalizedMessage getDescription()

Returns:

the localized description of the activity, can be null

getStaticName

public String getStaticName()

Returns:

display name of the activity which should be shown when the localized name is not accessible anymore

isActive

public boolean isActive()

Returns:

whether the activity should be active, defaults to false

See Also:

ActivityConfiguration.isActive()

isConfigurablePerTopic

public boolean isConfigurablePerTopic()

Returns:

whether the activity can be activated or deactivated per topic by the topic manager

isDeactivatableByManager

public boolean isDeactivatableByManager()

Return whether the client manager should be allowed to deactivate the activity. In case the activity is an external activity this method returns always false.

Returns:

True (default), if this activity can be deactivated by the client manager.

isDeletable

public boolean isDeletable()

Returns:

True, if activities of this type can be generally be deleted. Return false, if it should'nt be possible to delete the activities.

isDeletableByUser

public boolean isDeletableByUser()

Returns:

whether authorized users are allowed to delete the messages of this activity. Whether a user is authorized or not is defined by standard note access control rules. This setting can be overridden by the activity configuration. This value defaults to DEFAULT_DELETABLE_BY_USER

isExternal

public boolean isExternal()

Returns:

whether activity messages of this type are created by external systems. In case this method returns true an activity cannot be deactivated.

setActive

public void setActive(boolean active)

Set whether the activity should be active. This value can be overridden in the configuration and defaults to false.

Parameters:

active - true if the activity should be active, false otherwise

See Also:

ActivityConfiguration.isActive()

setDeactivatableByManager

public void setDeactivatableByManager(boolean deactivatable)

Set whether the client manager should be allowed to deactivate the activity. This does not apply to external activities which cannot be deactivated.

Parameters:

deactivatable - true if the client manager should be allowed to deactivate the activity, false otherwise

setDeletable

public void setDeletable(boolean isDeletable)

Parameters:

isDeletable - the isDeletable to set

setDeletableByUser

public void setDeletableByUser(boolean deletableByUser)

Set whether authorized users are allowed to delete the messages of this activity. Whether a user is authorized or not is defined by standard note access control rules. This setting can be overridden by the activity configuration. The default value is DEFAULT_DELETABLE_BY_USER

Parameters:

deletableByUser - true if authorized users are allowed to delete the messages of the activity, false otherwise

setDescription

public void setDescription(LocalizedMessage description)

Set the description of the activity.

Parameters:

description - the localized description of the activity

setStaticName

public void setStaticName(String staticName)

Set the display name of the activity which should be shown when the localized name is not accessible anymore, for example after the definition was removed. This value defaults to the name in English locale.

Parameters:

staticName - the display name