com.liferay.portal.kernel.service

Class RoleServiceWrapper

Object

com.liferay.portal.kernel.service.RoleServiceWrapper

All Implemented Interfaces:

BaseService, RoleService, ServiceWrapper<RoleService>

public class RoleServiceWrapper
extends Object
implements RoleService, ServiceWrapper<RoleService>

Provides a wrapper for RoleService.

Author:

Brian Wing Shun Chan

See Also:

RoleService

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
RoleServiceWrapper()
RoleServiceWrapper(RoleService roleService)

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.
RoleService	getWrappedService()
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> orderByComparator)
int	searchCount(long companyId, String keywords, Integer[] types, LinkedHashMap<String,Object> params)
void	setWrappedService(RoleService roleService)
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.

Methods inherited from class Object

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

Constructor Detail

RoleServiceWrapper

public RoleServiceWrapper()

RoleServiceWrapper

public RoleServiceWrapper(RoleService roleService)

Method Detail

addRole

public 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.

Specified by:

addRole in interface RoleService

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

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

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

Specified by:

addUserRoles in interface RoleService

Parameters:

userId - the primary key of the user

roleIds - the primary keys of the roles

Throws:

PortalException

deleteRole

public void deleteRole(long roleId)
                throws PortalException

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

Specified by:

deleteRole in interface RoleService

Parameters:

roleId - the primary key of the role

Throws:

PortalException

fetchRole

public Role fetchRole(long roleId)
               throws PortalException

Specified by:

fetchRole in interface RoleService

Throws:

PortalException

getGroupRoles

public List<Role> getGroupRoles(long groupId)
                         throws PortalException

Returns all the roles associated with the group.

Specified by:

getGroupRoles in interface RoleService

Parameters:

groupId - the primary key of the group

Returns:

the roles associated with the group

Throws:

PortalException

getGroupRolesAndTeamRoles

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

Specified by:

getGroupRolesAndTeamRoles in interface RoleService

getGroupRolesAndTeamRolesCount

public int getGroupRolesAndTeamRolesCount(long companyId,
                                          String keywords,
                                          List<String> excludedNames,
                                          int[] types,
                                          long excludedTeamRoleId,
                                          long teamGroupId)

Specified by:

getGroupRolesAndTeamRolesCount in interface RoleService

getOSGiServiceIdentifier

public String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Specified by:

getOSGiServiceIdentifier in interface RoleService

Returns:

the OSGi service identifier

getRole

public Role getRole(long roleId)
             throws PortalException

Returns the role with the primary key.

Specified by:

getRole in interface RoleService

Parameters:

roleId - the primary key of the role

Returns:

the role with the primary key

Throws:

PortalException

getRole

public 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.

Specified by:

getRole in interface RoleService

Parameters:

companyId - the primary key of the company

name - the role's name

Returns:

the role with the name

Throws:

PortalException

getRoles

public List<Role> getRoles(int type,
                           String subtype)
                    throws PortalException

Specified by:

getRoles in interface RoleService

Throws:

PortalException

getRoles

public List<Role> getRoles(long companyId,
                           int[] types)
                    throws PortalException

Specified by:

getRoles in interface RoleService

Throws:

PortalException

getUserGroupGroupRoles

public List<Role> getUserGroupGroupRoles(long userId,
                                         long groupId)
                                  throws PortalException

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

Specified by:

getUserGroupGroupRoles in interface RoleService

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

public List<Role> getUserGroupRoles(long userId,
                                    long groupId)
                             throws PortalException

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

Specified by:

getUserGroupRoles in interface RoleService

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

public List<Role> getUserRelatedRoles(long userId,
                                      List<Group> groups)
                               throws PortalException

Returns the union of all the user's roles within the groups. If no groups are provided, only the user's directly assigned roles are returned.

Specified by:

getUserRelatedRoles in interface RoleService

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

public List<Role> getUserRoles(long userId)
                        throws PortalException

Returns all the roles associated with the user.

Specified by:

getUserRoles in interface RoleService

Parameters:

userId - the primary key of the user

Returns:

the roles associated with the user

Throws:

PortalException

hasUserRole

public boolean hasUserRole(long userId,
                           long companyId,
                           String name,
                           boolean inherited)
                    throws PortalException

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

Specified by:

hasUserRole in interface RoleService

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 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.

Specified by:

hasUserRoles in interface RoleService

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

public List<Role> search(long companyId,
                         String keywords,
                         Integer[] types,
                         LinkedHashMap<String,Object> params,
                         int start,
                         int end,
                         OrderByComparator<Role> orderByComparator)

Specified by:

search in interface RoleService

searchCount

public int searchCount(long companyId,
                       String keywords,
                       Integer[] types,
                       LinkedHashMap<String,Object> params)

Specified by:

searchCount in interface RoleService

unsetUserRoles

public 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.

Specified by:

unsetUserRoles in interface RoleService

Parameters:

userId - the primary key of the user

roleIds - the primary keys of the roles

Throws:

PortalException

updateRole

public 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.

Specified by:

updateRole in interface RoleService

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

getWrappedService

public RoleService getWrappedService()

Specified by:

getWrappedService in interface ServiceWrapper<RoleService>

setWrappedService

public void setWrappedService(RoleService roleService)

Specified by:

setWrappedService in interface ServiceWrapper<RoleService>