com.communote.server.api.core.note

Class NoteStoringTO

java.lang.Object

com.communote.server.api.core.note.NoteStoringTO

All Implemented Interfaces:

Serializable

public class NoteStoringTO
extends Object
implements Serializable

TO for notes.

Author:

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NoteStoringTO()

Method Summary

Modifier and Type	Method and Description
Set<String>	getAdditionalBlogs()
Long[]	getAttachmentIds()
Long	getAutosaveNoteId() public Long[] getAttachmentIds() { return this.attachmentIds; } /**
Long	getBlogId() The ID of the blog for which the post will be created.
String	getContent()
NoteContentType	getContentType() Describes the type of content hold within this StringContentTO.
Timestamp	getCreationDate() The creation date is the date as this NoteStoringTO got constructed.
NoteCreationSource	getCreationSource() Defines the source of creation.
Long	getCreatorId() The ID of the author of the post.
NoteStoringFailDefinition	getFailDefinition() Get the failDefinition
String	getLanguage() Language of post content.
Long	getParentNoteId()
Set<StringPropertyTO>	getProperties() String properties for this note.
Set<TagTO>	getTags()
Object	getTransientProperty(String key) Get the value of previously added transient property.
String	getUnparsedTags() A string holding all tags for this post separated by comma.
Set<String>	getUsersNotToNotify() List of user alias, which can't be notified.
Set<String>	getUsersToNotify() A set of alias strings of users that should be notified about the creation of the user tagged item.
Long	getVersion() The version.
boolean	isIsDirectMessage() If this is set, the message is a direct message.
boolean	isMentionDiscussionAuthors()
boolean	isMentionTopicAuthors()
boolean	isMentionTopicManagers()
boolean	isMentionTopicReaders()
boolean	isPublish() Whether to publish the note or create an autosave.
boolean	isSendNotifications() Whether to actually send notifications.
Object	removeTransientProperty(String key) Remove a previously added transient property.
void	setAdditionalBlogs(Set<String> additionalBlogs)
void	setAttachmentIds(Long[] attachmentIds)
void	setAutosaveNoteId(Long autosaveNoteId)
void	setBlogId(Long blogId)
void	setContent(String content)
void	setContentType(NoteContentType contentType)
void	setCreationDate(Timestamp creationDate)
void	setCreationSource(NoteCreationSource creationSource)
void	setCreatorId(Long creatorId)
void	setFailDefinition(NoteStoringFailDefinition failDefinition) Sets the failDefinition
void	setIsDirectMessage(boolean isDirectMessage)
void	setLanguage(String language)
void	setMentionDiscussionAuthors(boolean mentionDiscussionAuthors)
void	setMentionTopicAuthors(boolean mentionTopicAuthors)
void	setMentionTopicManagers(boolean mentionTopicManagers)
void	setMentionTopicReaders(boolean mentionTopicReaders)
void	setParentNoteId(Long parentNoteId)
void	setProperties(Set<StringPropertyTO> properties)
void	setPublish(boolean publish)
void	setSendNotifications(boolean sendNotifications)
void	setTags(Set<TagTO> tags)
void	setTransientProperty(String key, Object value) Add a property which will not be persisted with the note.
void	setUnparsedTags(String unparsedTags)
void	setUsersNotToNotify(Set<String> usersNotToNotify)
void	setUsersToNotify(Set<String> usersToNotify)
void	setVersion(Long version)

Methods inherited from class java.lang.Object

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

Constructor Detail

NoteStoringTO

public NoteStoringTO()

Method Detail

getAdditionalBlogs

public Set<String> getAdditionalBlogs()

Returns:

the additionalBlogs

getAttachmentIds

public Long[] getAttachmentIds()

Returns:

the attachmentIds

getAutosaveNoteId

public Long getAutosaveNoteId()

public Long[] getAttachmentIds() { return this.attachmentIds; } /**

getBlogId

public Long getBlogId()

The ID of the blog for which the post will be created.

getContent

public String getContent()

getContentType

public NoteContentType getContentType()

Describes the type of content hold within this StringContentTO. The type basically determines how the content will be interpreted and processed.

getCreationDate

public Timestamp getCreationDate()

The creation date is the date as this NoteStoringTO got constructed. If the note is an update it will be used as last modification date, and if it is a create as creation date.

Returns:

the creation date of this note, will never be null (is set on constructing or using setCreationDate(Timestamp)

getCreationSource

public NoteCreationSource getCreationSource()

Defines the source of creation.

getCreatorId

public Long getCreatorId()

The ID of the author of the post.

getFailDefinition

public NoteStoringFailDefinition getFailDefinition()

Get the failDefinition

getLanguage

public String getLanguage()

Language of post content.

getParentNoteId

public Long getParentNoteId()

Returns:

the parentNoteId

getProperties

public Set<StringPropertyTO> getProperties()

String properties for this note.

getTags

public Set<TagTO> getTags()

Returns:

the tags

getTransientProperty

public Object getTransientProperty(String key)

Get the value of previously added transient property.

Parameters:

key - the key of the property to get

Returns:

the value of the transient property or null if the property was not set

Since:

3.5

See Also:

setTransientProperty(String, Object)

getUnparsedTags

public String getUnparsedTags()

A string holding all tags for this post separated by comma.

getUsersNotToNotify

public Set<String> getUsersNotToNotify()

List of user alias, which can't be notified.

getUsersToNotify

public Set<String> getUsersToNotify()

A set of alias strings of users that should be notified about the creation of the user tagged item. Only those users whose alias is known within Communote will be notified.

getVersion

public Long getVersion()

The version.

isIsDirectMessage

public boolean isIsDirectMessage()

If this is set, the message is a direct message. Receivers will be in the list of users to be notified.

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

isPublish

public boolean isPublish()

Whether to publish the note or create an autosave.

isSendNotifications

public boolean isSendNotifications()

Whether to actually send notifications.

removeTransientProperty

public Object removeTransientProperty(String key)

Remove a previously added transient property.

Parameters:

key - the key of the property to remove

Returns:

the value of the removed property or null if there was no property for the key

Since:

3.5

See Also:

setTransientProperty(String, Object)

setAdditionalBlogs

public void setAdditionalBlogs(Set<String> additionalBlogs)

Parameters:

additionalBlogs - the additionalBlogs to set

setAttachmentIds

public void setAttachmentIds(Long[] attachmentIds)

Parameters:

attachmentIds - the attachmentIds to set

setAutosaveNoteId

public void setAutosaveNoteId(Long autosaveNoteId)

setBlogId

public void setBlogId(Long blogId)

setContent

public void setContent(String content)

setContentType

public void setContentType(NoteContentType contentType)

setCreationDate

public void setCreationDate(Timestamp creationDate)

Parameters:

creationDate - the creation date for the note, if null (default) it will be the current time

setCreationSource

public void setCreationSource(NoteCreationSource creationSource)

setCreatorId

public void setCreatorId(Long creatorId)

setFailDefinition

public void setFailDefinition(NoteStoringFailDefinition failDefinition)

Sets the failDefinition

setIsDirectMessage

public void setIsDirectMessage(boolean isDirectMessage)

setLanguage

public void setLanguage(String language)

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)

Parameters:

parentNoteId - the parentNoteId to set

setProperties

public void setProperties(Set<StringPropertyTO> properties)

setPublish

public void setPublish(boolean publish)

setSendNotifications

public void setSendNotifications(boolean sendNotifications)

setTags

public void setTags(Set<TagTO> tags)

Parameters:

tags - the tags to set

setTransientProperty

public void setTransientProperty(String key,
                                 Object value)

Add a property which will not be persisted with the note. This can for example be used to exchange information between a NoteStoringPreProcessor and a NoteStoringPostProcessor.

Parameters:

key - the key of the property. If there is already a property with that key it will be replaced.

value - the value of the property

Since:

3.5

setUnparsedTags

public void setUnparsedTags(String unparsedTags)

setUsersNotToNotify

public void setUsersNotToNotify(Set<String> usersNotToNotify)

setUsersToNotify

public void setUsersToNotify(Set<String> usersToNotify)

Parameters:

usersToNotify - A set of alias strings of users that should be notified about the creation of the user tagged item. Only those users whose alias is known within Communote will be notified.

setVersion

public void setVersion(Long version)