com.communote.server.core.blog.helper

Class BlogRoleHelper

java.lang.Object

com.communote.server.core.blog.helper.BlogRoleHelper

public final class BlogRoleHelper
extends Object

Helper class for working with blog role constants.

Author:

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

Method Summary

Modifier and Type	Method and Description
static BlogRole	convertNumericToRole(int numericRole) Convert a numeric representation of a role into the role object.
static int	convertRoleToNumeric(BlogRole role) Convert a role into a numeric representation.
static Map<BlogRole,String>	getBlogRoles(Locale locale) Gets the localized user group roles.
static List<String>	getBlogRolesSortedByAccess()
static BlogRole	getUpperRole(BlogRole firstRole, BlogRole secRole) Get back the upper role of given roles
static boolean	sufficientAccess(BlogRole actualRole, BlogRole requiredRole) Return whether a role represents the same or a higher access right than another role

Methods inherited from class java.lang.Object

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

Method Detail

convertNumericToRole

public static BlogRole convertNumericToRole(int numericRole)

Convert a numeric representation of a role into the role object.

Parameters:

numericRole - the numeric representation of the role

Returns:

the role

See Also:

convertRoleToNumeric(BlogRole)

convertRoleToNumeric

public static int convertRoleToNumeric(BlogRole role)

Convert a role into a numeric representation. The higher the returned value the higher is the access right.

Parameters:

role - the role to convert

Returns:

the numeric representation of the role

getBlogRoles

public static Map<BlogRole,String> getBlogRoles(Locale locale)

Gets the localized user group roles. Null value can be used for no role access

Parameters:

locale - the locale

Returns:

the user group roles

getBlogRolesSortedByAccess

public static List<String> getBlogRolesSortedByAccess()

Returns:

the roles sorted by access level (starting with read access)

getUpperRole

public static BlogRole getUpperRole(BlogRole firstRole,
                                    BlogRole secRole)

Get back the upper role of given roles

Parameters:

firstRole - BlogRole

secRole - BolgRole

Returns:

the of the role

sufficientAccess

public static boolean sufficientAccess(BlogRole actualRole,
                                       BlogRole requiredRole)

Return whether a role represents the same or a higher access right than another role

Parameters:

actualRole - the role to evaluate. Can be null. In that case the role is interpreted as no access and thus, false is returned.

requiredRole - the role representing the access right the other role should fulfill. Can be null. In that case the role is interpreted as no access is required and thus, true is returned.

Returns:

true if the actualRole represents an access right that is higher or equal to the required role, otherwise false is returned