com.liferay.portal.kernel.service

Class RoleLocalServiceUtil

java.lang.Object

com.liferay.portal.kernel.service.RoleLocalServiceUtil

@ProviderType
public class RoleLocalServiceUtil
extends java.lang.Object

Provides the local service utility for Role. This utility wraps RoleLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

Author:

Brian Wing Shun Chan

See Also:

RoleLocalService, RoleLocalServiceBaseImpl, RoleLocalServiceImpl

Generated:

Constructor Summary

Constructors

Constructor and Description
RoleLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static void	addGroupRole(long groupId, long roleId)
static void	addGroupRole(long groupId, Role role)
static void	addGroupRoles(long groupId, java.util.List<Role> roles)
static void	addGroupRoles(long groupId, long[] roleIds)
static Role	addRole(long userId, java.lang.String className, long classPK, java.lang.String name, java.util.Map<java.util.Locale,java.lang.String> titleMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, int type, java.lang.String subtype, ServiceContext serviceContext) Adds a role with additional parameters.
static Role	addRole(Role role) Adds the role to the database.
static void	addUserRole(long userId, long roleId)
static void	addUserRole(long userId, Role role)
static void	addUserRoles(long userId, java.util.List<Role> roles)
static void	addUserRoles(long userId, long[] roleIds)
static void	checkSystemRoles() Checks to ensure that the system roles map has appropriate default roles in each company.
static void	checkSystemRoles(long companyId) Checks to ensure that the system roles map has appropriate default roles in the company.
static void	clearGroupRoles(long groupId)
static void	clearUserRoles(long userId)
static Role	createRole(long roleId) Creates a new role with the primary key.
static void	deleteGroupRole(long groupId, long roleId)
static void	deleteGroupRole(long groupId, Role role)
static void	deleteGroupRoles(long groupId, java.util.List<Role> roles)
static void	deleteGroupRoles(long groupId, long[] roleIds)
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static Role	deleteRole(long roleId) Deletes the role with the primary key from the database.
static Role	deleteRole(Role role) Deletes the role from the database.
static void	deleteUserRole(long userId, long roleId)
static void	deleteUserRole(long userId, Role role)
static void	deleteUserRoles(long userId, java.util.List<Role> roles)
static void	deleteUserRoles(long userId, long[] roleIds)
static DynamicQuery	dynamicQuery()
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
static Role	fetchRole(long roleId)
static Role	fetchRole(long companyId, java.lang.String name) Returns the role with the name in the company.
static Role	fetchRoleByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the role with the matching UUID and company.
static ActionableDynamicQuery	getActionableDynamicQuery()
static Role	getDefaultGroupRole(long groupId) Returns the default role for the group with the primary key.
static ExportActionableDynamicQuery	getExportActionableDynamicQuery(PortletDataContext portletDataContext)
static long[]	getGroupPrimaryKeys(long roleId) Returns the groupIds of the groups associated with the role.
static java.util.List<Role>	getGroupRelatedRoles(long groupId)
static java.util.List<Role>	getGroupRoles(long groupId)
static java.util.List<Role>	getGroupRoles(long groupId, int start, int end)
static java.util.List<Role>	getGroupRoles(long groupId, int start, int end, OrderByComparator<Role> orderByComparator)
static java.util.List<Role>	getGroupRolesAndTeamRoles(long companyId, java.lang.String keywords, java.util.List<java.lang.String> excludedNames, int[] types, long excludedTeamRoleId, long teamGroupId, int start, int end)
static int	getGroupRolesAndTeamRolesCount(long companyId, java.lang.String keywords, java.util.List<java.lang.String> excludedNames, int[] types, long excludedTeamRoleId, long teamGroupId)
static int	getGroupRolesCount(long groupId)
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static java.util.List<Role>	getResourceBlockRoles(long resourceBlockId, java.lang.String className, java.lang.String actionId)
static java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getResourceRoles(long companyId, java.lang.String name, int scope, java.lang.String primKey) Returns a map of role names to associated action IDs for the named resource in the company within the permission scope.
static java.util.List<Role>	getResourceRoles(long companyId, java.lang.String name, int scope, java.lang.String primKey, java.lang.String actionId) Returns all the roles associated with the action ID in the company within the permission scope.
static Role	getRole(long roleId) Returns the role with the primary key.
static Role	getRole(long companyId, java.lang.String name) Returns the role with the name in the company.
static Role	getRoleByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the role with the matching UUID and company.
static java.util.List<Role>	getRoles(int start, int end) Returns a range of all the roles.
static java.util.List<Role>	getRoles(int type, java.lang.String subtype) Returns all the roles of the type and subtype.
static java.util.List<Role>	getRoles(long companyId) Returns all the roles in the company.
static java.util.List<Role>	getRoles(long[] roleIds) Returns all the roles with the primary keys.
static java.util.List<Role>	getRoles(long companyId, int[] types) Returns all the roles with the types.
static int	getRolesCount() Returns the number of roles.
static RoleLocalService	getService()
static java.util.List<Role>	getSubtypeRoles(java.lang.String subtype) Returns all the roles of the subtype.
static int	getSubtypeRolesCount(java.lang.String subtype) Returns the number of roles of the subtype.
static Role	getTeamRole(long companyId, long teamId) Returns the team role in the company.
static java.util.Map<Team,Role>	getTeamRoleMap(long groupId) Returns the team role map for the group.
static java.util.List<Role>	getTeamRoles(long groupId) Returns the team roles in the group.
static java.util.List<Role>	getTeamRoles(long groupId, long[] excludedRoleIds) Returns the team roles in the group, excluding the specified role IDs.
static java.util.List<Role>	getTeamsRoles(long companyId, long[] teamIds) Returns the team roles in the company.
static java.util.List<Role>	getTypeRoles(int type) Returns all the roles of the type.
static java.util.List<Role>	getTypeRoles(int type, int start, int end) Returns a range of all the roles of the type.
static int	getTypeRolesCount(int type) Returns the number of roles of the type.
static java.util.List<Role>	getUserGroupGroupRoles(long userId, long groupId) Returns all the user's roles within the user group.
static java.util.List<Role>	getUserGroupGroupRoles(long userId, long groupId, int start, int end)
static int	getUserGroupGroupRolesCount(long userId, long groupId)
static java.util.List<Role>	getUserGroupRoles(long userId, long groupId) Returns all the user's roles within the user group.
static long[]	getUserPrimaryKeys(long roleId) Returns the userIds of the users associated with the role.
static java.util.List<Role>	getUserRelatedRoles(long userId, java.util.List<Group> groups) Returns the union of all the user's roles within the groups.
static java.util.List<Role>	getUserRelatedRoles(long userId, long groupId) Returns all the user's roles within the group.
static java.util.List<Role>	getUserRelatedRoles(long userId, long[] groupIds) Returns the union of all the user's roles within the groups.
static java.util.List<Role>	getUserRoles(long userId)
static java.util.List<Role>	getUserRoles(long userId, int start, int end)
static java.util.List<Role>	getUserRoles(long userId, int start, int end, OrderByComparator<Role> orderByComparator)
static int	getUserRolesCount(long userId)
static java.util.List<Role>	getUserTeamRoles(long userId, long groupId)
static boolean	hasGroupRole(long groupId, long roleId)
static boolean	hasGroupRoles(long groupId)
static boolean	hasUserRole(long userId, long roleId)
static boolean	hasUserRole(long userId, long companyId, java.lang.String name, boolean inherited) Returns true if the user is associated with the named regular role.
static boolean	hasUserRoles(long userId)
static boolean	hasUserRoles(long userId, long companyId, java.lang.String[] names, boolean inherited) Returns true if the user has any one of the named regular roles.
static Role	loadFetchRole(long companyId, java.lang.String name) Returns a role with the name in the company.
static Role	loadGetRole(long companyId, java.lang.String name) Returns a role with the name in the company.
static java.util.List<Role>	search(long companyId, java.lang.String keywords, java.lang.Integer[] types, int start, int end, OrderByComparator<Role> obc) Returns an ordered range of all the roles that match the keywords and types.
static java.util.List<Role>	search(long companyId, java.lang.String keywords, java.lang.Integer[] types, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end, OrderByComparator<Role> obc) Returns an ordered range of all the roles that match the keywords, types, and params.
static java.util.List<Role>	search(long companyId, java.lang.String name, java.lang.String description, java.lang.Integer[] types, int start, int end, OrderByComparator<Role> obc) Returns an ordered range of all the roles that match the name, description, and types.
static java.util.List<Role>	search(long companyId, java.lang.String name, java.lang.String description, java.lang.Integer[] types, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end, OrderByComparator<Role> obc) Returns an ordered range of all the roles that match the name, description, types, and params.
static int	searchCount(long companyId, java.lang.String keywords, java.lang.Integer[] types) Returns the number of roles that match the keywords and types.
static int	searchCount(long companyId, java.lang.String keywords, java.lang.Integer[] types, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params) Returns the number of roles that match the keywords, types and params.
static int	searchCount(long companyId, java.lang.String name, java.lang.String description, java.lang.Integer[] types) Returns the number of roles that match the name, description, and types.
static int	searchCount(long companyId, java.lang.String name, java.lang.String description, java.lang.Integer[] types, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params) Returns the number of roles that match the name, description, types, and params.
static void	setGroupRoles(long groupId, long[] roleIds)
static void	setUserRoles(long userId, long[] roleIds)
static void	unsetUserRoles(long userId, long[] roleIds) Removes the matching roles associated with the user.
static Role	updateRole(long roleId, java.lang.String name, java.util.Map<java.util.Locale,java.lang.String> titleMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.lang.String subtype, ServiceContext serviceContext) Updates the role with the primary key.
static Role	updateRole(Role role) Updates the role in the database or adds it if it does not yet exist.

