com.communote.server.core.vo.blog

Class NoteModificationResult

java.lang.Object

com.communote.server.core.vo.blog.NoteModificationResult

public class NoteModificationResult
extends Object

Contains details about the post creation / modification result.

Author:

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

Constructor Summary

Constructors

Constructor and Description
NoteModificationResult() Creates an empty result object
NoteModificationResult(NoteModificationStatus status, Collection<String> unresolvableBlogs, Collection<String> unwritableBlogs, Long noteId, Long version, boolean direct, UserNotificationResult userNotificationResult) Creates an result object.

Method Summary

Modifier and Type	Method and Description
Throwable	getErrorCause()
String	getMessageKey()
Long	getNoteId()
NoteModificationStatus	getStatus()
Collection<String>	getTagsWithProblems()
Collection<String>	getUnresolvableBlogs()
Collection<String>	getUnwritableBlogs()
UserNotificationResult	getUserNotificationResult()
Long	getVersion()
boolean	isDirect()
void	setDirect(boolean direct) Set whether the created note is a direct message.
void	setErrorCause(Throwable cause)
void	setMessageKey(String messageKey)
void	setNoteId(Long noteId)
void	setStatus(NoteModificationStatus status)
void	setTagsWithProblems(Collection<String> tagsWithProblems)
void	setUnresolvableBlogs(Collection<String> unresolvableBlogs)
void	setUnwritableBlogs(Collection<String> unwritableBlogs)
void	setUserNotificationResult(UserNotificationResult userNotificationResult) Sets the userNotificationResult
void	setVersion(Long version)

Methods inherited from class java.lang.Object

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

Constructor Detail

NoteModificationResult

public NoteModificationResult()

Creates an empty result object

NoteModificationResult

public NoteModificationResult(NoteModificationStatus status,
                              Collection<String> unresolvableBlogs,
                              Collection<String> unwritableBlogs,
                              Long noteId,
                              Long version,
                              boolean direct,
                              UserNotificationResult userNotificationResult)

Creates an result object.

Parameters:

status - the status of the creation / modification

unresolvableBlogs - collection of blog aliases that could not be resolved to existing blogs

unwritableBlogs - collection of cross post target blog aliases the user has no write access to.

noteId - ID of the created note

version - the version of the note

direct - true if the note is a direct message

userNotificationResult - the notification result

Method Detail

getErrorCause

public Throwable getErrorCause()

Returns:

the cause of an internal error if available. There was an internal error if the status is NoteModificationStatus.SYSTEM_ERROR

getMessageKey

public String getMessageKey()

Returns:

A message key, which could be used to displayed a message. Might be null.

getNoteId

public Long getNoteId()

Returns:

the ID of the created note.

getStatus

public NoteModificationStatus getStatus()

Returns:

the status of the creation / modification. In case the status is NoteModificationStatus.SYSTEM_ERROR getErrorCause() might lead to more details.

getTagsWithProblems

public Collection<String> getTagsWithProblems()

Returns:

the tagsWithProblems

getUnresolvableBlogs

public Collection<String> getUnresolvableBlogs()

Returns:

collection of blog aliases that could not be resolved to existing blogs

getUnwritableBlogs

public Collection<String> getUnwritableBlogs()

Returns:

collection of cross post target blog aliases the user has no write access to.

getUserNotificationResult

public UserNotificationResult getUserNotificationResult()

Returns:

the userNotificationResult

getVersion

public Long getVersion()

Returns:

the version of the note

isDirect

public boolean isDirect()

Returns:

whether the created note is a direct message

setDirect

public void setDirect(boolean direct)

Set whether the created note is a direct message.

Parameters:

direct - true if the note is a direct message

setErrorCause

public void setErrorCause(Throwable cause)

Parameters:

cause - set the cause of an internal error. This should be set if status is NoteModificationStatus.SYSTEM_ERROR

setMessageKey

public void setMessageKey(String messageKey)

Parameters:

messageKey - A message key, which could be used to display a message for this result.

setNoteId

public void setNoteId(Long noteId)

Parameters:

noteId - ID of the created note

setStatus

public void setStatus(NoteModificationStatus status)

Parameters:

status - the status of the note creation / modification

setTagsWithProblems

public void setTagsWithProblems(Collection<String> tagsWithProblems)

Parameters:

tagsWithProblems - the tagsWithProblems to set

setUnresolvableBlogs

public void setUnresolvableBlogs(Collection<String> unresolvableBlogs)

Parameters:

unresolvableBlogs - collection of blog aliases that could not be resolved to existing blogs

setUnwritableBlogs

public void setUnwritableBlogs(Collection<String> unwritableBlogs)

Parameters:

unwritableBlogs - collection of cross post target blog aliases the user has no write access to

setUserNotificationResult

public void setUserNotificationResult(UserNotificationResult userNotificationResult)

Sets the userNotificationResult

Parameters:

userNotificationResult - the notification result

setVersion

public void setVersion(Long version)

Parameters:

version - the version of the created note