RoleLocalServiceWrapper

java.lang.Object
- com.liferay.portal.service.RoleLocalServiceWrapper

All Implemented Interfaces:

BaseLocalService, PersistedModelLocalService, RoleLocalService, ServiceWrapper<RoleLocalService>
```
@ProviderType
public class RoleLocalServiceWrapper
extends java.lang.Object
implements RoleLocalService, ServiceWrapper<RoleLocalService>
```
Provides a wrapper for RoleLocalService.

Author:

Brian Wing Shun Chan

See Also:
RoleLocalService
Generated:

Constructor Summary

Constructors
Constructor and Description

RoleLocalServiceWrapper(RoleLocalService roleLocalService)

Constructors
Constructor and Description
`RoleLocalServiceWrapper(RoleLocalService roleLocalService)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addGroupRole(long groupId, long roleId)`
`void`	`addGroupRole(long groupId, Role role)`
`void`	`addGroupRoles(long groupId, java.util.List<Role> Roles)`
`void`	`addGroupRoles(long groupId, long[] roleIds)`
`Role`	`addRole(long userId, long companyId, 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)` Deprecated. As of 6.2.0, replaced by `addRole(long, String, long, String, Map, Map, int, String, ServiceContext)`
`Role`	`addRole(long userId, long companyId, 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 className, long classPK)` Deprecated. As of 6.2.0, replaced by `addRole(long, String, long, String, Map, Map, int, String, ServiceContext)`
`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.
`Role`	`addRole(Role role)` Adds the role to the database.
`void`	`addUserRole(long userId, long roleId)`
`void`	`addUserRole(long userId, Role role)`
`void`	`addUserRoles(long userId, java.util.List<Role> Roles)`
`void`	`addUserRoles(long userId, long[] roleIds)`
`void`	`checkSystemRoles()` Checks to ensure that the system roles map has appropriate default roles in each company.
`void`	`checkSystemRoles(long companyId)` Checks to ensure that the system roles map has appropriate default roles in the company.
`void`	`clearGroupRoles(long groupId)`
`void`	`clearUserRoles(long userId)`
`Role`	`createRole(long roleId)` Creates a new role with the primary key.
`void`	`deleteGroupRole(long groupId, long roleId)`
`void`	`deleteGroupRole(long groupId, Role role)`
`void`	`deleteGroupRoles(long groupId, java.util.List<Role> Roles)`
`void`	`deleteGroupRoles(long groupId, long[] roleIds)`
`Role`	`deleteRole(long roleId)` Deletes the role with the primary key from the database.
`Role`	`deleteRole(Role role)` Deletes the role from the database.
`void`	`deleteUserRole(long userId, long roleId)`
`void`	`deleteUserRole(long userId, Role role)`
`void`	`deleteUserRoles(long userId, java.util.List<Role> Roles)`
`void`	`deleteUserRoles(long userId, long[] roleIds)`
`DynamicQuery`	`dynamicQuery()`
`java.util.List`	`dynamicQuery(DynamicQuery dynamicQuery)` Performs a dynamic query on the database and returns the matching rows.
`java.util.List`	`dynamicQuery(DynamicQuery dynamicQuery, int start, int end)` Performs a dynamic query on the database and returns a range of the matching rows.
`java.util.List`	`dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator)` Performs a dynamic query on the database and returns an ordered range of the matching rows.
`long`	`dynamicQueryCount(DynamicQuery dynamicQuery)` Returns the number of rows that match the dynamic query.
`long`	`dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)` Returns the number of rows that match the dynamic query.
`Role`	`fetchRole(long roleId)`
`Role`	`fetchRole(long companyId, java.lang.String name)` Returns the role with the name in the company.
`Role`	`fetchRoleByUuidAndCompanyId(java.lang.String uuid, long companyId)` Returns the role with the matching UUID and company.
`java.lang.String`	`getBeanIdentifier()` Returns the Spring bean ID for this bean.
`Role`	`getDefaultGroupRole(long groupId)` Returns the default role for the group with the primary key.
`java.util.List<Role>`	`getGroupRelatedRoles(long groupId)`
`java.util.List<Role>`	`getGroupRoles(long groupId)`
`java.util.List<Role>`	`getGroupRoles(long groupId, int start, int end)`
`java.util.List<Role>`	`getGroupRoles(long groupId, int start, int end, OrderByComparator orderByComparator)`
`int`	`getGroupRolesCount(long groupId)`
`PersistedModel`	`getPersistedModel(java.io.Serializable primaryKeyObj)`
`java.util.List<Role>`	`getResourceBlockRoles(long resourceBlockId, java.lang.String className, java.lang.String actionId)`
`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.
`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.
`Role`	`getRole(long roleId)` Returns the role with the primary key.
`Role`	`getRole(long companyId, java.lang.String name)` Returns the role with the name in the company.
`Role`	`getRoleByUuidAndCompanyId(java.lang.String uuid, long companyId)` Returns the role with the matching UUID and company.
`java.util.List<Role>`	`getRoles(int start, int end)` Returns a range of all the roles.
`java.util.List<Role>`	`getRoles(int type, java.lang.String subtype)` Returns all the roles of the type and subtype.
`java.util.List<Role>`	`getRoles(long companyId)` Returns all the roles in the company.
`java.util.List<Role>`	`getRoles(long[] roleIds)` Returns all the roles with the primary keys.
`java.util.List<Role>`	`getRoles(long companyId, int[] types)` Returns all the roles with the types.
`int`	`getRolesCount()` Returns the number of roles.
`java.util.List<Role>`	`getSubtypeRoles(java.lang.String subtype)` Returns all the roles of the subtype.
`int`	`getSubtypeRolesCount(java.lang.String subtype)` Returns the number of roles of the subtype.
`Role`	`getTeamRole(long companyId, long teamId)` Returns the team role in the company.
`java.util.Map<Team,Role>`	`getTeamRoleMap(long groupId)` Returns the team role map for the group.
`java.util.List<Role>`	`getTeamRoles(long groupId)` Returns the team roles in the group.
`java.util.List<Role>`	`getTeamRoles(long groupId, long[] excludedRoleIds)` Returns the team roles in the group, excluding the specified role IDs.
`java.util.List<Role>`	`getTypeRoles(int type)` Returns all the roles of the type.
`java.util.List<Role>`	`getTypeRoles(int type, int start, int end)` Returns a range of all the roles of the type.
`int`	`getTypeRolesCount(int type)` Returns the number of roles of the type.
`java.util.List<Role>`	`getUserGroupGroupRoles(long userId, long groupId)` Returns all the user's roles within the user group.
`java.util.List<Role>`	`getUserGroupRoles(long userId, long groupId)` Returns all the user's roles within the user group.
`java.util.List<Role>`	`getUserRelatedRoles(long userId, java.util.List<Group> groups)` Returns the union of all the user's roles within the groups.
`java.util.List<Role>`	`getUserRelatedRoles(long userId, long groupId)` Returns all the user's roles within the group.
`java.util.List<Role>`	`getUserRelatedRoles(long userId, long[] groupIds)` Returns the union of all the user's roles within the groups.
`java.util.List<Role>`	`getUserRoles(long userId)`
`java.util.List<Role>`	`getUserRoles(long userId, int start, int end)`
`java.util.List<Role>`	`getUserRoles(long userId, int start, int end, OrderByComparator orderByComparator)`
`int`	`getUserRolesCount(long userId)`
`RoleLocalService`	`getWrappedRoleLocalService()` Deprecated. As of 6.1.0, replaced by `getWrappedService()`
`RoleLocalService`	`getWrappedService()`
`boolean`	`hasGroupRole(long groupId, long roleId)`
`boolean`	`hasGroupRoles(long groupId)`
`boolean`	`hasUserRole(long userId, long roleId)`
`boolean`	`hasUserRole(long userId, long companyId, java.lang.String name, boolean inherited)` Returns `true` if the user is associated with the named regular role.
`boolean`	`hasUserRoles(long userId)`
`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.
`Role`	`loadFetchRole(long companyId, java.lang.String name)` Returns a role with the name in the company.
`Role`	`loadGetRole(long companyId, java.lang.String name)` Returns a role with the name in the company.
`java.util.List<Role>`	`search(long companyId, java.lang.String keywords, java.lang.Integer[] types, int start, int end, OrderByComparator obc)` Returns an ordered range of all the roles that match the keywords and types.
`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 obc)` Returns an ordered range of all the roles that match the keywords, types, and params.
`java.util.List<Role>`	`search(long companyId, java.lang.String name, java.lang.String description, java.lang.Integer[] types, int start, int end, OrderByComparator obc)` Returns an ordered range of all the roles that match the name, description, and types.
`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 obc)` Returns an ordered range of all the roles that match the name, description, types, and params.
`int`	`searchCount(long companyId, java.lang.String keywords, java.lang.Integer[] types)` Returns the number of roles that match the keywords and types.
`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.
`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.
`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.
`void`	`setBeanIdentifier(java.lang.String beanIdentifier)` Sets the Spring bean ID for this bean.
`void`	`setGroupRoles(long groupId, long[] roleIds)`
`void`	`setUserRoles(long userId, long[] roleIds)`
`void`	`setWrappedRoleLocalService(RoleLocalService roleLocalService)` Deprecated. As of 6.1.0, replaced by `setWrappedService(com.liferay.portal.service.RoleLocalService)`
`void`	`setWrappedService(RoleLocalService roleLocalService)`
`void`	`unsetUserRoles(long userId, long[] roleIds)` Removes the matching roles associated with the user.
`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.
`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
  - RoleLocalServiceWrapper
```
public RoleLocalServiceWrapper(RoleLocalService roleLocalService)
```
- Method Detail
  - addRole
```
public Role addRole(Role role)
             throws SystemException
