com.communote.server.core.blog

Interface NoteManagement

All Known Implementing Classes:

NoteManagementBase, NoteManagementImpl

public interface NoteManagement

Management class for notes.

Note: Usage of this class directly is prohibited. To avoid errors NoteService should be used.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONSTANT_MENTION_DISCUSSION_PARTICIPANTS Pattern used for mention all discussion participants.
static String	CONSTANT_MENTION_TOPIC_AUTHORS Pattern used for mention all users with at least one note within the topic.
static String	CONSTANT_MENTION_TOPIC_MANAGERS Pattern used for mention all managers of the topic.
static String	CONSTANT_MENTION_TOPIC_READERS Pattern used for mention all users with at least read access to the topic.
static String	USER_NOTE_PROPERTY_KEY_LIKE Property key for the like feature.

Method Summary

Modifier and Type	Method and Description
void	correctTopicOfComment(Long noteId) Corrects the topic of a comment note if it does not equal the topic of the discussion root note.
NoteModificationResult	createNote(NoteStoringTO noteStoringTO, Set<String> additionalBlogNameIds) Creates a note from the supplied transfer object.
void	deleteAutosave(Long noteId) Deletes an autosave identified by the passed ID.
void	deleteNote(Long noteId, boolean deleteSystemPosts, boolean clientManagerCanDelete) Deletes a user tagged post and all its comments.
Set<Long>	deleteNotesOfUser(Long userId) Delete all notes and drafts of a user.
AutosaveNoteData	getAutosave(Long noteId, Long parentNoteId, Collection<StringPropertyTO> properties, Locale locale) Return an autosave of the current user.
List<SimpleNoteListItem>	getCommentsOfDiscussion(Long noteId) Returns all the notes of a discussion excluding the root note.
Long	getDiscussionId(Long noteId) Returns the ID of the discussion the note is part of.
<T> T	getNote(Long noteId, Converter<Note,T> converter) Method to get a specific note.
NoteData	getNote(long noteId, NoteRenderContext renderContext)
long	getNoteCount() Returns the number of notes created within the current client.
DiscussionNoteData	getNoteWithComments(Long noteId, QueryResultConverter<SimpleNoteListItem,DiscussionNoteData> converter) Returns a note with its comments which are ordered according to the provided converter.
int	getNumberOfNotesInDiscussion(Long noteId) Returns the number of notes in a discussion.
int	getNumberOfReplies(Long noteId) Returns the number of replies to a note.
void	moveToTopic(Long discussionId, Long topicId) Method to move a given discussion to another topic.
boolean	noteExists(Long noteId) Checks whether a note exists.
void	updateFollowableItems(Long noteId, boolean updateChildren) Update the followable items of a given note and optionally although of its children.
void	updateLastDiscussionCreationDate(Long noteId, Timestamp creationDate) Method to update the last discussion creation date.
NoteModificationResult	updateNote(NoteStoringTO noteStoringTO, Long noteId, Set<String> additionalBlogNameIds) Updates an existing note with the data of the supplied transfer object.

Field Detail

CONSTANT_MENTION_DISCUSSION_PARTICIPANTS

static final String CONSTANT_MENTION_DISCUSSION_PARTICIPANTS

Pattern used for mention all discussion participants.

See Also:

Constant Field Values

CONSTANT_MENTION_TOPIC_MANAGERS

static final String CONSTANT_MENTION_TOPIC_MANAGERS

Pattern used for mention all managers of the topic.

See Also:

Constant Field Values

CONSTANT_MENTION_TOPIC_AUTHORS

static final String CONSTANT_MENTION_TOPIC_AUTHORS

Pattern used for mention all users with at least one note within the topic.

See Also:

Constant Field Values

CONSTANT_MENTION_TOPIC_READERS

static final String CONSTANT_MENTION_TOPIC_READERS

Pattern used for mention all users with at least read access to the topic.

See Also:

Constant Field Values

USER_NOTE_PROPERTY_KEY_LIKE

static final String USER_NOTE_PROPERTY_KEY_LIKE

Property key for the like feature.

See Also:

Constant Field Values

Method Detail