Methods inherited from class java.lang.Object

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

Constructor Detail

RoleLocalServiceUtil

public RoleLocalServiceUtil()

Method Detail

addGroupRole

public static void addGroupRole(long groupId,
                                long roleId)

addGroupRole

public static void addGroupRole(long groupId,
                                Role role)

addGroupRoles

public static void addGroupRoles(long groupId,
                                 java.util.List<Role> roles)

addGroupRoles

public static void addGroupRoles(long groupId,
                                 long[] roleIds)

addRole

public static Role addRole(long userId,
                           java.lang.String className,
                           long classPK,
                           java.lang.String name,
                           java.util.Map<java.util.Locale,java.lang.String> titleMap,
                           java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                           int type,
                           java.lang.String subtype,
                           ServiceContext serviceContext)
                    throws PortalException

Adds a role with additional parameters. The user is reindexed after role is added.

Parameters:

userId - the primary key of the user

className - the name of the class for which the role is created (optionally null)

classPK - the primary key of the class for which the role is created (optionally 0)

name - the role's name

titleMap - the role's localized titles (optionally null)

descriptionMap - the role's localized descriptions (optionally null)

type - the role's type (optionally 0)

subtype - the role's subtype (optionally null)

serviceContext - the service context to be applied (optionally null). Can set expando bridge attributes for the role.