```
    Adds the role to the database. Also notifies the appropriate model listeners.
    
    Specified by:
    
    addRole in interface RoleLocalService
    
    Parameters:
    role - the role
    
    Returns:
    the role that was added
    
    Throws:
    
    SystemException - if a system exception occurred
  - createRole
```
public Role createRole(long roleId)
```
    Creates a new role with the primary key. Does not add the role to the database.
    
    Specified by:
    
    createRole in interface RoleLocalService
    
    Parameters:
    roleId - the primary key for the new role
    
    Returns:
    the new role
  - deleteRole
```
public Role deleteRole(long roleId)
                throws PortalException,
                       SystemException
```
    Deletes the role with the primary key from the database. Also notifies the appropriate model listeners.
    
    Specified by:
    
    deleteRole in interface RoleLocalService
    
    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
    
    SystemException - if a system exception occurred
  - deleteRole
```
public Role deleteRole(Role role)
                throws PortalException,
                       SystemException
```
    Deletes the role from the database. Also notifies the appropriate model listeners.
    
    Specified by:
    
    deleteRole in interface RoleLocalService
    
    Parameters:
    role - the role
    
    Returns:
    the role that was removed
    
    Throws:
    
    PortalException
    
    SystemException - if a system exception occurred
  - dynamicQuery
```
public DynamicQuery dynamicQuery()
```
    Specified by:
    
    dynamicQuery in interface RoleLocalService
  - dynamicQuery
```
public java.util.List dynamicQuery(DynamicQuery dynamicQuery)
                            throws SystemException
