com.communote.plugins.mq.message.core.data.note

Class TemplateNote

java.lang.Object

com.communote.plugins.mq.message.core.data.note.Note

com.communote.plugins.mq.message.core.data.note.TemplateNote

public class TemplateNote
extends Note

POJO for easier creation of template and activity notes

Author:

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

Field Summary

Fields inherited from class com.communote.plugins.mq.message.core.data.note.Note

CONTENT_TYPE_HTML, CONTENT_TYPE_PLAIN_TEXT, CONTENT_TYPE_UNKNOWN

Constructor Summary

Constructors

Constructor and Description
TemplateNote()

Method Summary

Modifier and Type	Method and Description
StringProperty[]	getProperties()
boolean	isActivity()
void	setActivity(boolean activity) Set whether the note is an activity.
void	setProperties(StringProperty[] properties) Set the properties which should be added to the note
void	setTemplateId(String templateId) Set the ID of the template/activity that should be used for the note.
void	setTemplateProperties(String templateProperties) Set the properties that should be passed to the template engine.

Methods inherited from class com.communote.plugins.mq.message.core.data.note.Note

getContent, getContentType, getCreationDate, getParentNoteId, getTags, getTopics, getUnparsedTags, getUsersToNotify, isDirectMessage, isMentionDiscussionAuthors, isMentionTopicAuthors, isMentionTopicManagers, isMentionTopicReaders, setContent, setContentType, setCreationDate, setDirectMessage, setMentionDiscussionAuthors, setMentionTopicAuthors, setMentionTopicManagers, setMentionTopicReaders, setParentNoteId, setTags, setTopics, setUnparsedTags, setUsersToNotify

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateNote

public TemplateNote()

Method Detail

getProperties

public StringProperty[] getProperties()

Overrides:

getProperties in class Note

Returns:

the properties to add to the note, can be null

isActivity

public boolean isActivity()

Overrides:

isActivity in class Note

Returns:

whether the note is an activity. Returns false by default. Subclasses should override it if they support activities.

setActivity

public void setActivity(boolean activity)

Set whether the note is an activity.

Parameters:

activity - true if the note is an activity

setProperties

public void setProperties(StringProperty[] properties)

Description copied from class: Note

Set the properties which should be added to the note

Overrides:

setProperties in class Note

Parameters:

properties - the properties to add to the note

setTemplateId

public void setTemplateId(String templateId)

Set the ID of the template/activity that should be used for the note. If called, the note property required for creating a template note will be added automatically to the properties returned by getProperties().

Parameters:

templateId - the ID of the template

setTemplateProperties

public void setTemplateProperties(String templateProperties)

Set the properties that should be passed to the template engine. The value is expected to be a string in JSON. If called, the note property holding the templateProperties will be added automatically to the properties returned by getProperties().

Parameters:

templateProperties - the properties to passed to the template engine