Returns:

the role

Throws:

PortalException

addRole

public static Role addRole(Role role)

Adds the role to the database. Also notifies the appropriate model listeners.

Parameters:

role - the role

Returns:

the role that was added

addUserRole

public static void addUserRole(long userId,
                               long roleId)
                        throws PortalException

Throws:

PortalException

addUserRole

public static void addUserRole(long userId,
                               Role role)
                        throws PortalException

Throws:

PortalException

addUserRoles

public static void addUserRoles(long userId,
                                java.util.List<Role> roles)
                         throws PortalException

Throws:

PortalException

addUserRoles

public static void addUserRoles(long userId,
                                long[] roleIds)
                         throws PortalException

Throws:

PortalException

checkSystemRoles

public static void checkSystemRoles()
                             throws PortalException

Checks to ensure that the system roles map has appropriate default roles in each company.

Throws:

PortalException

checkSystemRoles

public static void checkSystemRoles(long companyId)
                             throws PortalException

Checks to ensure that the system roles map has appropriate default roles in the company.

Parameters:

companyId - the primary key of the company

Throws:

PortalException

clearGroupRoles

public static void clearGroupRoles(long groupId)

clearUserRoles

public static void clearUserRoles(long userId)
                           throws PortalException

Throws:

PortalException

createRole

public static Role createRole(long roleId)

