com.communote.server.core.blog

Class NoteManagementBase

java.lang.Object

com.communote.server.core.blog.NoteManagementBase

All Implemented Interfaces:

NoteManagement

Direct Known Subclasses:

NoteManagementImpl

@Transactional(propagation=REQUIRED)
public abstract class NoteManagementBase
extends Object
implements NoteManagement

Spring Service base class for NoteManagement, provides access to all services and entities referenced by this service.

Author:

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

See Also:

NoteService

Field Summary

Fields inherited from interface com.communote.server.core.blog.NoteManagement

CONSTANT_MENTION_DISCUSSION_PARTICIPANTS, CONSTANT_MENTION_TOPIC_AUTHORS, CONSTANT_MENTION_TOPIC_MANAGERS, CONSTANT_MENTION_TOPIC_READERS, USER_NOTE_PROPERTY_KEY_LIKE

Constructor Summary

Constructors

Constructor and Description
NoteManagementBase()

Method Summary

Modifier and Type	Method and Description
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.
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.
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.
protected Principal	getPrincipal() Gets the current principal if one has been set, otherwise returns null.
protected abstract NoteModificationResult	handleCreateNote(NoteStoringTO noteStoringTO, Set<String> additionalBlogNameIds) Performs the core logic for createNote(NoteStoringTO, Set)
protected abstract void	handleDeleteAutosave(Long noteId) Performs the core logic for deleteAutosave(Long)
protected abstract void	handleDeleteNote(Long noteId, boolean deleteSystemPosts, boolean clientManagerCanDelete) Performs the core logic for deleteNote(Long, boolean, boolean)
protected abstract Set<Long>	handleDeleteNotesOfUser(Long userId) Performs the core logic for deleteNotesOfUser(Long)
protected abstract List<SimpleNoteListItem>	handleGetCommentsOfDiscussion(Long noteId) Performs the core logic for getCommentsOfDiscussion(Long)
protected abstract Long	handleGetDiscussionId(Long noteId) Implementation of getDiscussionId(Long)
protected abstract DiscussionNoteData	handleGetNoteWithComments(Long noteId, QueryResultConverter<SimpleNoteListItem,DiscussionNoteData> converter) Performs the core logic for getNoteWithComments(Long, QueryResultConverter)
protected abstract int	handleGetNumberOfNotesInDiscussion(Long noteId) Performs the core logic for getNumberOfNotesInDiscussion(Long)
protected abstract int	handleGetNumberOfReplies(Long noteId) Performs the core logic for getNumberOfReplies(Long)
protected abstract NoteModificationResult	handleUpdateNote(NoteStoringTO noteStoringTO, Long noteId, Set<String> additionalBlogNameIds)
NoteModificationResult	updateNote(NoteStoringTO noteStoringTO, Long noteId, Set<String> additionalBlogNameIds) Updates an existing note with the data of the supplied transfer object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.communote.server.core.blog.NoteManagement

correctTopicOfComment, getAutosave, getNote, getNote, getNoteCount, moveToTopic, noteExists, updateFollowableItems, updateLastDiscussionCreationDate

Constructor Detail

NoteManagementBase

public NoteManagementBase()

Method Detail

createNote

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

Description copied from interface: NoteManagement

Creates a note from the supplied transfer object.

Specified by:

createNote in interface NoteManagement

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

public 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.

Specified by:

deleteAutosave in interface NoteManagement

Parameters:

noteId - The notes id.

Throws:

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

deleteNote

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

Deletes a user tagged post and all its comments.

Specified by:

deleteNote in interface NoteManagement

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

public 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.

Specified by:

deleteNotesOfUser in interface NoteManagement

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

getCommentsOfDiscussion

public 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.

Specified by:

getCommentsOfDiscussion in interface NoteManagement

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

@Transactional(readOnly=true)
public Long getDiscussionId(Long noteId)
                                                   throws NoteNotFoundException

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

Specified by:

getDiscussionId in interface NoteManagement

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

