com.communote.server.api.core.note

Class NoteStoringFailDefinition

java.lang.Object

com.communote.server.api.core.note.NoteStoringFailDefinition

All Implemented Interfaces:

Serializable

public class NoteStoringFailDefinition
extends Object
implements Serializable

Transfer object which defines the cases that will lead to a failure instead of a warning during note creation / modification.

Author:

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NoteStoringFailDefinition() Creates a fail definition with default settings, that is nothing will lead to a failure.
NoteStoringFailDefinition(boolean failOnUnresolvableUsers, boolean failOnUnresolvableBlogs, boolean failOnMissingBlogWriteAccess, boolean failOnUninformableUser) Creates a fail definition.

Method Summary

Modifier and Type	Method and Description
boolean	isFailOnMissingBlogWriteAccess()
boolean	isFailOnUninformableUser()
boolean	isFailOnUnresolvableBlogs()
boolean	isFailOnUnresolvableUsers()
void	setFailOnMissingBlogWriteAccess(boolean failOnMissingBlogWriteAccess) Specify whether to fail when the current user has no write access to one of the cross posting blogs.
void	setFailOnUninformableUser(boolean failOnUninformableUser) Specify whether to fail when one of the users that should be informed cannot be informed because of missing read access rights for the blog.
void	setFailOnUnresolvableBlogs(boolean failOnUnresolvableBlogs) Specify whether to fail when one of the cross posting blogs cannot be resolved to an existing blog.
void	setFailOnUnresolvableUsers(boolean failOnUnresolvableUsers) Specify whether to fail when one of the notification targets cannot be resolved to an existing user.

Methods inherited from class java.lang.Object

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

Constructor Detail

NoteStoringFailDefinition

public NoteStoringFailDefinition()

Creates a fail definition with default settings, that is nothing will lead to a failure.

NoteStoringFailDefinition

public NoteStoringFailDefinition(boolean failOnUnresolvableUsers,
                                 boolean failOnUnresolvableBlogs,
                                 boolean failOnMissingBlogWriteAccess,
                                 boolean failOnUninformableUser)

Creates a fail definition.

Parameters:

failOnUnresolvableUsers - whether to fail if a user cannot be resolved to an existing user

failOnUnresolvableBlogs - whether to fail if a blog cannot be resolved to an existing blog

failOnMissingBlogWriteAccess - whether to fail if a crosspost blog is not writable

failOnUninformableUser - whether to fail if a user to be notified has no read access to a blog

Method Detail

isFailOnMissingBlogWriteAccess

public boolean isFailOnMissingBlogWriteAccess()

Returns:

whether to fail when the current user has no write access to one of the cross posting blogs. Failing means that the note will not be created in any blog. When set to false, the note will be created in all the writable blogs and the unwritable blogs will be listed in the result object.

isFailOnUninformableUser

public boolean isFailOnUninformableUser()

Returns:

whether to fail when one of the users that should be informed cannot be informed because of missing read access rights for the blog. Fail means that the note will not be created.

isFailOnUnresolvableBlogs

public boolean isFailOnUnresolvableBlogs()

Returns:

whether to fail when one of the cross posting blogs cannot be resolved to an existing blog. Failing means that the note will not be created in any blog. When set to false the note will be created in all found blogs and the result object will contain the unresolvable blogs.

isFailOnUnresolvableUsers

public boolean isFailOnUnresolvableUsers()

Returns:

whether to fail when one of the notification targets cannot be resolved to an existing user. Failing means that the note will not be created.

setFailOnMissingBlogWriteAccess

public void setFailOnMissingBlogWriteAccess(boolean failOnMissingBlogWriteAccess)

Specify whether to fail when the current user has no write access to one of the cross posting blogs. Failing means that the note will not be created in any blog. When set to false, the post will be created in all the writable blogs and the unwritable blogs will be listed in the result object.

Parameters:

failOnMissingBlogWriteAccess - true if the situation should lead to failure

setFailOnUninformableUser

public void setFailOnUninformableUser(boolean failOnUninformableUser)

Specify whether to fail when one of the users that should be informed cannot be informed because of missing read access rights for the blog. Fail means that the note will not be created.

Parameters:

failOnUninformableUser - true if the situation should lead to failure

setFailOnUnresolvableBlogs

public void setFailOnUnresolvableBlogs(boolean failOnUnresolvableBlogs)

Specify whether to fail when one of the cross posting blogs cannot be resolved to an existing blog. Failing means that the note will not be created in any blog. When set to false the note will be created in all found blogs and the result object will contain the unresolvable blogs.

Parameters:

failOnUnresolvableBlogs - true if the situation should lead to failure

setFailOnUnresolvableUsers

public void setFailOnUnresolvableUsers(boolean failOnUnresolvableUsers)

Specify whether to fail when one of the notification targets cannot be resolved to an existing user. Failing means that the note will not be created.

Parameters:

failOnUnresolvableUsers - true if the situation should lead to failure