Creates a new role with the primary key. Does not add the role to the database.

Parameters:

roleId - the primary key for the new role

Returns:

the new role

deleteGroupRole

public static void deleteGroupRole(long groupId,
                                   long roleId)

deleteGroupRole

public static void deleteGroupRole(long groupId,
                                   Role role)

deleteGroupRoles

public static void deleteGroupRoles(long groupId,
                                    java.util.List<Role> roles)

deleteGroupRoles

public static void deleteGroupRoles(long groupId,
                                    long[] roleIds)

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

deleteRole

public static Role deleteRole(long roleId)
                       throws PortalException

Deletes the role with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

roleId - the primary key of the role

Returns:

the role that was removed

Throws:

PortalException - if a role with the primary key could not be found

deleteRole

public static Role deleteRole(Role role)
                       throws PortalException

Deletes the role from the database. Also notifies the appropriate model listeners.

Parameters:

role - the role

Returns:

the role that was removed

Throws:

PortalException

deleteUserRole

public static void deleteUserRole(long userId,
                                  long roleId)
                           throws PortalException

Throws:

PortalException

deleteUserRole

public static void deleteUserRole(long userId,
                                  Role role)
                           throws PortalException

Throws:

PortalException

deleteUserRoles

public static void deleteUserRoles(long userId,
                                   java.util.List<Role> roles)
                            throws PortalException

Throws:

PortalException

deleteUserRoles

public static void deleteUserRoles(long userId,
                                   long[] roleIds)
                            throws PortalException

Throws:

PortalException

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery)

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end)

Performs a dynamic query on the database and returns a range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from RoleModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

Returns:

the range of matching rows

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end,
                                                 OrderByComparator<T> orderByComparator)

Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from RoleModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchRole

public static Role fetchRole(long roleId)

fetchRole

public static Role fetchRole(long companyId,
                             java.lang.String name)

Returns the role with the name in the company.

The method searches the system roles map first for default roles. If a role with the name is not found, then the method will query the database.

Parameters:

companyId - the primary key of the company

name - the role's name

Returns:

Returns the role with the name or null if a role with the name could not be found in the company

fetchRoleByUuidAndCompanyId

public static Role fetchRoleByUuidAndCompanyId(java.lang.String uuid,
                                               long companyId)

Returns the role with the matching UUID and company.

Parameters:

uuid - the role's UUID

companyId - the primary key of the company

Returns:

the matching role, or null if a matching role could not be found

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getDefaultGroupRole

public static Role getDefaultGroupRole(long groupId)
                                throws PortalException

Returns the default role for the group with the primary key.

If the group is a site, then the default role is RoleConstants#SITE_MEMBER. If the group is an organization, then the default role is RoleConstants#ORGANIZATION_USER. If the group is a user or user group, then the default role is RoleConstants#POWER_USER. For all other group types, the default role is RoleConstants#USER.

Parameters:

groupId - the primary key of the group

Returns:

the default role for the group with the primary key

Throws:

PortalException

getExportActionableDynamicQuery

public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getGroupPrimaryKeys

public static long[] getGroupPrimaryKeys(long roleId)

Returns the groupIds of the groups associated with the role.

Parameters:

roleId - the roleId of the role

Returns:

long[] the groupIds of groups associated with the role

getGroupRelatedRoles

public static java.util.List<Role> getGroupRelatedRoles(long groupId)
                                                 throws PortalException

Throws:

PortalException

getGroupRoles

public static java.util.List<Role> getGroupRoles(long groupId)

getGroupRoles

public static java.util.List<Role> getGroupRoles(long groupId,
                                                 int start,
                                                 int end)

getGroupRoles

public static java.util.List<Role> getGroupRoles(long groupId,
                                                 int start,
                                                 int end,
                                                 OrderByComparator<Role> orderByComparator)

getGroupRolesAndTeamRoles

public static java.util.List<Role> getGroupRolesAndTeamRoles(long companyId,
                                                             java.lang.String keywords,
                                                             java.util.List<java.lang.String> excludedNames,
                                                             int[] types,
                                                             long excludedTeamRoleId,
                                                             long teamGroupId,
                                                             int start,
                                                             int end)

getGroupRolesAndTeamRolesCount