```
    Performs a dynamic query on the database and returns the matching rows.
    
    Specified by:
    
    dynamicQuery in interface RoleLocalService
    
    Parameters:
    dynamicQuery - the dynamic query
    
    Returns:
    the matching rows
    
    Throws:
    
    SystemException - if a system exception occurred
  - dynamicQuery
```
public java.util.List dynamicQuery(DynamicQuery dynamicQuery,
                          int start,
                          int end)
                            throws SystemException
```
    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.
    
    Specified by:
    
    dynamicQuery in interface RoleLocalService
    
    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
    
    Throws:
    
    SystemException - if a system exception occurred
  - dynamicQuery
```
public java.util.List dynamicQuery(DynamicQuery dynamicQuery,
                          int start,
                          int end,
                          OrderByComparator orderByComparator)
                            throws SystemException
```
    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.
    
    Specified by:
    
    dynamicQuery in interface RoleLocalService
    
    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
    
    Throws:
    
    SystemException - if a system exception occurred
  - dynamicQueryCount
```
public long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
```
    Returns the number of rows that match the dynamic query.
    
    Specified by:
    
    dynamicQueryCount in interface RoleLocalService
    
    Parameters:
    dynamicQuery - the dynamic query
    
    Returns:
    the number of rows that match the dynamic query
    
    Throws:
    
    SystemException - if a system exception occurred
  - dynamicQueryCount
```
public long dynamicQueryCount(DynamicQuery dynamicQuery,
                     Projection projection)
                       throws SystemException
```
    Returns the number of rows that match the dynamic query.
    
    Specified by:
    
    dynamicQueryCount in interface RoleLocalService
    
    Parameters:
    dynamicQuery - the dynamic query
    projection - the projection to apply to the query
    
    Returns:
    the number of rows that match the dynamic query
    
    Throws:
    
    SystemException - if a system exception occurred
  - fetchRole
```
public Role fetchRole(long roleId)
               throws SystemException
```
    Specified by:
    
    fetchRole in interface RoleLocalService
    
    Throws:
    
    SystemException
  - fetchRoleByUuidAndCompanyId
```
public Role fetchRoleByUuidAndCompanyId(java.lang.String uuid,
                               long companyId)
                                 throws SystemException
```
    Returns the role with the matching UUID and company.
    
    Specified by:
    
    fetchRoleByUuidAndCompanyId in interface RoleLocalService
    
    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
    
    Throws:
    
    SystemException - if a system exception occurred
  - getRole
```
public Role getRole(long roleId)
             throws PortalException,
                    SystemException
```
    Returns the role with the primary key.
    
    Specified by:
    
    getRole in interface RoleLocalService
    
    Parameters:
    roleId - the primary key of the role
    
    Returns:
    the role
    
    Throws:
    
    PortalException - if a role with the primary key could not be found
    
    SystemException - if a system exception occurred
  - getPersistedModel
```
public PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
```
    Specified by:
    
    getPersistedModel in interface PersistedModelLocalService
    
    Specified by:
    
    getPersistedModel in interface RoleLocalService
    
    Throws:
    
    PortalException
    
    SystemException
  - getRoleByUuidAndCompanyId
```
public Role getRoleByUuidAndCompanyId(java.lang.String uuid,
                             long companyId)
                               throws PortalException,
                                      SystemException
```
    Returns the role with the matching UUID and company.
    
    Specified by:
    
    getRoleByUuidAndCompanyId in interface RoleLocalService
    
    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
    
    SystemException - if a system exception occurred
  - getRoles
```
public java.util.List<Role> getRoles(int start,
                            int end)
                              throws SystemException
```
    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.
    
    Specified by:
    
    getRoles in interface RoleLocalService
    
    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
    
    Throws:
    
    SystemException - if a system exception occurred
  - getRolesCount
```
public int getRolesCount()
                  throws SystemException
```
    Returns the number of roles.
    
    Specified by:
    
    getRolesCount in interface RoleLocalService
    
    Returns:
    the number of roles
    
    Throws:
    
    SystemException - if a system exception occurred
  - updateRole
```
public Role updateRole(Role role)
                throws SystemException
```
    Updates the role in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
    
    Specified by:
    
    updateRole in interface RoleLocalService
    
    Parameters:
    role - the role
    
    Returns:
    the role that was updated
    
    Throws:
    
    SystemException - if a system exception occurred
  - addGroupRole
```
public void addGroupRole(long groupId,
                long roleId)
                  throws SystemException
```
    Specified by:
    
    addGroupRole in interface RoleLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - addGroupRole
```
public void addGroupRole(long groupId,
                Role role)
                  throws SystemException
```
    Specified by:
    
    addGroupRole in interface RoleLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - addGroupRoles
```
public void addGroupRoles(long groupId,
                 long[] roleIds)
                   throws SystemException