correctTopicOfComment

void correctTopicOfComment(Long noteId)

Corrects the topic of a comment note if it does not equal the topic of the discussion root note. This method helps to resolve inconsistent discussions if move and edit or comment operations ran concurrently.

Parameters:

noteId - ID of the comment note that was created or updated

createNote

NoteModificationResult createNote(NoteStoringTO noteStoringTO,
                                  Set<String> additionalBlogNameIds)
                           throws BlogNotFoundException,
                                  NoteManagementAuthorizationException,
                                  NoteStoringPreProcessorException

Creates a note from the supplied transfer object.

Parameters:

noteStoringTO - The note to create.

additionalBlogNameIds - set of blog aliases for creating crossposts. These aliases will be ignore, if the note is a comment to another note.

Returns:

The result of this operation.

Throws:

BlogNotFoundException - in case the target blog does not exist

NoteManagementAuthorizationException - in case the user is not authorized to create the note, for instance if he has no write access to the target blog

NoteStoringPreProcessorException - in case one of the pre processors failed

deleteAutosave

void deleteAutosave(Long noteId)
             throws NoteManagementAuthorizationException

Deletes an autosave identified by the passed ID. In case there is no autosaved note with this ID nothing will happen.

Parameters:

noteId - The notes id.

Throws:

NoteManagementAuthorizationException - Thrown, when it is not possible to access the note.

deleteNote

void deleteNote(Long noteId,
                boolean deleteSystemPosts,
                boolean clientManagerCanDelete)
         throws NoteManagementAuthorizationException

Deletes a user tagged post and all its comments.

Parameters:

noteId - Id of the note to delete.

deleteSystemPosts - If true system notes will also be deleted.

clientManagerCanDelete - If true notes will also be deleted, if the current user is a client manager.

Throws:

NoteManagementAuthorizationException - Thrown, when the user is not allowed to access the note.

deleteNotesOfUser

Set<Long> deleteNotesOfUser(Long userId)
                     throws AuthorizationException

Delete all notes and drafts of a user. If one of these notes has comments it is not deleted, the content is anonymized instead to preserve the discussion. Additional note data like attachments, mentions and tags are removed.

Parameters:

userId - ID of the user whose notes should be deleted

Returns:

the IDs of the discussions which were modified because of the removal of notes

Throws:

AuthorizationException - in case the current user is not the internal system user, the client manager or the creator of the notes

getAutosave

AutosaveNoteData getAutosave(Long noteId,
                             Long parentNoteId,
                             Collection<StringPropertyTO> properties,
                             Locale locale)

Return an autosave of the current user. The parameters noteId and parentNoteId can be used to retrieve an autosave for an edit operation or a comment.

Parameters:

noteId - the ID of a note to get the autosave of the edit operation of this note. Can be null.

parentNoteId - the ID of a parent note to get the autosave of a comment to this note. Can be null.

properties - properties which should be used to get filters for finding an autosave. The filters are resolved with the help of the registered AutosavePropertyFilterProvider the re Can be null.

locale - the locale to use when filling localizable content of the note like tags

Returns:

the autosave or null if there is none

getCommentsOfDiscussion

List<SimpleNoteListItem> getCommentsOfDiscussion(Long noteId)
                                          throws NoteNotFoundException

Returns all the notes of a discussion excluding the root note. Notes the current user is not allowed to read, i.e. direct messages that were not sent to that user, won't be included either. It is assumed that the provided user has read access to the blog of the notes. The returned comments are sorted by the creation date in ascending order.

Parameters:

noteId - the ID of the note whose discussion will be evaluated

Returns:

the notes in the discussion

Throws:

NoteNotFoundException - in case the note does not exist

getDiscussionId

Long getDiscussionId(Long noteId)
              throws NoteNotFoundException

Returns the ID of the discussion the note is part of.

Parameters:

noteId - the ID of the note for which the discussion ID should be returned

Returns:

the discussion ID

Throws:

NoteNotFoundException - in case the note does not exist

getNote

NoteData getNote(long noteId,
                 NoteRenderContext renderContext)
          throws NoteNotFoundException,
                 AuthorizationException

