com.communote.server.core.common.velocity

Class TopicTool

java.lang.Object

com.communote.server.core.common.velocity.TopicTool

public class TopicTool
extends Object

Topic specific tools.

Author:

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

Constructor Summary

Constructors

Constructor and Description
TopicTool()

Method Summary

Modifier and Type	Method and Description
BlogData	getBlog(Number blogId) Return the details of a topic, the properties will not be contained.
String	getBlogRole(Long blogId)
Blog	getDefaultBlog()
Long	getDefaultBlogId()
String	getDefaultBlogRole()
MinimalBlogData	getMinimalBlogInfo(Number blogId) Return the minimal set of information on a topic, even if the current user has no access to the topic.
String	getUsersWithRoleAsJson(long topicId, String role) Method to get a list of users with the given role from the given topic.
boolean	hasChildren(Long topicId)
boolean	hasExternalObjects(Long blogId) Set the external objects for this blog.
boolean	hasPermission(long topicId, String permissionIdentifier) Can be used to check if the current user has a specific permission on a given blog.
boolean	isDefaultBlogEnabled(boolean readAccessRequired, boolean writeAccessRequired)

Methods inherited from class java.lang.Object

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

Constructor Detail

TopicTool

public TopicTool()

Method Detail

getBlog

public BlogData getBlog(Number blogId)

Return the details of a topic, the properties will not be contained.

Parameters:

blogId - the ID of the topic

Returns:

a list item with details or null if the blog does not exist or the user is not allowed to read it

getBlogRole

public String getBlogRole(Long blogId)

Parameters:

blogId - The id of the blog to test.

Returns:

The role of the current user for the given blog, will be "NONE" if the blog does not exist or the user has no access.

getDefaultBlog

public Blog getDefaultBlog()

Returns:

The default topic.

getDefaultBlogId

public Long getDefaultBlogId()

Returns:

The id of the default blog, or empty string if there is none.

getDefaultBlogRole

public String getDefaultBlogRole()

Returns:

The role of the current user for the default blog. Result will be "NONE" if the user has no access to that topic.

getMinimalBlogInfo

public MinimalBlogData getMinimalBlogInfo(Number blogId)

Return the minimal set of information on a topic, even if the current user has no access to the topic.

Parameters:

blogId - the ID of the topic

Returns:

the blog details or null if the topic does not exist

getUsersWithRoleAsJson

public String getUsersWithRoleAsJson(long topicId,
                                     String role)

Method to get a list of users with the given role from the given topic.

Parameters:

topicId - The topics id.

role - The role to get.

Returns:

Collection of user names encapsulated in '

hasChildren

public boolean hasChildren(Long topicId)

Parameters:

topicId - The topics id.

Returns:

True, if the topic has children, else false.

hasExternalObjects

public boolean hasExternalObjects(Long blogId)

Set the external objects for this blog.

Parameters:

blogId - The blogs id.

Returns:

List of external objects.

hasPermission

public boolean hasPermission(long topicId,
                             String permissionIdentifier)

Can be used to check if the current user has a specific permission on a given blog.

Parameters:

topicId - The topics id.

permissionIdentifier - The permission as String.

Returns:

True, if the current user has the given permission on the given blog.

isDefaultBlogEnabled

public boolean isDefaultBlogEnabled(boolean readAccessRequired,
                                    boolean writeAccessRequired)

Parameters:

readAccessRequired - if true the default blog will only be enabled if the current user has read access to that blog

writeAccessRequired - if true the default blog will only be enabled if the current user has write access to that blog

Returns:

whether the default blog is enabled and the given access is granted for the current user