```
    Specified by:
    
    addGroupRoles in interface RoleLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - addGroupRoles
```
public void addGroupRoles(long groupId,
                 java.util.List<Role> Roles)
                   throws SystemException
```
    Specified by:
    
    addGroupRoles in interface RoleLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - clearGroupRoles
```
public void clearGroupRoles(long groupId)
                     throws SystemException
```
    Specified by:
    
    clearGroupRoles in interface RoleLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - deleteGroupRole
```
public void deleteGroupRole(long groupId,
                   long roleId)
                     throws SystemException
```
    Specified by:
    
    deleteGroupRole in interface RoleLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - deleteGroupRole
```
public void deleteGroupRole(long groupId,
                   Role role)
                     throws SystemException
```
    Specified by:
    
    deleteGroupRole in interface RoleLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - deleteGroupRoles
```
public void deleteGroupRoles(long groupId,
                    long[] roleIds)
                      throws SystemException
```
    Specified by:
    
    deleteGroupRoles in interface RoleLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - deleteGroupRoles
```
public void deleteGroupRoles(long groupId,
                    java.util.List<Role> Roles)
                      throws SystemException
```
    Specified by:
    
    deleteGroupRoles in interface RoleLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - getGroupRoles
```
public java.util.List<Role> getGroupRoles(long groupId)
                                   throws SystemException
```
    Specified by:
    
    getGroupRoles in interface RoleLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - getGroupRoles
```
public java.util.List<Role> getGroupRoles(long groupId,
                                 int start,
                                 int end)
                                   throws SystemException
```
    Specified by:
    
    getGroupRoles in interface RoleLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - getGroupRoles
```
public java.util.List<Role> getGroupRoles(long groupId,
                                 int start,
                                 int end,
                                 OrderByComparator orderByComparator)
                                   throws SystemException
```
    Specified by:
    
    getGroupRoles in interface RoleLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - getGroupRolesCount
```
public int getGroupRolesCount(long groupId)
                       throws SystemException
```
    Specified by:
    
    getGroupRolesCount in interface RoleLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - hasGroupRole
```
public boolean hasGroupRole(long groupId,
                   long roleId)
                     throws SystemException
```
    Specified by:
    
    hasGroupRole in interface RoleLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - hasGroupRoles
```
public boolean hasGroupRoles(long groupId)
                      throws SystemException
```
    Specified by:
    
    hasGroupRoles in interface RoleLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - setGroupRoles
```
public void setGroupRoles(long groupId,
                 long[] roleIds)
                   throws SystemException
```
    Specified by:
    
    setGroupRoles in interface RoleLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - addUserRole
```
public void addUserRole(long userId,
               long roleId)
                 throws SystemException
```
    Specified by:
    
    addUserRole in interface RoleLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - addUserRole
```
public void addUserRole(long userId,
               Role role)
                 throws SystemException
```
    Specified by:
    
    addUserRole in interface RoleLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - addUserRoles
```
public void addUserRoles(long userId,
                long[] roleIds)
                  throws PortalException,
                         SystemException
```
    Specified by:
    
    addUserRoles in interface RoleLocalService
    
    Throws:
    
    PortalException
    
    SystemException - if a system exception occurred
  - addUserRoles
```
public void addUserRoles(long userId,
                java.util.List<Role> Roles)
                  throws PortalException,
                         SystemException
```
    Specified by:
    
    addUserRoles in interface RoleLocalService
    
    Throws:
    
    PortalException
    
    SystemException - if a system exception occurred
  - clearUserRoles
```
public void clearUserRoles(long userId)
                    throws SystemException
```
    Specified by:
    
    clearUserRoles in interface RoleLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - deleteUserRole
```
public void deleteUserRole(long userId,
                  long roleId)
                    throws SystemException
```
    Specified by:
    
    deleteUserRole in interface RoleLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - deleteUserRole
```
public void deleteUserRole(long userId,
                  Role role)
                    throws SystemException
```
    Specified by:
    
    deleteUserRole in interface RoleLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - deleteUserRoles
```
public void deleteUserRoles(long userId,
                   long[] roleIds)
                     throws SystemException
```
    Specified by:
    
    deleteUserRoles in interface RoleLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - deleteUserRoles
```
public void deleteUserRoles(long userId,
                   java.util.List<Role> Roles)
                     throws SystemException
```
    Specified by:
    
    deleteUserRoles in interface RoleLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - getUserRoles
```
public java.util.List<Role> getUserRoles(long userId)
                                  throws SystemException
```
    Specified by:
    
    getUserRoles in interface RoleLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - getUserRoles
```
public java.util.List<Role> getUserRoles(long userId,
                                int start,
                                int end)
                                  throws SystemException