Parameters:

noteId - The note id.

renderContext - The rendering context. If the render mode of the context is null, no NoteRenderingPreProcessors will be called.

Returns:

The note as NoteData.

Throws:

NoteNotFoundException - Thrown, when there is no note for this id.

AuthorizationException - Thrown, when the user is not allowed to access the note.

getNote

<T> T getNote(Long noteId,
              Converter<Note,T> converter)

Method to get a specific note.

Type Parameters:

T - Type of the return value.

Parameters:

noteId - The notes id.

converter - The converter to convert the note.

Returns:

The note in the desired converter output or null, if none.

getNoteCount

long getNoteCount()

Returns the number of notes created within the current client.

Returns:

The actual count of notes.

getNoteWithComments

DiscussionNoteData getNoteWithComments(Long noteId,
                                       QueryResultConverter<SimpleNoteListItem,DiscussionNoteData> converter)
                                throws NoteNotFoundException,
                                       AuthorizationException

Returns a note with its comments which are ordered according to the provided converter.

Parameters:

noteId - the id of the note to retrieve

converter - the converter to use for filling the comments

Returns:

the object holding the data of the note

Throws:

NoteNotFoundException - if the requested note does not exist

AuthorizationException - if the current user has no read access to the note

getNumberOfNotesInDiscussion

int getNumberOfNotesInDiscussion(Long noteId)
                          throws NoteNotFoundException

Returns the number of notes in a discussion. Notes the current user is not allowed to read, i.e. direct messages that were not sent to that user, are not included. It is assumed that the provided user has read access to the blog.

Parameters:

noteId - the ID of the note whose discussion will be evaluated

Returns:

the number of notes in the discussion

Throws:

NoteNotFoundException - in case the note does not exist

getNumberOfReplies

int getNumberOfReplies(Long noteId)
                throws NoteNotFoundException

Returns the number of replies to a note. This includes replies on replies and also replies that are direct messages which the current user might not be able to read.

Parameters:

noteId - the ID of the note

Returns:

the number of replies

Throws:

NoteNotFoundException - Thrown, when the note doesn't exist.

moveToTopic

void moveToTopic(Long discussionId,
                 Long topicId)
          throws NoteManagementAuthorizationException

Method to move a given discussion to another topic.

Parameters:

discussionId - Id of the discussion to move.

topicId - If of the new topic.

Throws:

NoteManagementAuthorizationException - Thrown, when the use isn't allowed to write within the given topic.

noteExists

boolean noteExists(Long noteId)

Checks whether a note exists. It is not checked whether the current user has read access to the note.

Parameters:

noteId - the ID of the note to retrieve

Returns:

true if the note exists, false otherwise

updateFollowableItems

void updateFollowableItems(Long noteId,
                           boolean updateChildren)

Update the followable items of a given note and optionally although of its children.

Parameters:

noteId - Id of the note to update.

updateChildren - If true, all children will be updated too.

updateLastDiscussionCreationDate

void updateLastDiscussionCreationDate(Long noteId,
                                      Timestamp creationDate)

Method to update the last discussion creation date.

Parameters:

noteId - Id of the note, which is part of the discussion.

creationDate - The new date to set.

updateNote

NoteModificationResult updateNote(NoteStoringTO noteStoringTO,
                                  Long noteId,
                                  Set<String> additionalBlogNameIds)
                           throws BlogNotFoundException,
                                  NoteNotFoundException,
                                  NoteManagementAuthorizationException,
                                  NoteStoringPreProcessorException

Updates an existing note with the data of the supplied transfer object.

Parameters:

noteStoringTO - The note to create.

noteId - the ID of the note to update

additionalBlogNameIds - set of blog aliases for creating crossposts. These aliases will be ignore, if the note is a comment to another note.

Returns:

The result of this operation.

Throws:

BlogNotFoundException - in case the target blog does not exist

NoteNotFoundException - in case the note to update does not exist

NoteManagementAuthorizationException - in case the user is not authorized to update the note, for instance if he has no write access to the blog or is not the author of the note

NoteStoringPreProcessorException - in case one of the pre processors failed

Since:

3.5