com.liferay.portal.kernel.service

Interface RoleService

All Superinterfaces:

BaseService

All Known Implementing Classes:

RoleServiceWrapper

@AccessControlled
 @JSONWebService
 @ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface RoleService
extends BaseService

Provides the remote service interface for Role. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.

Author:

Brian Wing Shun Chan

See Also:

RoleServiceUtil, RoleServiceBaseImpl, RoleServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
Role	addRole(String className, long classPK, String name, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, int type, String subtype, ServiceContext serviceContext) Adds a role.
void	addUserRoles(long userId, long[] roleIds) Adds the roles to the user.
void	deleteRole(long roleId) Deletes the role with the primary key and its associated permissions.
Role	fetchRole(long roleId)
List<Role>	getGroupRoles(long groupId) Returns all the roles associated with the group.
List<Role>	getGroupRolesAndTeamRoles(long companyId, String keywords, List<String> excludedNames, int[] types, long excludedTeamRoleId, long teamGroupId, int start, int end)
int	getGroupRolesAndTeamRolesCount(long companyId, String keywords, List<String> excludedNames, int[] types, long excludedTeamRoleId, long teamGroupId)
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
Role	getRole(long roleId) Returns the role with the primary key.
Role	getRole(long companyId, String name) Returns the role with the name in the company.
List<Role>	getRoles(int type, String subtype)
List<Role>	getRoles(long companyId, int[] types)
List<Role>	getUserGroupGroupRoles(long userId, long groupId) Returns all the user's roles within the user group.
List<Role>	getUserGroupRoles(long userId, long groupId) Returns all the user's roles within the user group.
List<Role>	getUserRelatedRoles(long userId, List<Group> groups) Returns the union of all the user's roles within the groups.
List<Role>	getUserRoles(long userId) Returns all the roles associated with the user.
boolean	hasUserRole(long userId, long companyId, String name, boolean inherited) Returns true if the user is associated with the named regular role.
boolean	hasUserRoles(long userId, long companyId, String[] names, boolean inherited) Returns true if the user has any one of the named regular roles.
List<Role>	search(long companyId, String keywords, Integer[] types, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator<Role> obc)
int	searchCount(long companyId, String keywords, Integer[] types, LinkedHashMap<String,Object> params)
void	unsetUserRoles(long userId, long[] roleIds) Removes the matching roles associated with the user.
Role	updateRole(long roleId, String name, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String subtype, ServiceContext serviceContext) Updates the role with the primary key.

Method Detail

addRole

Role addRole(String className,
             long classPK,
             String name,
             Map<Locale,String> titleMap,
             Map<Locale,String> descriptionMap,
             int type,
             String subtype,
             ServiceContext serviceContext)
      throws PortalException

Adds a role. The user is reindexed after role is added.

Parameters:

className - the name of the class for which the role is created

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 the expando bridge attributes for the role.

Returns:

the role

Throws:

PortalException

addUserRoles

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

Adds the roles to the user. The user is reindexed after the roles are added.

Parameters:

userId - the primary key of the user

roleIds - the primary keys of the roles

Throws:

PortalException

deleteRole

void deleteRole(long roleId)
         throws PortalException

Deletes the role with the primary key and its associated permissions.

Parameters:

roleId - the primary key of the role

Throws:

PortalException

fetchRole

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Role fetchRole(long roleId)
                                                                           throws PortalException

Throws:

PortalException

getGroupRoles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Role> getGroupRoles(long groupId)
                                                                                     throws PortalException

Returns all the roles associated with the group.

Parameters:

groupId - the primary key of the group

Returns:

the roles associated with the group

Throws:

PortalException

getGroupRolesAndTeamRoles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Role> getGroupRolesAndTeamRoles(long companyId,
                                                                                                        String keywords,
                                                                                                        List<String> excludedNames,
                                                                                                        int[] types,
                                                                                                        long excludedTeamRoleId,
                                                                                                        long teamGroupId,
                                                                                                        int start,
                                                                                                        int end)

getGroupRolesAndTeamRolesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getGroupRolesAndTeamRolesCount(long companyId,
                                                                                                      String keywords,
                                                                                                      List<String> excludedNames,
                                                                                                      int[] types,
                                                                                                      long excludedTeamRoleId,
                                                                                                      long teamGroupId)

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getRole

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Role getRole(long roleId)
                                                                         throws PortalException

Returns the role with the primary key.

Parameters:

roleId - the primary key of the role

Returns:

the role with the primary key

Throws:

PortalException

getRole

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Role getRole(long companyId,
                                                                                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

getRoles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Role> getRoles(int type,
                                                                                       String subtype)
                                                                                throws PortalException

Throws:

PortalException

getRoles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Role> getRoles(long companyId,
                                                                                       int[] types)
                                                                                throws PortalException

Throws:

PortalException

getUserGroupGroupRoles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Role> getUserGroupGroupRoles(long userId,
                                                                                                     long groupId)
                                                                                              throws PortalException

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

Throws:

PortalException

getUserGroupRoles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Role> getUserGroupRoles(long userId,
                                                                                                long groupId)
                                                                                         throws PortalException

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

Throws:

PortalException

getUserRelatedRoles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Role> getUserRelatedRoles(long userId,
                                                                                                  List<Group> groups)
                                                                                           throws PortalException

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

Throws:

PortalException

getUserRoles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Role> getUserRoles(long userId)
                                                                                    throws PortalException

Returns all the roles associated with the user.

Parameters:

userId - the primary key of the user

Returns:

the roles associated with the user

Throws:

PortalException

hasUserRole

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasUserRole(long userId,
                                                                                       long companyId,
                                                                                       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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasUserRoles(long userId,
                                                                                        long companyId,
                                                                                        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

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Role> search(long companyId,
                                                                                     String keywords,
                                                                                     Integer[] types,
                                                                                     LinkedHashMap<String,Object> params,
                                                                                     int start,
                                                                                     int end,
                                                                                     OrderByComparator<Role> obc)

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                                                   String keywords,
                                                                                   Integer[] types,
                                                                                   LinkedHashMap<String,Object> params)

unsetUserRoles

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

Role updateRole(long roleId,
                String name,
                Map<Locale,String> titleMap,
                Map<Locale,String> descriptionMap,
                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 the expando bridge attributes for the role.

Returns:

the role with the primary key

Throws:

PortalException