```
    Specified by:
    
    getUserRoles in interface RoleLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - getUserRoles
```
public java.util.List<Role> getUserRoles(long userId,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                                  throws SystemException
```
    Specified by:
    
    getUserRoles in interface RoleLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - getUserRolesCount
```
public int getUserRolesCount(long userId)
                      throws SystemException
```
    Specified by:
    
    getUserRolesCount in interface RoleLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - hasUserRole
```
public boolean hasUserRole(long userId,
                  long roleId)
                    throws SystemException
```
    Specified by:
    
    hasUserRole in interface RoleLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - hasUserRoles
```
public boolean hasUserRoles(long userId)
                     throws SystemException
```
    Specified by:
    
    hasUserRoles in interface RoleLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - setUserRoles
```
public void setUserRoles(long userId,
                long[] roleIds)
                  throws PortalException,
                         SystemException
```
    Specified by:
    
    setUserRoles in interface RoleLocalService
    
    Throws:
    
    PortalException
    
    SystemException - if a system exception occurred
  - getBeanIdentifier
```
public java.lang.String getBeanIdentifier()
```
    Returns the Spring bean ID for this bean.
    
    Specified by:
    
    getBeanIdentifier in interface RoleLocalService
    
    Returns:
    the Spring bean ID for this bean
  - setBeanIdentifier
```
public void setBeanIdentifier(java.lang.String beanIdentifier)
```
    Sets the Spring bean ID for this bean.
    
    Specified by:
    
    setBeanIdentifier in interface RoleLocalService
    
    Parameters:
    beanIdentifier - the Spring bean ID for this bean
  - addRole
```
public Role addRole(long userId,
           long companyId,
           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)
             throws PortalException,
                    SystemException
```
    Deprecated. As of 6.2.0, replaced by addRole(long, String, long, String, Map, Map, int, String, ServiceContext)
    
    Adds a role. The user is reindexed after role is added.
    
    Specified by:
    
    addRole in interface RoleLocalService
    
    Parameters:
    userId - the primary key of the user
    companyId - the primary key of the company
    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)
    
    Returns:
    the role
    
    Throws:
    
    PortalException - if the class name or the role name were invalid, if the role is a duplicate, or if a user with the primary key could not be found
    
    SystemException - if a system exception occurred
  - addRole
```
public Role addRole(long userId,
           long companyId,
           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 className,
           long classPK)
             throws PortalException,
                    SystemException
```
    Deprecated. As of 6.2.0, replaced by addRole(long, String, long, String, Map, Map, int, String, ServiceContext)
    
    Adds a role with additional parameters. The user is reindexed after role is added.
    
    Specified by:
    
    addRole in interface RoleLocalService
    
    Parameters:
    userId - the primary key of the user
    companyId - the primary key of the company
    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)
    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)
    
    Returns:
    the role
    
    Throws:
    
    PortalException - if the class name or the role name were invalid, if the role is a duplicate, or if a user with the primary key could not be found
    
    SystemException - if a system exception occurred
  - addRole
```
public 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,
                    SystemException
```
    Adds a role with additional parameters. The user is reindexed after role is added.
    
    Specified by:
    
    addRole in interface RoleLocalService
    
    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 - if the class name or the role name were invalid, if the role is a duplicate, or if a user with the primary key could not be found
    
    SystemException - if a system exception occurred
  - checkSystemRoles
```
public void checkSystemRoles()
                      throws PortalException,
                             SystemException
```
    Checks to ensure that the system roles map has appropriate default roles in each company.
    
    Specified by:
    
    checkSystemRoles in interface RoleLocalService
    
    Throws:
    
    PortalException - if the current user did not have permission to set applicable permissions on a role
    
    SystemException - if a system exception occurred
  - checkSystemRoles
```
public void checkSystemRoles(long companyId)
                      throws PortalException,
                             SystemException
```
    Checks to ensure that the system roles map has appropriate default roles in the company.
    
    Specified by:
    
    checkSystemRoles in interface RoleLocalService
    
    Parameters:
    companyId - the primary key of the company
    
    Throws:
    
    PortalException - if the current user did not have permission to set applicable permissions on a role
    
    SystemException - if a system exception occurred
  - fetchRole
```
public Role fetchRole(long companyId,
             java.lang.String name)
               throws SystemException
```
    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.
    
    Specified by:
    
    fetchRole in interface RoleLocalService
    
    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
    
    Throws:
    
    SystemException - if a system exception occurred
  - getDefaultGroupRole
```
public Role getDefaultGroupRole(long groupId)
                         throws PortalException,
                                SystemException
```
    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.
    
    Specified by:
    
    getDefaultGroupRole in interface RoleLocalService
    
    Parameters:
    groupId - the primary key of the group
    
    Returns:
    the default role for the group with the primary key
    
    Throws:
    
    PortalException - if a group with the primary key could not be found, or if a default role could not be found for the group
    
    SystemException - if a system exception occurred
  - getGroupRelatedRoles
```
public java.util.List<Role> getGroupRelatedRoles(long groupId)
                                          throws PortalException,
                                                 SystemException
```
    Specified by:
    
    getGroupRelatedRoles in interface RoleLocalService
    
    Throws:
    
    PortalException
    
    SystemException
  - getResourceBlockRoles
```
public java.util.List<Role> getResourceBlockRoles(long resourceBlockId,
                                         java.lang.String className,
                                         java.lang.String actionId)
                                           throws SystemException
```
    Specified by:
    
    getResourceBlockRoles in interface RoleLocalService
    
    Throws:
    
    SystemException
  - getResourceRoles
```
public 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)
                                                                                  throws SystemException
```
    Returns a map of role names to associated action IDs for the named resource in the company within the permission scope.
    
    Specified by:
    
    getResourceRoles in interface RoleLocalService
    
    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
    
    Throws:
    
    SystemException - if a system exception occurred
    See Also:
    RoleFinder.findByC_N_S_P( long, String, int, String)
  - getResourceRoles
```
public java.util.List<Role> getResourceRoles(long companyId,
                                    java.lang.String name,
                                    int scope,
                                    java.lang.String primKey,
                                    java.lang.String actionId)
                                      throws SystemException
