NoteData (Communote 3.5 API)

java.lang.Object
- com.communote.server.api.core.common.IdentifiableEntityData
- - com.communote.server.api.core.note.NoteData

All Implemented Interfaces:

Matchable, StringPropertyableTO, Serializable

Direct Known Subclasses:

AutosaveNoteData, DiscussionNoteData
```
public class NoteData
extends IdentifiableEntityData
implements StringPropertyableTO, Matchable
```
Value object holding the data of a note.

Author:

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

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

NoteData()

Constructors
Constructor and Description
`NoteData()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addObjectProperty(StringPropertyTO property)` Add an object property.
`List<AttachmentData>`	`getAttachments()`
`List<AttachmentData>`	`getAttachments(String filter)` Returns a MIME type filtered subset of the attachments that were added to the note.
`UserBlogData`	`getBlog()`
`String`	`getContent()`
`Date`	`getCreationDate()`
`NoteCreationSource`	`getCreationSource()`
`int`	`getDiscussionDepth()`
`Long`	`getDiscussionId()`
`String`	`getDiscussionPath()`
`Date`	`getLastDiscussionCreationDate()`
`Date`	`getLastModificationDate()`
`List<DetailedUserData>`	`getNotifiedUsers()`
`int`	`getNumberOfComments()` Returns the number of replies to this note.
`int`	`getNumberOfDiscussionNotes()` Returns the number of notes in the discussion this note is part of.
`Set<StringPropertyTO>`	`getObjectProperties()` This method return the properties of the object
`NoteData`	`getParent()`
`Set<Permission<Note>>`	`getPermissions()`
`String`	`getShortContent()`
`List<TagData>`	`getTags()`
`DetailedUserData`	`getUser()`
`Long`	`getVersion()`
`boolean`	`hasPermission(Permission<Note> permission)` Checks, if the note has the given permission.
`boolean`	`hasPermission(String permissionIdentifier)` Checks, if the note has the given permission.
`boolean`	`isCommentable()` Returns whether the current user can reply to this note.
`boolean`	`isDeletable()` Whether the current user can delete this note.
`boolean`	`isDirect()`
`boolean`	`isEditable()`
`boolean`	`isFavorite()`
`boolean`	`isForMe()`
`boolean`	`isMatched()` Method to get the matching status of the entity.
`boolean`	`isMentionDiscussionAuthors()`
`boolean`	`isMentionTopicAuthors()`
`boolean`	`isMentionTopicManagers()`
`boolean`	`isMentionTopicReaders()`
`boolean`	`isRepostable()`
`boolean`	`isSystemNote()`
`void`	`setAttachments(List<AttachmentData> attachments)`
`void`	`setBlog(UserBlogData blog)`
`void`	`setContent(String content)`
`void`	`setCreationDate(Date creationDate)`
`void`	`setCreationSource(NoteCreationSource creationSource)`
`void`	`setDirect(boolean direct)`
`void`	`setDiscussionDepth(int discussionDepth)`
`void`	`setDiscussionId(Long discussionId)`
`void`	`setDiscussionPath(String discussionPath)`
`void`	`setFavorite(boolean favorite)`
`void`	`setForMe(boolean forMe)`
`void`	`setLastDiscussionCreationDate(Date lastDiscussionCreationDate)`
`void`	`setLastModificationDate(Date lastModificationDate)`
`void`	`setMatched(boolean matching)` Method to set the matching status of the entity.
`void`	`setMentionDiscussionAuthors(boolean mentionDiscussionAuthors)`
`void`	`setMentionTopicAuthors(boolean mentionTopicAuthors)`
`void`	`setMentionTopicManagers(boolean mentionTopicManagers)`
`void`	`setMentionTopicReaders(boolean mentionTopicReaders)`
`void`	`setNotifiedUsers(List<DetailedUserData> notifiedUsers)`
`void`	`setNumberOfComments(int numberOfComments)` Sets the number of replies to this note.
`void`	`setNumberOfDiscussionNotes(int numberOfDiscussionNotes)` Set the number of notes in the discussion this note belongs to.
`void`	`setObjectProperties(Set<StringPropertyTO> properties)` Set the properties of the note.
`void`	`setParent(NoteData parent)`
`void`	`setPermissions(Set<Permission<Note>> permissions)`
`void`	`setShortContent(String shortContent)`
`void`	`setSystemNote(boolean systemNote)`
`void`	`setTags(List<TagData> tags)`
`void`	`setUser(DetailedUserData user)`
`void`	`setVersion(Long version)`

