com.liferay.roles.admin.role.type.contributor

Interface RoleTypeContributor

public interface RoleTypeContributor

Used to contribute a role type entry in the Roles Admin portlet. Each role type will create a tab in the user interface.

Method Summary

Modifier and Type	Method and Description
default java.lang.String	getClassName() Optionally returns a className to be used when creating a new role of this type.
default java.lang.String[]	getExcludedRoleNames() Returns a list of role names whose permissions cannot be manually defined by users.
java.lang.String	getIcon() Returns the css class of the icon that represents the role type.
java.lang.String	getName() Returns the role type name.
default java.lang.String[]	getSubtypes() Optionally returns an array of subtypes for the given role type.
java.lang.String	getTabTitle(java.util.Locale locale) Returns the display title for this role type's section.
java.lang.String	getTitle(java.util.Locale locale) Returns the display title for this role in the creation menu.
int	getType() Returns an integer that corresponds to this role's type.
boolean	isAllowAssignMembers(Role role) Returns whether or not to allow a user to manually assign members to the given role.
default boolean	isAllowDefinePermissions(Role role) Returns whether or not to allow a user to manually define the permissions granted by the given role.
boolean	isAllowDelete(Role role) Returns whether or not the given role can be deleted.
default boolean	isAutomaticallyAssigned(Role role) Returns whether or not the given role is automatically assigned.

Method Detail

getClassName

default java.lang.String getClassName()

Optionally returns a className to be used when creating a new role of this type. If none is given, the class name of Role will be used.

Returns:

getExcludedRoleNames

default java.lang.String[] getExcludedRoleNames()

Returns a list of role names whose permissions cannot be manually defined by users.

Returns:

getIcon

java.lang.String getIcon()

Returns the css class of the icon that represents the role type.

Returns:

getName

java.lang.String getName()

Returns the role type name. Example: "regular"

Returns:

getSubtypes

default java.lang.String[] getSubtypes()

Optionally returns an array of subtypes for the given role type. If given, a subtype may be chosen for a role of this type when adding or updating the role.

Returns:

getTabTitle

java.lang.String getTabTitle(java.util.Locale locale)

Returns the display title for this role type's section. Example: "Regular Roles"

Parameters:

locale -

Returns:

getTitle

java.lang.String getTitle(java.util.Locale locale)

Returns the display title for this role in the creation menu. Example: "Regular Role"

Parameters:

locale -

Returns:

getType

int getType()

Returns an integer that corresponds to this role's type. This is used as a key to retrieve the RoleTypeContributor.

Returns:

isAllowAssignMembers

boolean isAllowAssignMembers(Role role)

Returns whether or not to allow a user to manually assign members to the given role.

Parameters:

role -

Returns:

isAllowDefinePermissions

default boolean isAllowDefinePermissions(Role role)

Returns whether or not to allow a user to manually define the permissions granted by the given role.

Parameters:

role -

Returns:

isAllowDelete

boolean isAllowDelete(Role role)

Returns whether or not the given role can be deleted.

Parameters:

role -

Returns:

isAutomaticallyAssigned

default boolean isAutomaticallyAssigned(Role role)

Returns whether or not the given role is automatically assigned.

Parameters:

role -

Returns: