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

Class BaseRegistrationTemplateDef

java.lang.Object

pl.edu.icm.unity.base.msgtemplates.reg.BaseRegistrationTemplateDef

All Implemented Interfaces:

MessageTemplateDefinition

Direct Known Subclasses:

RegistrationWithCommentsTemplateDef, SubmitRegistrationTemplateDef

public abstract class BaseRegistrationTemplateDef
extends java.lang.Object
implements MessageTemplateDefinition

Base class for all MessageTemplateDefinitions of the registration & enquiry forms subsystem. Common variables are defined here.

Author:

P. Piernik

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	FORM_NAME
static java.lang.String	REQUEST_ID

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

CUSTOM_VAR_PREFIX, INCLUDE_PREFIX

Constructor Summary

Constructors

Constructor	Description
BaseRegistrationTemplateDef(java.lang.String name, java.lang.String descriptionKey)

Method Summary

Modifier and Type	Method	Description
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

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

allowCustomVariables

Field Detail

FORM_NAME

public static final java.lang.String FORM_NAME

See Also:

Constant Field Values

REQUEST_ID

public static final java.lang.String REQUEST_ID

See Also:

Constant Field Values

Constructor Detail

BaseRegistrationTemplateDef

public BaseRegistrationTemplateDef(java.lang.String name,
                                   java.lang.String descriptionKey)

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface MessageTemplateDefinition

Returns:

unique name of the message template definition

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.

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.