Methods inherited from class com.communote.server.api.core.common.IdentifiableEntityData
copy, equals, getId, getProperties, getProperty, hashCode, setId, setProperty

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - NoteData
```
public NoteData()
```
- Method Detail
  - addObjectProperty
```
public void addObjectProperty(StringPropertyTO property)
```
    Add an object property.
    
    Parameters:
    
    property - the property to add
  - getAttachments
```
public List<AttachmentData> getAttachments()
```
    Returns:
    
    a collection with details about the attachments that were added to the note
  - getAttachments
```
public List<AttachmentData> getAttachments(String filter)
```
    Returns a MIME type filtered subset of the attachments that were added to the note.
    
    Parameters:
    
    filter - a regular expression the MIME type must match for the attachment to be included
    
    Returns:
    
    the filtered attachments
  - getBlog
```
public UserBlogData getBlog()
```
    Returns:
    
    a list item with details about the blog of the note
  - getContent
```
public String getContent()
```
    Returns:
    
    the content of the note
  - getCreationDate
```
public Date getCreationDate()
```
    Returns:
    
    the date the note was created
  - getCreationSource
```
public NoteCreationSource getCreationSource()
```
    Returns:
    
    the source which sent the note
  - getDiscussionDepth
```
public int getDiscussionDepth()
```
    Returns:
    
    the depth of the note within the discussion. The root note of the discussion has depth 0. A reply on the root note note has depth 1, a reply on that reply depth 2 and so on.
  - getDiscussionId
```
public Long getDiscussionId()
```
    Returns:
    
    the ID of the discussion the note belongs to
  - getDiscussionPath
```
public String getDiscussionPath()
```
    Returns:
    
    The discussionPath separated with spaces instead of forward slashes, i.e. "12 34 56".
  - getLastDiscussionCreationDate
```
public Date getLastDiscussionCreationDate()
```
    Returns:
    
    The date, the last note of this discussion was created.
  - getLastModificationDate
```
public Date getLastModificationDate()
```
    Returns:
    
    the date of the last modification of the note. This value will equal the creation date if the note wasn't modified yet.
  - getNotifiedUsers
```
public List<DetailedUserData> getNotifiedUsers()
```
    Returns:
    
    a collection with details about the users that were notified about the note
  - getNumberOfComments
```
public int getNumberOfComments()
```
    Returns the number of replies to this note. This includes replies on replies and also replies that are direct messages which the current user might not be able to read.
    
    Returns:
    
    the number of replies
  - getNumberOfDiscussionNotes
```
public int getNumberOfDiscussionNotes()
```
    Returns the number of notes in the discussion this note is part of. Notes the current user is not allowed to read, i.e. direct messages that were not sent to that user, are not included.
    
    Returns:
    
    the number of notes in the discussion
  - getObjectProperties
```
public Set<StringPropertyTO> getObjectProperties()
```
    This method return the properties of the object
    
    Specified by:
    
    getObjectProperties in interface StringPropertyableTO
    
    Returns:
    
    the properties of the object
  - getParent
```
public NoteData getParent()
```
    Returns:
    
    The parent of this note. The parent may not contain correct data about its children or allTags. Moreover, the parent of the parent usually won't be contained.
  - getPermissions
```
public Set<Permission<Note>> getPermissions()
```
    Returns:
    
    the permissions
  - getShortContent
```
public String getShortContent()
```
    Returns:
    
    a shortened version of the content of the note, can be null if the content was short enough so that no shortened content had to be generated
  - getTags
