RegistrationWithCommentsTemplateDef (UNITY Server base module 3.3.1 API)

java.lang.Object
- pl.edu.icm.unity.base.msgtemplates.reg.BaseRegistrationTemplateDef
- - pl.edu.icm.unity.base.msgtemplates.reg.RegistrationWithCommentsTemplateDef

All Implemented Interfaces:

MessageTemplateDefinition

Direct Known Subclasses:

AcceptRegistrationTemplateDef, RejectRegistrationTemplateDef, UpdateRegistrationTemplateDef
```
@Component
public abstract class RegistrationWithCommentsTemplateDef
extends BaseRegistrationTemplateDef
```
Base class for all MessageTemplateDefinitions of the registration forms subsystem which can contain comments.

Author:

P. Piernik

- Field Summary
  
  Fields
  Modifier and Type Field Description
  
  static java.lang.String INTERNAL_COMMENT
  
  static java.lang.String PUBLIC_COMMENT
  - Fields inherited from class pl.edu.icm.unity.base.msgtemplates.reg.BaseRegistrationTemplateDef
    FORM_NAME, REQUEST_ID
  - Fields inherited from interface pl.edu.icm.unity.base.msgtemplates.MessageTemplateDefinition
    CUSTOM_VAR_PREFIX, INCLUDE_PREFIX
- Constructor Summary
  
  Constructors
  Constructor Description
  
  RegistrationWithCommentsTemplateDef(java.lang.String name, java.lang.String descriptionKey)
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  java.util.Map<java.lang.String,MessageTemplateVariable> getVariables()
  - Methods inherited from class pl.edu.icm.unity.base.msgtemplates.reg.BaseRegistrationTemplateDef
    getCompatibleTechnologies, getDescriptionKey, getName
  - 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
  - PUBLIC_COMMENT
```
public static final java.lang.String PUBLIC_COMMENT
```
    See Also:
    
    Constant Field Values
  - INTERNAL_COMMENT
```
public static final java.lang.String INTERNAL_COMMENT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - RegistrationWithCommentsTemplateDef
```
public RegistrationWithCommentsTemplateDef(java.lang.String name,
                                           java.lang.String descriptionKey)
```
- Method Detail
  - getVariables
```
public java.util.Map<java.lang.String,MessageTemplateVariable> getVariables()
```
    Specified by:
    
    getVariables in interface MessageTemplateDefinition
    
    Overrides:
    
    getVariables in class BaseRegistrationTemplateDef
    
    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.