com.communote.server.core.template

Class NoteTemplateDefinition

java.lang.Object

com.communote.server.core.template.NoteTemplateDefinition

Direct Known Subclasses:

ActivityDefinition

public class NoteTemplateDefinition
extends Object

Apart from user generated content notes can also have predefined content that is based on a template. This object defines such a template.

Author:

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

Constructor Summary

Constructors

Constructor and Description
NoteTemplateDefinition(String templateId, LocalizedMessage templateName, LocalizedMessage template) Creates a new template definition with default expiration timeout of zero.
NoteTemplateDefinition(String templateId, LocalizedMessage templateName, LocalizedMessage template, long expirationTimeout) Creates a new template definition.

Method Summary

Modifier and Type	Method and Description
void	addTemplate(NoteRenderMode renderMode, LocalizedMessage template) Allows overriding the default template for other render modes.
long	getExpirationTimeout()
LocalizedMessage	getTemplate()
LocalizedMessage	getTemplate(NoteRenderMode renderMode) Like getTemplate() but return a template that was explicitly added via addTemplate(NoteRenderMode, LocalizedMessage) for the given renderMode.
String	getTemplateId()
LocalizedMessage	getTemplateName()
boolean	hasTemplate(NoteRenderMode renderMode) Test whether the definition has a template for the given render mode.
void	removeTemplate(NoteRenderMode renderMode) Removes a template previously added with addTemplate(NoteRenderMode, LocalizedMessage).
void	setExpirationTimeout(long timeout) Sets the expiration timeout.
void	setPropertiesValidator(NoteTemplatePropertiesValidator validator) Sets the validator to be used for validating the template properties.
void	validateProperties(Map<String,Object> templatePropertiesJSON) Validates the template properties using the validator of this definition, in case there is one.

Methods inherited from class java.lang.Object

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

Constructor Detail

NoteTemplateDefinition

public NoteTemplateDefinition(String templateId,
                              LocalizedMessage templateName,
                              LocalizedMessage template)

Creates a new template definition with default expiration timeout of zero.

Parameters:

templateId - an ID which uniquely identifies the template

templateName - a localizable name of the template

template - the actual template. This will be the default template.

NoteTemplateDefinition

public NoteTemplateDefinition(String templateId,
                              LocalizedMessage templateName,
                              LocalizedMessage template,
                              long expirationTimeout)

Creates a new template definition.

Parameters:

templateId - an ID which uniquely identifies the template

templateName - a localizable name of the template

template - the actual template. This will be the default template.

expirationTimeout - a timeout in milliseconds after which a note that uses this template should expire

Method Detail

addTemplate

public void addTemplate(NoteRenderMode renderMode,
                        LocalizedMessage template)

Allows overriding the default template for other render modes.

Parameters:

renderMode - the render mode for which the provided template should be used

template - the template to use

getExpirationTimeout

public long getExpirationTimeout()

Returns:

a timeout in milliseconds after which a note that uses this template should expire automatically. Expire in this context means that the note should be deleted automatically. A return value of zero or less means that the note won't expire.

getTemplate

public LocalizedMessage getTemplate()

Returns:

the actual template. The template can be static or localizable text. The value of the template will be passed to a Velocity engine and thus can contain Velocity markup.

getTemplate

public LocalizedMessage getTemplate(NoteRenderMode renderMode)

Like getTemplate() but return a template that was explicitly added via addTemplate(NoteRenderMode, LocalizedMessage) for the given renderMode. If there is no template for that renderMode the default template will be returned.

Parameters:

renderMode - the renderMode for which the template should be retrieved, if null the default template is returned.

Returns:

the template

getTemplateId

public String getTemplateId()

Returns:

an ID which uniquely identifies the template definition. For assigning a note with this template the templateId must be stored in the note properties.

getTemplateName

public LocalizedMessage getTemplateName()

Returns:

a localizable name of the template. Could for instance be used for configuration screens and similar.

hasTemplate

public boolean hasTemplate(NoteRenderMode renderMode)

Test whether the definition has a template for the given render mode.

Parameters:

renderMode - the render mode to test

Returns:

true if a template was added via addTemplate(NoteRenderMode, LocalizedMessage) for the given render mode

removeTemplate

public void removeTemplate(NoteRenderMode renderMode)

Removes a template previously added with addTemplate(NoteRenderMode, LocalizedMessage). If there is no template for the renderMode nothing will happen.

Parameters:

renderMode - the renderMode for which an added template should be removed

setExpirationTimeout

public void setExpirationTimeout(long timeout)

Sets the expiration timeout.

Parameters:

timeout - a timeout in milliseconds after which a note that uses this template should expire (be deleted) automatically. A value of zero or less means no expiration.

setPropertiesValidator

public void setPropertiesValidator(NoteTemplatePropertiesValidator validator)

Sets the validator to be used for validating the template properties.

Parameters:

validator - the validator

validateProperties

public void validateProperties(Map<String,Object> templatePropertiesJSON)
                        throws NoteTemplatePropertiesValidationException

Validates the template properties using the validator of this definition, in case there is one.

Parameters:

templatePropertiesJSON - the JSON object, as nested map, holding the properties that should be validated, can be null. Any modifications made to the object won't be persisted.

Throws:

NoteTemplatePropertiesValidationException - in case the validation failed