```
public List<TagData> getTags()
```
    Returns:
    
    the tags added to this note
  - getUser
```
public DetailedUserData getUser()
```
    Returns:
    
    an object with details about the author of the note
  - getVersion
```
public Long getVersion()
```
    Returns:
    
    the autosave version of the note
  - hasPermission
```
public boolean hasPermission(Permission<Note> permission)
```
    Checks, if the note has the given permission.
    
    Parameters:
    
    permission - The permission.
    
    Returns:
    
    True, if the NoteData has the given permission.
  - hasPermission
```
public boolean hasPermission(String permissionIdentifier)
```
    Checks, if the note has the given permission.
    
    Parameters:
    
    permissionIdentifier - The permissions identifier as string.
    
    Returns:
    
    True, if the NoteData has the given permission.
  - isCommentable
```
public boolean isCommentable()
```
    Returns whether the current user can reply to this note. This is only possible if the current user has write access to the blog of the note and it is not a system note. Moreover, the author of the note must not have been anonymized.
    
    Returns:
    
    true if the current user can reply to this note
  - isDeletable
```
public boolean isDeletable()
```
    Whether the current user can delete this note. Deleting is only possible if the current user is the manager of the blog or he is the author of the note and there are no comments to the note and it is not a direct message.
    
    Returns:
    
    true if the current user can delete this note, false otherwise
  - isDirect
```
public boolean isDirect()
```
    Returns:
    
    whether the note is a direct message
  - isEditable
```
public boolean isEditable()
```
    Returns:
    
    whether the current user can edit this note
  - isFavorite
```
public boolean isFavorite()
```
    Returns:
    
    whether the current user marked the note as a favorite
  - isForMe
```
public boolean isForMe()
```
    Returns:
    
    whether the current user was one of the notified users
  - isMatched
```
public boolean isMatched()
```
    Method to get the matching status of the entity.
    
    Specified by:
    
    isMatched in interface Matchable
    
    Returns:
    
    True, if the entity was matched by a matcher.
  - 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
  - isRepostable
```
public boolean isRepostable()
```
    Returns:
    
    whether the note can be reposted by other users. Will be true if the note has the REPOST permission, false otherwise.
  - isSystemNote
```
public boolean isSystemNote()
```
    Returns:
    
    whether this is a system note
  - setAttachments
```
public void setAttachments(List<AttachmentData> attachments)
```
    Parameters:
    
    attachments - the attachments that were added to the note
  - setBlog
```
public void setBlog(UserBlogData blog)
```
    Parameters:
    
    blog - the blog to set
  - setContent
```
public void setContent(String content)
```
    Parameters:
    
    content - the content to set
  - setCreationDate
```
public void setCreationDate(Date creationDate)
```
    Parameters:
    
    creationDate - the creation date of the note
  - setCreationSource
```
public void setCreationSource(NoteCreationSource creationSource)
```
    Parameters:
    
    creationSource - the source which sent the note
  - setDirect
```
public void setDirect(boolean direct)
```
    Parameters:
    
    direct - true if this note is a direct message, false otherwise
  - setDiscussionDepth
```
public void setDiscussionDepth(int discussionDepth)
```
    Parameters:
    
    discussionDepth - the depth of the note within the discussion
    
    See Also:
    
    getDiscussionDepth()
  - setDiscussionId
```
public void setDiscussionId(Long discussionId)
```
    Parameters:
    
    discussionId - the ID of the discussion this note is a part of
  - setDiscussionPath
```
public void setDiscussionPath(String discussionPath)
```
    Parameters:
    
    discussionPath - a string that contains all the IDs of the parent notes of this note up to the root note separated by a slash or space character. The string is expected to start with the ID of the root note of the discussion.
  - setFavorite
```
public void setFavorite(boolean favorite)
```
    Parameters:
    
    favorite - true if the current user marked this note as a favorite, false otherwise
  - setForMe
```
public void setForMe(boolean forMe)
```
    Parameters:
    
    forMe - true if the current user was one of the notified users, false otherwise
  - setLastDiscussionCreationDate