public static int getGroupRolesAndTeamRolesCount(long companyId,
                                                 java.lang.String keywords,
                                                 java.util.List<java.lang.String> excludedNames,
                                                 int[] types,
                                                 long excludedTeamRoleId,
                                                 long teamGroupId)

getGroupRolesCount

public static int getGroupRolesCount(long groupId)

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

getResourceBlockRoles

public static java.util.List<Role> getResourceBlockRoles(long resourceBlockId,
                                                         java.lang.String className,
                                                         java.lang.String actionId)

getResourceRoles

public static java.util.Map<java.lang.String,java.util.List<java.lang.String>> getResourceRoles(long companyId,
                                                                                                java.lang.String name,
                                                                                                int scope,
                                                                                                java.lang.String primKey)

Returns a map of role names to associated action IDs for the named resource in the company within the permission scope.

Parameters:

companyId - the primary key of the company

name - the resource name

scope - the permission scope

primKey - the primary key of the resource's class

Returns:

the role names and action IDs

See Also:

RoleFinder.findByC_N_S_P( long, String, int, String)

getResourceRoles

public static java.util.List<Role> getResourceRoles(long companyId,
                                                    java.lang.String name,
                                                    int scope,
                                                    java.lang.String primKey,
                                                    java.lang.String actionId)

Returns all the roles associated with the action ID in the company within the permission scope.

Parameters:

companyId - the primary key of the company

name - the resource name

scope - the permission scope

primKey - the primary key of the resource's class

actionId - the name of the resource action

Returns:

the roles

See Also:

RoleFinder.findByC_N_S_P_A( long, String, int, String, String)

getRole

public static Role getRole(long roleId)
                    throws PortalException

Returns the role with the primary key.

Parameters:

roleId - the primary key of the role

Returns:

the role

Throws:

PortalException - if a role with the primary key could not be found

getRole

public static Role getRole(long companyId,
                           java.lang.String name)
                    throws PortalException

Returns the role with the name in the company.

The method searches the system roles map first for default roles. If a role with the name is not found, then the method will query the database.

Parameters:

companyId - the primary key of the company

name - the role's name

Returns:

the role with the name

Throws:

PortalException

getRoleByUuidAndCompanyId

public static Role getRoleByUuidAndCompanyId(java.lang.String uuid,
                                             long companyId)
                                      throws PortalException

Returns the role with the matching UUID and company.

Parameters:

uuid - the role's UUID

companyId - the primary key of the company

Returns:

the matching role

Throws:

PortalException - if a matching role could not be found

getRoles

public static java.util.List<Role> getRoles(int start,
                                            int end)

Returns a range of all the roles.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from RoleModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

start - the lower bound of the range of roles

end - the upper bound of the range of roles (not inclusive)

Returns:

the range of roles

getRoles

public static java.util.List<Role> getRoles(int type,
                                            java.lang.String subtype)

Returns all the roles of the type and subtype.

Parameters:

type - the role's type (optionally 0)

subtype - the role's subtype (optionally null)

Returns:

the roles of the type and subtype

getRoles

public static java.util.List<Role> getRoles(long companyId)

Returns all the roles in the company.

Parameters:

companyId - the primary key of the company

Returns:

the roles in the company

getRoles

public static java.util.List<Role> getRoles(long companyId,
                                            int[] types)

Returns all the roles with the types.

Parameters:

companyId - the primary key of the company

types - the role types (optionally null)

Returns:

the roles with the types

getRoles

public static java.util.List<Role> getRoles(long[] roleIds)
                                     throws PortalException

Returns all the roles with the primary keys.

Parameters:

roleIds - the primary keys of the roles

Returns:

the roles with the primary keys

Throws:

PortalException

getRolesCount

public static int getRolesCount()

Returns the number of roles.

Returns:

the number of roles

getSubtypeRoles

public static java.util.List<Role> getSubtypeRoles(java.lang.String subtype)

Returns all the roles of the subtype.

Parameters:

subtype - the role's subtype (optionally null)

Returns:

the roles of the subtype

getSubtypeRolesCount

public static int getSubtypeRolesCount(java.lang.String subtype)

Returns the number of roles of the subtype.

Parameters:

subtype - the role's subtype (optionally null)

Returns:

the number of roles of the subtype

getTeamRole

public static Role getTeamRole(long companyId,
                               long teamId)
                        throws PortalException

Returns the team role in the company.

Parameters:

companyId - the primary key of the company

teamId - the primary key of the team

Returns:

the team role in the company

Throws:

PortalException

getTeamRoleMap

public static java.util.Map<Team,Role> getTeamRoleMap(long groupId)
                                               throws PortalException

Returns the team role map for the group.

Parameters:

groupId - the primary key of the group

Returns:

the team role map for the group

Throws:

PortalException

getTeamRoles

public static java.util.List<Role> getTeamRoles(long groupId)
                                         throws PortalException

Returns the team roles in the group.

Parameters:

groupId - the primary key of the group

Returns:

the team roles in the group

Throws:

PortalException

getTeamRoles

public static java.util.List<Role> getTeamRoles(long groupId,
                                                long[] excludedRoleIds)
                                         throws PortalException

Returns the team roles in the group, excluding the specified role IDs.

Parameters:

groupId - the primary key of the group

excludedRoleIds - the primary keys of the roles to exclude (optionally null)

Returns:

the team roles in the group, excluding the specified role IDs

Throws:

PortalException

getTeamsRoles

public static java.util.List<Role> getTeamsRoles(long companyId,
                                                 long[] teamIds)
                                          throws PortalException

Returns the team roles in the company.

Parameters:

companyId - the primary key of the company

teamIds - the primary keys of the teams

Returns:

the team roles in the company

Throws:

PortalException

getTypeRoles

public static java.util.List<Role> getTypeRoles(int type)

Returns all the roles of the type.

Parameters:

type - the role's type (optionally 0)

Returns:

the range of the roles of the type

getTypeRoles

public static java.util.List<Role> getTypeRoles(int type,
                                                int start,
                                                int end)

Returns a range of all the roles of the type.

Parameters:

type - the role's type (optionally 0)

start - the lower bound of the range of roles to return

end - the upper bound of the range of roles to return (not inclusive)

Returns:

the range of the roles of the type

getTypeRolesCount

public static int getTypeRolesCount(int type)

Returns the number of roles of the type.

Parameters:

type - the role's type (optionally 0)

Returns:

the number of roles of the type

getUserGroupGroupRoles

public static java.util.List<Role> getUserGroupGroupRoles(long userId,
                                                          long groupId)

Returns all the user's roles within the user group.

Parameters:

userId - the primary key of the user

groupId - the primary key of the group

Returns:

the user's roles within the user group

See Also:

RoleFinder.findByUserGroupGroupRole( long, long)

getUserGroupGroupRoles

public static java.util.List<Role> getUserGroupGroupRoles(long userId,
                                                          long groupId,
                                                          int start,
                                                          int end)

getUserGroupGroupRolesCount

public static int getUserGroupGroupRolesCount(long userId,
                                              long groupId)

getUserGroupRoles

public static java.util.List<Role> getUserGroupRoles(long userId,
                                                     long groupId)

Returns all the user's roles within the user group.

Parameters:

userId - the primary key of the user

groupId - the primary key of the group

Returns:

the user's roles within the user group

See Also:

RoleFinder.findByUserGroupRole( long, long)

getUserPrimaryKeys

public static long[] getUserPrimaryKeys(long roleId)

Returns the userIds of the users associated with the role.

Parameters:

roleId - the roleId of the role

Returns:

long[] the userIds of users associated with the role

getUserRelatedRoles

public static java.util.List<Role> getUserRelatedRoles(long userId,
                                                       java.util.List<Group> groups)

Returns the union of all the user's roles within the groups.

Parameters:

userId - the primary key of the user

groups - the groups (optionally null)

Returns:

the union of all the user's roles within the groups

See Also:

RoleFinder.findByU_G( long, List)

getUserRelatedRoles

public static java.util.List<Role> getUserRelatedRoles(long userId,
                                                       long groupId)

Returns all the user's roles within the group.

Parameters:

userId - the primary key of the user

groupId - the primary key of the group

Returns:

the user's roles within the group

See Also:

RoleFinder.findByU_G( long, long)

getUserRelatedRoles

public static java.util.List<Role> getUserRelatedRoles(long userId,
                                                       long[] groupIds)

Returns the union of all the user's roles within the groups.

Parameters:

userId - the primary key of the user

groupIds - the primary keys of the groups

Returns:

the union of all the user's roles within the groups

See Also:

RoleFinder.findByU_G( long, long[])

getUserRoles

public static java.util.List<Role> getUserRoles(long userId)

getUserRoles

public static java.util.List<Role> getUserRoles(long userId,
                                                int start,
                                                int end)

getUserRoles

public static java.util.List<Role> getUserRoles(long userId,
                                                int start,
                                                int end,
                                                OrderByComparator<Role> orderByComparator)

getUserRolesCount

public static int getUserRolesCount(long userId)

getUserTeamRoles

public static java.util.List<Role> getUserTeamRoles(long userId,
                                                    long groupId)

hasGroupRole

public static boolean hasGroupRole(long groupId,
                                   long roleId)

hasGroupRoles

public static boolean hasGroupRoles(long groupId)

hasUserRole

public static boolean hasUserRole(long userId,
                                  long roleId)

hasUserRole

public static boolean hasUserRole(long userId,
                                  long companyId,
                                  java.lang.String name,
                                  boolean inherited)
                           throws PortalException

Returns true if the user is associated with the named regular role.

Parameters:

userId - the primary key of the user

companyId - the primary key of the company

name - the name of the role

inherited - whether to include the user's inherited roles in the search

Returns:

true if the user is associated with the regular role; false otherwise

Throws:

PortalException

hasUserRoles

public static boolean hasUserRoles(long userId)

hasUserRoles

public static boolean hasUserRoles(long userId,
                                   long companyId,
                                   java.lang.String[] names,
                                   boolean inherited)
                            throws PortalException

Returns true if the user has any one of the named regular roles.

Parameters:

userId - the primary key of the user

companyId - the primary key of the company

names - the names of the roles

inherited - whether to include the user's inherited roles in the search

Returns:

true if the user has any one of the regular roles; false otherwise

Throws:

PortalException

loadFetchRole

public static Role loadFetchRole(long companyId,
                                 java.lang.String name)

Returns a role with the name in the company.

Parameters:

companyId - the primary key of the company

name - the role's name (optionally null)

Returns:

the role with the name, or null if a role with the name could not be found in the company

loadGetRole

public static Role loadGetRole(long companyId,
                               java.lang.String name)
                        throws PortalException

Returns a role with the name in the company.

Parameters:

companyId - the primary key of the company

name - the role's name

Returns:

the role with the name in the company

Throws:

PortalException

search

public static java.util.List<Role> search(long companyId,
                                          java.lang.String keywords,
                                          java.lang.Integer[] types,
                                          int start,
                                          int end,
                                          OrderByComparator<Role> obc)

Returns an ordered range of all the roles that match the keywords and types.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

companyId - the primary key of the company

keywords - the keywords (space separated), which may occur in the role's name or description (optionally null)

types - the role types (optionally null)

start - the lower bound of the range of roles to return

end - the upper bound of the range of roles to return (not inclusive)

obc - the comparator to order the roles (optionally null)

Returns:

the ordered range of the matching roles, ordered by obc

See Also:

RoleFinder

search

public static java.util.List<Role> search(long companyId,
                                          java.lang.String keywords,
                                          java.lang.Integer[] types,
                                          java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                          int start,
                                          int end,
                                          OrderByComparator<Role> obc)

Returns an ordered range of all the roles that match the keywords, types, and params.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

companyId - the primary key of the company

keywords - the keywords (space separated), which may occur in the role's name or description (optionally null)

types - the role types (optionally null)

params - the finder parameters. Can specify values for the "usersRoles" key. For more information, see RoleFinder

start - the lower bound of the range of roles to return

end - the upper bound of the range of roles to return (not inclusive)

obc - the comparator to order the roles (optionally null)

Returns:

the ordered range of the matching roles, ordered by obc

See Also:

RoleFinder

search

public static java.util.List<Role> search(long companyId,
                                          java.lang.String name,
                                          java.lang.String description,
                                          java.lang.Integer[] types,
                                          int start,
                                          int end,
                                          OrderByComparator<Role> obc)

Returns an ordered range of all the roles that match the name, description, and types.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

companyId - the primary key of the company

name - the role's name (optionally null)

description - the role's description (optionally null)

types - the role types (optionally null)

start - the lower bound of the range of the roles to return

end - the upper bound of the range of the roles to return (not inclusive)

obc - the comparator to order the roles (optionally null)

Returns:

the ordered range of the matching roles, ordered by obc

See Also:

RoleFinder

search

public static java.util.List<Role> search(long companyId,
                                          java.lang.String name,
                                          java.lang.String description,
                                          java.lang.Integer[] types,
                                          java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                          int start,
                                          int end,
                                          OrderByComparator<Role> obc)

Returns an ordered range of all the roles that match the name, description, types, and params.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

companyId - the primary key of the company

name - the role's name (optionally null)

description - the role's description (optionally null)

types - the role types (optionally null)

params - the finder's parameters. Can specify values for the "usersRoles" key. For more information, see RoleFinder

start - the lower bound of the range of the roles to return

end - the upper bound of the range of the roles to return (not inclusive)

obc - the comparator to order the roles (optionally null)

Returns:

the ordered range of the matching roles, ordered by obc

See Also:

RoleFinder

searchCount

public static int searchCount(long companyId,
                              java.lang.String keywords,
                              java.lang.Integer[] types)

Returns the number of roles that match the keywords and types.

Parameters:

companyId - the primary key of the company

keywords - the keywords (space separated), which may occur in the role's name or description (optionally null)

types - the role types (optionally null)

Returns:

the number of matching roles

searchCount

public static int searchCount(long companyId,
                              java.lang.String keywords,
                              java.lang.Integer[] types,
                              java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)

Returns the number of roles that match the keywords, types and params.

Parameters:

companyId - the primary key of the company

keywords - the keywords (space separated), which may occur in the role's name or description (optionally null)

types - the role types (optionally null)

params - the finder parameters. For more information, see RoleFinder

Returns:

the number of matching roles

searchCount

public static int searchCount(long companyId,
                              java.lang.String name,
                              java.lang.String description,
                              java.lang.Integer[] types)

Returns the number of roles that match the name, description, and types.

Parameters:

companyId - the primary key of the company

name - the role's name (optionally null)

description - the role's description (optionally null)

types - the role types (optionally null)

Returns:

the number of matching roles

searchCount

public static int searchCount(long companyId,
                              java.lang.String name,
                              java.lang.String description,
                              java.lang.Integer[] types,
                              java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)

Returns the number of roles that match the name, description, types, and params.

Parameters:

companyId - the primary key of the company

name - the role's name (optionally null)

description - the role's description (optionally null)

types - the role types (optionally null)

params - the finder parameters. Can specify values for the "usersRoles" key. For more information, see RoleFinder

Returns:

the number of matching roles

setGroupRoles

public static void setGroupRoles(long groupId,
                                 long[] roleIds)

setUserRoles

public static void setUserRoles(long userId,
                                long[] roleIds)
                         throws PortalException

Throws:

PortalException

unsetUserRoles

public static void unsetUserRoles(long userId,
                                  long[] roleIds)
                           throws PortalException

Removes the matching roles associated with the user. The user is reindexed after the roles are removed.

Parameters:

userId - the primary key of the user

roleIds - the primary keys of the roles

Throws:

PortalException

updateRole

public static Role updateRole(long roleId,
                              java.lang.String name,
                              java.util.Map<java.util.Locale,java.lang.String> titleMap,
                              java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                              java.lang.String subtype,
                              ServiceContext serviceContext)
                       throws PortalException

Updates the role with the primary key.

Parameters:

roleId - the primary key of the role

name - the role's new name

titleMap - the new localized titles (optionally null) to replace those existing for the role

descriptionMap - the new localized descriptions (optionally null) to replace those existing for the role

subtype - the role's new subtype (optionally null)

serviceContext - the service context to be applied (optionally null). Can set expando bridge attributes for the role.

Returns:

the role with the primary key

Throws:

PortalException

updateRole

public static Role updateRole(Role role)

Updates the role in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

role - the role

Returns:

the role that was updated

getService

public static RoleLocalService getService()