```
    Returns all the roles associated with the action ID in the company within the permission scope.
    
    Specified by:
    
    getResourceRoles in interface RoleLocalService
    
    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
    
    Throws:
    
    SystemException - if a system exception occurred
    See Also:
    RoleFinder.findByC_N_S_P_A( long, String, int, String, String)
  - getRole
```
public Role getRole(long companyId,
           java.lang.String name)
             throws PortalException,
                    SystemException
```
    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.
    
    Specified by:
    
    getRole in interface RoleLocalService
    
    Parameters:
    companyId - the primary key of the company
    name - the role's name
    
    Returns:
    the role with the name
    
    Throws:
    
    PortalException - if a role with the name could not be found in the company
    
    SystemException - if a system exception occurred
  - getRoles
```
public java.util.List<Role> getRoles(int type,
                            java.lang.String subtype)
                              throws SystemException
```
    Returns all the roles of the type and subtype.
    
    Specified by:
    
    getRoles in interface RoleLocalService
    
    Parameters:
    type - the role's type (optionally 0)
    subtype - the role's subtype (optionally null)
    
    Returns:
    the roles of the type and subtype
    
    Throws:
    
    SystemException - if a system exception occurred
  - getRoles
```
public java.util.List<Role> getRoles(long companyId)
                              throws SystemException
```
    Returns all the roles in the company.
    
    Specified by:
    
    getRoles in interface RoleLocalService
    
    Parameters:
    companyId - the primary key of the company
    
    Returns:
    the roles in the company
    
    Throws:
    
    SystemException - if a system exception occurred
  - getRoles
```
public java.util.List<Role> getRoles(long companyId,
                            int[] types)
                              throws SystemException
```
    Returns all the roles with the types.
    
    Specified by:
    
    getRoles in interface RoleLocalService
    
    Parameters:
    companyId - the primary key of the company
    types - the role types (optionally null)
    
    Returns:
    the roles with the types
    
    Throws:
    
    SystemException - if a system exception occurred
  - getRoles
```
public java.util.List<Role> getRoles(long[] roleIds)
                              throws PortalException,
                                     SystemException
```
    Returns all the roles with the primary keys.
    
    Specified by:
    
    getRoles in interface RoleLocalService
    
    Parameters:
    roleIds - the primary keys of the roles
    
    Returns:
    the roles with the primary keys
    
    Throws:
    
    PortalException - if any one of the roles with the primary keys could not be found
    
    SystemException - if a system exception occurred
  - getSubtypeRoles
```
public java.util.List<Role> getSubtypeRoles(java.lang.String subtype)
                                     throws SystemException
```
    Returns all the roles of the subtype.
    
    Specified by:
    
    getSubtypeRoles in interface RoleLocalService
    
    Parameters:
    subtype - the role's subtype (optionally null)
    
    Returns:
    the roles of the subtype
    
    Throws:
    
    SystemException - if a system exception occurred
  - getSubtypeRolesCount
```
public int getSubtypeRolesCount(java.lang.String subtype)
                         throws SystemException
```
    Returns the number of roles of the subtype.
    
    Specified by:
    
    getSubtypeRolesCount in interface RoleLocalService
    
    Parameters:
    subtype - the role's subtype (optionally null)
    
    Returns:
    the number of roles of the subtype
    
    Throws:
    
    SystemException - if a system exception occurred
  - getTeamRole
```
public Role getTeamRole(long companyId,
               long teamId)
                 throws PortalException,
                        SystemException
```
    Returns the team role in the company.
    
    Specified by:
    
    getTeamRole in interface RoleLocalService
    
    Parameters:
    companyId - the primary key of the company
    teamId - the primary key of the team
    
    Returns:
    the team role in the company
    
    Throws:
    
    PortalException - if a role could not be found in the team and company
    
    SystemException - if a system exception occurred
  - getTeamRoleMap
```
public java.util.Map<Team,Role> getTeamRoleMap(long groupId)
                                        throws PortalException,
                                               SystemException
```
    Returns the team role map for the group.
    
    Specified by:
    
    getTeamRoleMap in interface RoleLocalService
    
    Parameters:
    groupId - the primary key of the group
    
    Returns:
    the team role map for the group
    
    Throws:
    
    PortalException - if a group with the primary key could not be found, if a role could not be found in one of the group's teams, or if a portal exception occurred
    
    SystemException - if a system exception occurred
  - getTeamRoles
```
public java.util.List<Role> getTeamRoles(long groupId)
                                  throws PortalException,
                                         SystemException
```
    Returns the team roles in the group.
    
    Specified by:
    
    getTeamRoles in interface RoleLocalService
    
    Parameters:
    groupId - the primary key of the group
    
    Returns:
    the team roles in the group
    
    Throws:
    
    PortalException - if a group with the primary key could not be found, if a role could not be found in one of the group's teams, or if a portal exception occurred
    
    SystemException - if a system exception occurred
  - getTeamRoles
```
public java.util.List<Role> getTeamRoles(long groupId,
                                long[] excludedRoleIds)
                                  throws PortalException,
                                         SystemException
```
    Returns the team roles in the group, excluding the specified role IDs.
    
    Specified by:
    
    getTeamRoles in interface RoleLocalService
    
    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 - if a group with the primary key could not be found, if a role could not be found in one of the group's teams, or if a portal exception occurred
    
    SystemException - if a system exception occurred
  - getTypeRoles
```
public java.util.List<Role> getTypeRoles(int type)
                                  throws SystemException