getNoteWithComments

@Transactional(readOnly=true)
public 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.

Specified by:

getNoteWithComments in interface NoteManagement

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

public 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.

Specified by:

getNumberOfNotesInDiscussion in interface NoteManagement

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

@Transactional(readOnly=true)
public int getNumberOfReplies(Long noteId)
                                                     throws NoteNotFoundException

Description copied from interface: NoteManagement

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.

Specified by:

getNumberOfReplies in interface NoteManagement

Parameters:

noteId - the ID of the note

Returns:

the number of replies

Throws:

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

See Also:

NoteService.getNumberOfReplies(Long)

getPrincipal

protected Principal getPrincipal()

Gets the current principal if one has been set, otherwise returns null.

Returns:

the current principal

handleCreateNote

protected abstract NoteModificationResult handleCreateNote(NoteStoringTO noteStoringTO,
                                                           Set<String> additionalBlogNameIds)
                                                    throws BlogNotFoundException,
                                                           NoteManagementAuthorizationException,
                                                           NoteStoringPreProcessorException

Performs the core logic for createNote(NoteStoringTO, Set)

Throws:

BlogNotFoundException

NoteManagementAuthorizationException

NoteStoringPreProcessorException

handleDeleteAutosave

protected abstract void handleDeleteAutosave(Long noteId)
                                      throws NoteManagementAuthorizationException

Performs the core logic for deleteAutosave(Long)

Throws:

NoteManagementAuthorizationException

handleDeleteNote

protected abstract void handleDeleteNote(Long noteId,
                                         boolean deleteSystemPosts,
                                         boolean clientManagerCanDelete)
                                  throws NoteManagementAuthorizationException

Performs the core logic for deleteNote(Long, boolean, boolean)

Throws:

NoteManagementAuthorizationException

handleDeleteNotesOfUser

protected abstract Set<Long> handleDeleteNotesOfUser(Long userId)
                                              throws AuthorizationException

Performs the core logic for deleteNotesOfUser(Long)

Throws:

AuthorizationException

handleGetCommentsOfDiscussion

protected abstract List<SimpleNoteListItem> handleGetCommentsOfDiscussion(Long noteId)
                                                                   throws NoteNotFoundException

Performs the core logic for getCommentsOfDiscussion(Long)

Parameters:

noteId - the ID of the note

Returns:

the notes

Throws:

NoteNotFoundException - in case the note does not exists

handleGetDiscussionId

protected abstract Long handleGetDiscussionId(Long noteId)
                                       throws NoteNotFoundException

Implementation of getDiscussionId(Long)

Parameters:

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

Returns:

the ID of the discussion

Throws:

NoteNotFoundException - in case the note does not exist

handleGetNoteWithComments

protected abstract DiscussionNoteData handleGetNoteWithComments(Long noteId,
                                                                QueryResultConverter<SimpleNoteListItem,DiscussionNoteData> converter)
                                                         throws NoteNotFoundException,
                                                                AuthorizationException

Performs the core logic for getNoteWithComments(Long, QueryResultConverter)

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

handleGetNumberOfNotesInDiscussion

protected abstract int handleGetNumberOfNotesInDiscussion(Long noteId)
                                                   throws NoteNotFoundException

Performs the core logic for getNumberOfNotesInDiscussion(Long)

Parameters:

noteId - the ID of the note

Returns:

the number notes

Throws:

NoteNotFoundException - in case the note does not exists

handleGetNumberOfReplies

protected abstract int handleGetNumberOfReplies(Long noteId)
                                         throws NoteNotFoundException

Performs the core logic for getNumberOfReplies(Long)

Throws:

NoteNotFoundException

handleUpdateNote

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

Throws:

NoteNotFoundException

NoteManagementAuthorizationException

NoteStoringPreProcessorException

BlogNotFoundException

updateNote

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

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

Specified by:

updateNote in interface NoteManagement

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:

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

BlogNotFoundException - in case the target blog does not exist