com.communote.plugins.activity.base.data

Class ActivityConfiguration

java.lang.Object

com.communote.plugins.activity.base.data.ActivityConfiguration

All Implemented Interfaces:

Serializable

public class ActivityConfiguration
extends Object
implements Serializable

Object holding the current configuration of an activity. The configuration is directly connected to an ActivityDefinition by the templateId. While an ActivityDefinition holds the default settings of an activity and only exists as long the providing plugin is deployed, a configuration can be used to overwrite these defaults and can be persisted to allow automatic expiration even after the providing plugin has been removed.

Author:

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ActivityConfiguration(String templateId, String staticName, boolean external) Create a new configuration for an activity definition

Method Summary

Modifier and Type	Method and Description
long	getExpirationTimeout()
String	getStaticName()
String	getTemplateId()
boolean	isActive()
boolean	isDeactivatableByManager()
boolean	isDeletable()
boolean	isDeletableByUser()
boolean	isExternal()
void	setActive(boolean active) Activate or deactivate the activity.
void	setDeactivatableByManager(boolean deactivatable) Whether the client manager should be allowed to deactivate the activity.
void	setDeletable(boolean deletable)
void	setDeletableByUser(boolean deletableByUser) Set whether authorized users are allowed to delete the messages of the activity.
void	setExpirationTimeout(long timeoutInMillis) Set the expiration timeout for the activity.

Methods inherited from class java.lang.Object

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

Constructor Detail

ActivityConfiguration

public ActivityConfiguration(String templateId,
                             String staticName,
                             boolean external)

Create a new configuration for an activity definition

Parameters:

templateId - the ID which uniquely identifies the associated activity definition

staticName - the unlocalized display name of the associated activity definition

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

Method Detail

getExpirationTimeout

public long getExpirationTimeout()

Returns:

a timeout in milliseconds after which an activity should expire automatically. Expiration for activities means that the activity messages, which are the notes with a templateId of the activity definition, should be deleted automatically if they are older than the offset. A return value of zero or less means that the activity won't expire.

getStaticName

public String getStaticName()

Returns:

the display name of the activity which is directly derived from the associated activity definition

getTemplateId

public String getTemplateId()

Returns:

the template ID which uniquely identifies the activity. This ID is directly derived from the activity definition this configuration belongs to.

isActive

public boolean isActive()

Returns:

whether the activity represented by this configuration is active. When an activity is not active new activity messages should not be created. In case true is returned the activity can still be disabled if it is configurable per topic and the topic manager disabled it.

isDeactivatableByManager

public boolean isDeactivatableByManager()

Returns:

whether the client manager is allowed to deactivate the activity.

isDeletable

public boolean isDeletable()

Returns:

the deletable

See Also:

ActivityDefinition#setDeletable()

isDeletableByUser

public boolean isDeletableByUser()

Returns:

whether users can delete the messages of the activity. In case this method returns true an activity message will only be deletable if the user has the appropriate rights, as he would have to have for any other note.

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)

Activate or deactivate the activity.

Parameters:

active - true to activate the activity, false to deactivate it

See Also:

isActive()

setDeactivatableByManager

public void setDeactivatableByManager(boolean deactivatable)

Whether the client manager should be allowed to deactivate the activity.

Parameters:

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

setDeletable

public void setDeletable(boolean deletable)

Parameters:

deletable - the deletable to set

See Also:

ActivityDefinition#setDeletable()

setDeletableByUser

public void setDeletableByUser(boolean deletableByUser)

Set whether authorized users are allowed to delete the messages of the activity. Whether a user is authorized or not is defined by standard note access control rules.

Parameters:

deletableByUser - true if authorized users can delete activity messages, false otherwise

setExpirationTimeout

public void setExpirationTimeout(long timeoutInMillis)

Set the expiration timeout for the activity.

Parameters:

timeoutInMillis - the timeout in milliseconds after which an activity should expire automatically. A value of zero or less means that the activity won't expire.

See Also:

#getCurrentExpirationTimeout()