```
    Returns all the roles of the type.
    
    Specified by:
    
    getTypeRoles in interface RoleLocalService
    
    Parameters:
    type - the role's type (optionally 0)
    
    Returns:
    the range of the roles of the type
    
    Throws:
    
    SystemException - if a system exception occurred
  - getTypeRoles
```
public java.util.List<Role> getTypeRoles(int type,
                                int start,
                                int end)
                                  throws SystemException
```
    Returns a range of all the roles of the type.
    
    Specified by:
    
    getTypeRoles in interface RoleLocalService
    
    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
    
    Throws:
    
    SystemException - if a system exception occurred
  - getTypeRolesCount
```
public int getTypeRolesCount(int type)
                      throws SystemException
```
    Returns the number of roles of the type.
    
    Specified by:
    
    getTypeRolesCount in interface RoleLocalService
    
    Parameters:
    type - the role's type (optionally 0)
    
    Returns:
    the number of roles of the type
    
    Throws:
    
    SystemException - if a system exception occurred
  - getUserGroupGroupRoles
```
public java.util.List<Role> getUserGroupGroupRoles(long userId,
                                          long groupId)
                                            throws SystemException
```
    Returns all the user's roles within the user group.
    
    Specified by:
    
    getUserGroupGroupRoles in interface RoleLocalService
    
    Parameters:
    userId - the primary key of the user
    groupId - the primary key of the group
    
    Returns:
    the user's roles within the user group
    
    Throws:
    
    SystemException - if a system exception occurred
    See Also:
    RoleFinder.findByUserGroupGroupRole( long, long)
  - getUserGroupRoles
```
public java.util.List<Role> getUserGroupRoles(long userId,
                                     long groupId)
                                       throws SystemException
```
    Returns all the user's roles within the user group.
    
    Specified by:
    
    getUserGroupRoles in interface RoleLocalService
    
    Parameters:
    userId - the primary key of the user
    groupId - the primary key of the group
    
    Returns:
    the user's roles within the user group
    
    Throws:
    
    SystemException - if a system exception occurred
    See Also:
    RoleFinder.findByUserGroupRole( long, long)
  - getUserRelatedRoles
```
public java.util.List<Role> getUserRelatedRoles(long userId,
                                       java.util.List<Group> groups)
                                         throws SystemException
```
    Returns the union of all the user's roles within the groups.
    
    Specified by:
    
    getUserRelatedRoles in interface RoleLocalService
    
    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
    
    Throws:
    
    SystemException - if a system exception occurred
    See Also:
    RoleFinder.findByU_G( long, List)
  - getUserRelatedRoles
```
public java.util.List<Role> getUserRelatedRoles(long userId,
                                       long groupId)
                                         throws SystemException
```
    Returns all the user's roles within the group.
    
    Specified by:
    
    getUserRelatedRoles in interface RoleLocalService
    
    Parameters:
    userId - the primary key of the user
    groupId - the primary key of the group
    
    Returns:
    the user's roles within the group
    
    Throws:
    
    SystemException - if a system exception occurred
    See Also:
    RoleFinder.findByU_G( long, long)
  - getUserRelatedRoles
```
public java.util.List<Role> getUserRelatedRoles(long userId,
                                       long[] groupIds)
                                         throws SystemException
```
    Returns the union of all the user's roles within the groups.
    
    Specified by:
    
    getUserRelatedRoles in interface RoleLocalService
    
    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
    
    Throws:
    
    SystemException - if a system exception occurred
    See Also:
    RoleFinder.findByU_G( long, long[])
  - hasUserRole
```
public boolean hasUserRole(long userId,
                  long companyId,
                  java.lang.String name,
                  boolean inherited)
                    throws PortalException,
                           SystemException
```
    Returns true if the user is associated with the named regular role.
    
    Specified by:
    
    hasUserRole in interface RoleLocalService
    
    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 - if a default user for the company could not be found
    
    SystemException - if a system exception occurred
  - hasUserRoles
```
public boolean hasUserRoles(long userId,
                   long companyId,
                   java.lang.String[] names,
                   boolean inherited)
                     throws PortalException,
                            SystemException
```
    Returns true if the user has any one of the named regular roles.
    
    Specified by:
    
    hasUserRoles in interface RoleLocalService
    
    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 - if any one of the roles with the names could not be found in the company or if the default user for the company could not be found
    
    SystemException - if a system exception occurred
  - loadFetchRole
```
public Role loadFetchRole(long companyId,
                 java.lang.String name)
                   throws SystemException
```
    Returns a role with the name in the company.
    
    Specified by:
    
    loadFetchRole in interface RoleLocalService
    
    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
    
    Throws:
    
    SystemException - if a system exception occurred
  - loadGetRole
```
public Role loadGetRole(long companyId,
               java.lang.String name)
                 throws PortalException,
                        SystemException
```
    Returns a role with the name in the company.
    
    Specified by:
    
    loadGetRole in interface RoleLocalService
    
    Parameters:
    companyId - the primary key of the company
    name - the role's name
    
    Returns:
    the role with the name in the company
    
    Throws:
    
    PortalException - if a role with the name could not be found in the company
    
    SystemException - if a system exception occurred
  - search
```
public java.util.List<Role> search(long companyId,
                          java.lang.String keywords,
                          java.lang.Integer[] types,
                          int start,
                          int end,
                          OrderByComparator obc)
                            throws SystemException
