Package pl.edu.icm.unity.base.msgtemplates

Class UserNotificationTemplateDef

java.lang.Object

pl.edu.icm.unity.base.msgtemplates.UserNotificationTemplateDef

All Implemented Interfaces:

MessageTemplateDefinition

@Component
public class UserNotificationTemplateDef
extends java.lang.Object
implements MessageTemplateDefinition

Defines a general purpose template with messages sent to existing users.

Author:

K. Benedyczak

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	NAME
static java.lang.String	USER

Fields inherited from interface pl.edu.icm.unity.base.msgtemplates.MessageTemplateDefinition

CUSTOM_VAR_PREFIX, INCLUDE_PREFIX

Constructor Summary

Constructors

Constructor	Description
UserNotificationTemplateDef()

Method Summary

Modifier and Type	Method	Description
boolean	allowCustomVariables()
java.util.EnumSet<CommunicationTechnology>	getCompatibleTechnologies()
java.lang.String	getDescriptionKey()
java.lang.String	getName()
java.util.Map<java.lang.String,MessageTemplateVariable>	getVariables()

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

USER

public static final java.lang.String USER

See Also:

Constant Field Values

Constructor Detail

UserNotificationTemplateDef

public UserNotificationTemplateDef()

Method Detail

getDescriptionKey

public java.lang.String getDescriptionKey()

Specified by:

getDescriptionKey in interface MessageTemplateDefinition

Returns:

message bundle key with the description of the template definition, with information on the purpose of the messages created with this template.

getName

public java.lang.String getName()

Specified by:

getName in interface MessageTemplateDefinition

Returns:

unique name of the message template definition

getVariables

public java.util.Map<java.lang.String,MessageTemplateVariable> getVariables()

Specified by:

getVariables in interface MessageTemplateDefinition

Returns:

map of variables supported by this template consumer. The map keys are variable names. The values are the keys in the message bundle with descriptions.

getCompatibleTechnologies

public java.util.EnumSet<CommunicationTechnology> getCompatibleTechnologies()

Specified by:

getCompatibleTechnologies in interface MessageTemplateDefinition

Returns:

set of supported facilities. Message from the template can be sent only by notification channels which are using this facilities.

allowCustomVariables

public boolean allowCustomVariables()

Specified by:

allowCustomVariables in interface MessageTemplateDefinition