```
public void setLastDiscussionCreationDate(Date lastDiscussionCreationDate)
```
    Parameters:
    
    lastDiscussionCreationDate - the lastDiscussionCreationDate to set
  - setLastModificationDate
```
public void setLastModificationDate(Date lastModificationDate)
```
    Parameters:
    
    lastModificationDate - the date of the last modification of the note
  - setMatched
```
public void setMatched(boolean matching)
```
    Method to set the matching status of the entity.
    
    Specified by:
    
    setMatched in interface Matchable
    
    Parameters:
    
    matching - True, if this item matches the matcher.
  - 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
  - setNotifiedUsers
```
public void setNotifiedUsers(List<DetailedUserData> notifiedUsers)
```
    Parameters:
    
    notifiedUsers - the users that were notified about the note
  - setNumberOfComments
```
public void setNumberOfComments(int numberOfComments)
```
    Sets the number of replies to this note. This must include replies on replies and also replies that are direct messages which the current user might not be able to read.
    
    Parameters:
    
    numberOfComments - the number of replies
  - setNumberOfDiscussionNotes
```
public void setNumberOfDiscussionNotes(int numberOfDiscussionNotes)
```
    Set the number of notes in the discussion this note belongs to. Notes the current user is not allowed to read, i.e. direct messages that were not sent to that user, must not be included.
    
    Parameters:
    
    numberOfDiscussionNotes - the number of notes in the discussion
  - setObjectProperties
```
public void setObjectProperties(Set<StringPropertyTO> properties)
```
    Set the properties of the note.
    
    Parameters:
    
    properties - the properties
  - setParent
```
public void setParent(NoteData parent)
```
    Parameters:
    
    parent - the parent note of the note
  - setPermissions
```
public void setPermissions(Set<Permission<Note>> permissions)
```
    Parameters:
    
    permissions - the permissions to set
  - setShortContent
```
public void setShortContent(String shortContent)
```
    Parameters:
    
    shortContent - a shortened version of the content of the note, can be null if there there is no short version
  - setSystemNote
```
public void setSystemNote(boolean systemNote)
```
    Parameters:
    
    systemNote - true if the note is a system note, false otherwise
  - setTags
```
public void setTags(List<TagData> tags)
```
    Parameters:
    
    tags - the tags of the note
  - setUser
```
public void setUser(DetailedUserData user)
```
    Parameters:
    
    user - the author of the note
  - setVersion
```
public void setVersion(Long version)
```
    Parameters:
    
    version - the autosave version of the note

Class NoteData

Constructor Summary

Method Summary

Methods inherited from class com.communote.server.api.core.common.IdentifiableEntityData

Methods inherited from class java.lang.Object

Constructor Detail

NoteData

Method Detail

addObjectProperty

getAttachments

getAttachments

getBlog

getContent

getCreationDate

getCreationSource

getDiscussionDepth

getDiscussionId

getDiscussionPath

getLastDiscussionCreationDate

getLastModificationDate

getNotifiedUsers

getNumberOfComments

getNumberOfDiscussionNotes

getObjectProperties

getParent

getPermissions

getShortContent

getTags

getUser

getVersion

hasPermission

hasPermission

isCommentable

isDeletable

isDirect

isEditable

isFavorite

isForMe

isMatched

isMentionDiscussionAuthors

isMentionTopicAuthors

isMentionTopicManagers

isMentionTopicReaders

isRepostable

isSystemNote

setAttachments

setBlog

setContent

setCreationDate

setCreationSource

setDirect

setDiscussionDepth

setDiscussionId

setDiscussionPath

setFavorite

setForMe

setLastDiscussionCreationDate

setLastModificationDate

setMatched

setMentionDiscussionAuthors

setMentionTopicAuthors

setMentionTopicManagers

setMentionTopicReaders

setNotifiedUsers

setNumberOfComments

setNumberOfDiscussionNotes

setObjectProperties

setParent

setPermissions

setShortContent

setSystemNote

setTags

setUser

setVersion