```
    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.
    
    Specified by:
    
    search in interface RoleLocalService
    
    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
    
    Throws:
    
    SystemException - if a system exception occurred
    See Also:
    RoleFinder
  - search
```
public 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 obc)
                            throws SystemException
```
    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.
    
    Specified by:
    
    search in interface RoleLocalService
    
    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
    
    Throws:
    
    SystemException - if a system exception occurred
    See Also:
    RoleFinder
  - search
```
public java.util.List<Role> search(long companyId,
                          java.lang.String name,
                          java.lang.String description,
                          java.lang.Integer[] types,
                          int start,
                          int end,
                          OrderByComparator obc)
                            throws SystemException
```
    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.
    
    Specified by:
    
    search in interface RoleLocalService
    
    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
    
    Throws:
    
    SystemException - if a system exception occurred
    See Also:
    RoleFinder
  - search
```
public 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 obc)
                            throws SystemException
```
    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.
    
    Specified by:
    
    search in interface RoleLocalService
    
    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
    
    Throws:
    
    SystemException - if a system exception occurred
    See Also:
    RoleFinder
  - searchCount
```
public int searchCount(long companyId,
              java.lang.String keywords,
              java.lang.Integer[] types)
                throws SystemException
```
    Returns the number of roles that match the keywords and types.
    
    Specified by:
    
    searchCount in interface RoleLocalService
    
    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
    
    Throws:
    
    SystemException - if a system exception occurred
  - searchCount
```
public int searchCount(long companyId,
              java.lang.String keywords,
              java.lang.Integer[] types,
              java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)
                throws SystemException
```
    Returns the number of roles that match the keywords, types and params.
    
    Specified by:
    
    searchCount in interface RoleLocalService
    
    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
    
    Throws:
    
    SystemException - if a system exception occurred
  - searchCount
```
public int searchCount(long companyId,
              java.lang.String name,
              java.lang.String description,
              java.lang.Integer[] types)
                throws SystemException
```
    Returns the number of roles that match the name, description, and types.
    
    Specified by:
    
    searchCount in interface RoleLocalService
    
    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
    
    Throws:
    
    SystemException - if a system exception occurred
  - searchCount
```
public 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)
                throws SystemException
```
    Returns the number of roles that match the name, description, types, and params.
    
    Specified by:
    
    searchCount in interface RoleLocalService
    
    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
    
    Throws:
    
    SystemException - if a system exception occurred
  - unsetUserRoles
```
public void unsetUserRoles(long userId,
                  long[] roleIds)
                    throws PortalException,
                           SystemException
```
    Removes the matching roles associated with the user. The user is reindexed after the roles are removed.
    
    Specified by:
    
    unsetUserRoles in interface RoleLocalService
    
    Parameters:
    userId - the primary key of the user
    roleIds - the primary keys of the roles
    
    Throws:
    
    PortalException - if a user with the primary key could not be found or if a role with any one of the primary keys could not be found
    
    SystemException - if a system exception occurred
  - updateRole
```
public 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,
                       SystemException
```
    Updates the role with the primary key.
    
    Specified by:
    
    updateRole in interface RoleLocalService
    
    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 - if a role with the primary could not be found or if the role's name was invalid
    
    SystemException - if a system exception occurred
  - getWrappedRoleLocalService
```
public RoleLocalService getWrappedRoleLocalService()
```
    Deprecated. As of 6.1.0, replaced by getWrappedService()
  - setWrappedRoleLocalService
```
public void setWrappedRoleLocalService(RoleLocalService roleLocalService)
```
    Deprecated. As of 6.1.0, replaced by setWrappedService(com.liferay.portal.service.RoleLocalService)
  - getWrappedService
```
public RoleLocalService getWrappedService()
```
    Specified by:
    
    getWrappedService in interface ServiceWrapper<RoleLocalService>
  - setWrappedService
```
public void setWrappedService(RoleLocalService roleLocalService)
```
    Specified by:
    
    setWrappedService in interface ServiceWrapper<RoleLocalService>

Class RoleLocalServiceWrapper

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RoleLocalServiceWrapper

Method Detail

addRole

createRole

deleteRole

deleteRole

dynamicQuery

dynamicQuery

dynamicQuery

dynamicQuery

dynamicQueryCount

dynamicQueryCount

fetchRole

fetchRoleByUuidAndCompanyId

getRole

getPersistedModel

getRoleByUuidAndCompanyId

getRoles

getRolesCount

updateRole

addGroupRole

addGroupRole

addGroupRoles

addGroupRoles

clearGroupRoles

deleteGroupRole

deleteGroupRole

deleteGroupRoles

deleteGroupRoles

getGroupRoles

getGroupRoles

getGroupRoles

getGroupRolesCount

hasGroupRole

hasGroupRoles

setGroupRoles

addUserRole

addUserRole

addUserRoles

addUserRoles

clearUserRoles

deleteUserRole

deleteUserRole

deleteUserRoles

deleteUserRoles

getUserRoles

getUserRoles

getUserRoles

getUserRolesCount

hasUserRole

hasUserRoles

setUserRoles

getBeanIdentifier

setBeanIdentifier

addRole

addRole

addRole

checkSystemRoles

checkSystemRoles

fetchRole

getDefaultGroupRole

getGroupRelatedRoles

getResourceBlockRoles

getResourceRoles

getResourceRoles

getRole

getRoles

getRoles

getRoles

getRoles

getSubtypeRoles

getSubtypeRolesCount

getTeamRole

getTeamRoleMap

getTeamRoles