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

Class Note

java.lang.Object

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

Direct Known Subclasses:

TemplateNote

public class Note
extends Object

POJO holding the data of a note.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENT_TYPE_HTML constant for the content type that should be used if the content is HTML
static String	CONTENT_TYPE_PLAIN_TEXT constant for the content type that should be used if the content is plain text
static String	CONTENT_TYPE_UNKNOWN constant for the content type that should be used if the type of the content is not known and the server should try figure it out

Constructor Summary

Constructors

Constructor and Description
Note()

Method Summary

Modifier and Type	Method and Description
String	getContent()
String	getContentType()
Date	getCreationDate()
Long	getParentNoteId()
StringProperty[]	getProperties()
Tag[]	getTags()
BaseTopic[]	getTopics()
String	getUnparsedTags()
BaseEntity[]	getUsersToNotify()
boolean	isActivity()
boolean	isDirectMessage()
boolean	isMentionDiscussionAuthors()
boolean	isMentionTopicAuthors()
boolean	isMentionTopicManagers()
boolean	isMentionTopicReaders()
void	setContent(String content) Set the content of the note
void	setContentType(String contentType) Set the content type of the note.
void	setCreationDate(Date creationDate)
void	setDirectMessage(boolean directMessage) Set whether the note is a direct message
void	setMentionDiscussionAuthors(boolean mentionDiscussionAuthors)
void	setMentionTopicAuthors(boolean mentionTopicAuthors)
void	setMentionTopicManagers(boolean mentionTopicManagers)
void	setMentionTopicReaders(boolean mentionTopicReaders)
void	setParentNoteId(Long parentNoteId) Set the ID of a note this note should be created as a comment of.
void	setProperties(StringProperty[] properties) Set the properties which should be added to the note
void	setTags(Tag[] tags) Set the tags to be added to the note
void	setTopics(BaseTopic[] topics) Set the topics the note should be created in.
void	setUnparsedTags(String unparsedTags) Set a comma separated string of tag names which will be resolved to note tags
void	setUsersToNotify(BaseEntity[] usersToNotify) Set the users that should be notified about the note

Methods inherited from class java.lang.Object

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

Field Detail

CONTENT_TYPE_UNKNOWN

public static final String CONTENT_TYPE_UNKNOWN

constant for the content type that should be used if the type of the content is not known and the server should try figure it out

See Also:

Constant Field Values

CONTENT_TYPE_PLAIN_TEXT

public static final String CONTENT_TYPE_PLAIN_TEXT

constant for the content type that should be used if the content is plain text

See Also:

Constant Field Values

CONTENT_TYPE_HTML

public static final String CONTENT_TYPE_HTML

constant for the content type that should be used if the content is HTML

See Also:

Constant Field Values

Constructor Detail

Note

public Note()

Method Detail

getContent

public String getContent()

Returns:

the content of the note

getContentType

public String getContentType()

Returns:

the content type of the note. Supported values are 'HTML', 'PLAIN_TEXT' and 'UNKNOWN'.

getCreationDate

public Date getCreationDate()

Returns:

the creation date of this note (use null and it will be the time of processing)

getParentNoteId

public Long getParentNoteId()

Returns:

the ID of the parent note. If not null the note is created as a comment to the note with the given ID.

getProperties

public StringProperty[] getProperties()

Returns:

the properties to add to the note, can be null

getTags

public Tag[] getTags()

Returns:

the tags to be added to the note

getTopics

public BaseTopic[] getTopics()

Returns:

the topics the note should be created in. The first topic is used as the target topic, the remaining as crosspost targets. There must be at least one topic.

getUnparsedTags

public String getUnparsedTags()

Returns:

comma separated string of tag names which will be resolved to note tags

getUsersToNotify

public BaseEntity[] getUsersToNotify()

Returns:

the users that should be notified, can be null

isActivity

public boolean isActivity()

Returns:

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

isDirectMessage

public boolean isDirectMessage()

Returns:

whether the note is a direct message

isMentionDiscussionAuthors

public boolean isMentionDiscussionAuthors()

Returns:

the mentionDiscussionAuthors

isMentionTopicAuthors

public boolean isMentionTopicAuthors()

Returns:

the mentionTopicAuthors

isMentionTopicManagers

public boolean isMentionTopicManagers()

Returns:

the mentionTopicManagers

isMentionTopicReaders

public boolean isMentionTopicReaders()

Returns:

the mentionTopicReaders

setContent

public void setContent(String content)

Set the content of the note

Parameters:

content - the content to set

setContentType

public void setContentType(String contentType)

Set the content type of the note. Supported values are 'HTML', 'PLAIN_TEXT' and 'UNKNOWN'.

Parameters:

contentType - the content type to set

setCreationDate

public void setCreationDate(Date creationDate)

Parameters:

creationDate - the creation date of this note (use null and it will be the time of processing)

setDirectMessage

public void setDirectMessage(boolean directMessage)

Set whether the note is a direct message

Parameters:

directMessage - true if the note is a direct message, false if not

setMentionDiscussionAuthors

public void setMentionDiscussionAuthors(boolean mentionDiscussionAuthors)

Parameters:

mentionDiscussionAuthors - the mentionDiscussionAuthors to set

setMentionTopicAuthors

public void setMentionTopicAuthors(boolean mentionTopicAuthors)

Parameters:

mentionTopicAuthors - the mentionTopicAuthors to set

setMentionTopicManagers

public void setMentionTopicManagers(boolean mentionTopicManagers)

Parameters:

mentionTopicManagers - the mentionTopicManagers to set

setMentionTopicReaders

public void setMentionTopicReaders(boolean mentionTopicReaders)

Parameters:

mentionTopicReaders - the mentionTopicReaders to set

setParentNoteId

public void setParentNoteId(Long parentNoteId)

Set the ID of a note this note should be created as a comment of.

Parameters:

parentNoteId - the ID of the parent note

setProperties

public void setProperties(StringProperty[] properties)

Set the properties which should be added to the note

Parameters:

properties - the properties to add to the note

setTags

public void setTags(Tag[] tags)

Set the tags to be added to the note

Parameters:

tags - the tags of the note

setTopics

public void setTopics(BaseTopic[] topics)

Set the topics the note should be created in. The first topic is used as the target topic, the remaining as crosspost targets. There must be at least one topic.

Parameters:

topics - the topics

setUnparsedTags

public void setUnparsedTags(String unparsedTags)

Set a comma separated string of tag names which will be resolved to note tags

Parameters:

unparsedTags - the unparsed tags

setUsersToNotify

public void setUsersToNotify(BaseEntity[] usersToNotify)

Set the users that should be notified about the note

Parameters:

usersToNotify - the users to notify