com.communote.server.core.messaging

Class NotificationDefinition

java.lang.Object

com.communote.server.core.messaging.NotificationDefinition

Direct Known Subclasses:

DiscussionNotificationDefinition, LikeNotificationDefinition, MentionNotificationDefinition

public abstract class NotificationDefinition
extends Object

Abstract class for notification definitions.

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NotificationDefinition.NotificationTypes Possible support template types.

Constructor Summary

Constructors

Constructor and Description
NotificationDefinition(String id) Constructor.
NotificationDefinition(String id, String messageKey) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getId()
String	getMessageKeyForMessage(NotificationDefinition.NotificationTypes type) Method to get the message key, which can be used for the message.
String	getMessageKeyForName()
String	getMessageKeyForSubject(NotificationDefinition.NotificationTypes type) Method to get the message key, which can be used for a title or subject.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

NotificationDefinition

public NotificationDefinition(String id)

Constructor.

Parameters:

id - Unique id for this definition.

NotificationDefinition

public NotificationDefinition(String id,
                              String messageKey)

Constructor.

Parameters:

id - Unique id for this definition.

messageKey - Message key for a readable name of this definition. If this is null a default key will be generated (user.profile.notification.definitions. + id).

Method Detail

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getId

public String getId()

Returns:

If of this definition. This must be unique.

getMessageKeyForMessage

public String getMessageKeyForMessage(NotificationDefinition.NotificationTypes type)

Method to get the message key, which can be used for the message.

Parameters:

type - Type of notification.

Returns:

getMessageKeyForName() + "." + type.name().toLowerCase() + ".message"

getMessageKeyForName

public String getMessageKeyForName()

Returns:

A message key used to retrieve a name for this definition. This message key also works as a prefix for other derived messages keys.

getMessageKeyForSubject

public String getMessageKeyForSubject(NotificationDefinition.NotificationTypes type)

Method to get the message key, which can be used for a title or subject.

Parameters:

type - Type of notification.

Returns:

getMessageKeyForMessage() + ".subject"

hashCode

public int hashCode()

Overrides:

hashCode in class Object