com.liferay.portal.service
Class RoleLocalServiceWrapper

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

All Implemented Interfaces:

BaseLocalService, PersistedModelLocalService, RoleLocalService, ServiceWrapper<RoleLocalService>

public class RoleLocalServiceWrapper
extends Object
implements RoleLocalService, ServiceWrapper<RoleLocalService>

This class is a wrapper for RoleLocalService.

See Also:

RoleLocalService

Constructor Summary

RoleLocalServiceWrapper(RoleLocalService roleLocalService)

Method Summary

void	addGroupRole(long groupId, long roleId)
void	addGroupRole(long groupId, Role role)
void	addGroupRoles(long groupId, List<Role> Roles)
void	addGroupRoles(long groupId, long[] roleIds)
void	addPermissionRole(long permissionId, long roleId)
void	addPermissionRole(long permissionId, Role role)
void	addPermissionRoles(long permissionId, List<Role> Roles)
void	addPermissionRoles(long permissionId, long[] roleIds)
Role	addRole(long userId, long companyId, String name, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, int type) Deprecated. addRole(long, String, long, String, Map, Map, int, String)
Role	addRole(long userId, long companyId, String name, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, int type, String className, long classPK) Deprecated. addRole(long, String, long, String, Map, Map, int, String)
Role	addRole(long userId, String className, long classPK, String name, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, int type, String subType) 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, 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	clearPermissionRoles(long permissionId)
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, List<Role> Roles)
void	deleteGroupRoles(long groupId, long[] roleIds)
void	deletePermissionRole(long permissionId, long roleId)
void	deletePermissionRole(long permissionId, Role role)
void	deletePermissionRoles(long permissionId, List<Role> Roles)
void	deletePermissionRoles(long permissionId, 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, List<Role> Roles)
void	deleteUserRoles(long userId, long[] roleIds)
DynamicQuery	dynamicQuery()
List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
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.
Role	fetchRole(long roleId)
Role	fetchRole(long companyId, String name) Returns the role with the name in the company.
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.
List<Role>	getGroupRoles(long groupId)
List<Role>	getGroupRoles(long groupId, int start, int end)
List<Role>	getGroupRoles(long groupId, int start, int end, OrderByComparator orderByComparator)
int	getGroupRolesCount(long groupId)
List<Role>	getPermissionRoles(long permissionId)
List<Role>	getPermissionRoles(long permissionId, int start, int end)
List<Role>	getPermissionRoles(long permissionId, int start, int end, OrderByComparator orderByComparator)
int	getPermissionRolesCount(long permissionId)
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
List<Role>	getResourceBlockRoles(long resourceBlockId, String className, String actionId)
Map<String,List<String>>	getResourceRoles(long companyId, String name, int scope, String primKey) Returns a map of role names to associated action IDs for the named resource in the company within the permission scope.
List<Role>	getResourceRoles(long companyId, String name, int scope, String primKey, 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, String name) Returns the role with the name in the company.
List<Role>	getRoles(int start, int end) Returns a range of all the roles.
List<Role>	getRoles(int type, String subtype) Returns all the roles of the type and subtype.
List<Role>	getRoles(long companyId) Returns all the roles in the company.
List<Role>	getRoles(long[] roleIds) Returns all the roles with the primary keys.
int	getRolesCount() Returns the number of roles.
List<Role>	getSubtypeRoles(String subtype) Returns all the roles of the subtype.
int	getSubtypeRolesCount(String subtype) Returns the number of roles of the subtype.
Role	getTeamRole(long companyId, long teamId) Returns the team role in the company.
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>	getUserRelatedRoles(long userId, long groupId) Returns all the user's roles within the group.
List<Role>	getUserRelatedRoles(long userId, long[] groupIds) Returns the union of all the user's roles within the groups.
List<Role>	getUserRoles(long userId)
List<Role>	getUserRoles(long userId, int start, int end)
List<Role>	getUserRoles(long userId, int start, int end, OrderByComparator orderByComparator)
int	getUserRolesCount(long userId)
RoleLocalService	getWrappedRoleLocalService() Deprecated. Renamed to getWrappedService()
RoleLocalService	getWrappedService()
boolean	hasGroupRole(long groupId, long roleId)
boolean	hasGroupRoles(long groupId)
boolean	hasPermissionRole(long permissionId, long roleId)
boolean	hasPermissionRoles(long permissionId)
boolean	hasUserRole(long userId, long roleId)
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)
boolean	hasUserRoles(long userId, long companyId, String[] names, boolean inherited) Returns true if the user has any one of the named regular roles.
Role	loadFetchRole(long companyId, String name) Returns a role with the name in the company.
Role	loadGetRole(long companyId, String name) Returns a role with the name in the company.
List<Role>	search(long companyId, String keywords, Integer[] types, int start, int end, OrderByComparator obc) Returns an ordered range of all the roles that match the keywords and types.
List<Role>	search(long companyId, String keywords, Integer[] types, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator obc) Returns an ordered range of all the roles that match the keywords, types, and params.
List<Role>	search(long companyId, String name, String description, Integer[] types, int start, int end, OrderByComparator obc) Returns an ordered range of all the roles that match the name, description, and types.
List<Role>	search(long companyId, String name, String description, Integer[] types, LinkedHashMap<String,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, String keywords, Integer[] types) Returns the number of roles that match the keywords and types.
int	searchCount(long companyId, String keywords, Integer[] types, LinkedHashMap<String,Object> params) Returns the number of roles that match the keywords, types and params.
int	searchCount(long companyId, String name, String description, Integer[] types) Returns the number of roles that match the name, description, and types.
int	searchCount(long companyId, String name, String description, Integer[] types, LinkedHashMap<String,Object> params) Returns the number of roles that match the name, description, types, and params.
void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setGroupRoles(long groupId, long[] roleIds)
void	setPermissionRoles(long permissionId, long[] roleIds)
void	setUserRoles(long userId, long[] roleIds)
void	setWrappedRoleLocalService(RoleLocalService roleLocalService) Deprecated. Renamed to 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, String name, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String subtype) 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.
Role	updateRole(Role role, boolean merge) 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 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 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.

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

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

fetchRole

public Role fetchRole(long roleId)
               throws SystemException

Specified by:

fetchRole in interface RoleLocalService

Throws:

SystemException

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(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Specified by:

getPersistedModel in interface RoleLocalService

Throws:

PortalException

SystemException

getRoles

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

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

updateRole

public Role updateRole(Role role,
                       boolean merge)
                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

merge - whether to merge the role with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.

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,
                          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,
                             List<Role> Roles)
                      throws SystemException

Specified by:

deleteGroupRoles in interface RoleLocalService

Throws:

SystemException - if a system exception occurred

getGroupRoles

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

Specified by:

getGroupRoles in interface RoleLocalService

Throws:

SystemException - if a system exception occurred

getGroupRoles

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

addPermissionRole

public void addPermissionRole(long permissionId,
                              long roleId)
                       throws SystemException

Specified by:

addPermissionRole in interface RoleLocalService

Throws:

SystemException - if a system exception occurred

addPermissionRole

public void addPermissionRole(long permissionId,
                              Role role)
                       throws SystemException

Specified by:

addPermissionRole in interface RoleLocalService

Throws:

SystemException - if a system exception occurred

addPermissionRoles

public void addPermissionRoles(long permissionId,
                               long[] roleIds)
                        throws SystemException

Specified by:

addPermissionRoles in interface RoleLocalService

Throws:

SystemException - if a system exception occurred

addPermissionRoles

public void addPermissionRoles(long permissionId,
                               List<Role> Roles)
                        throws SystemException

Specified by:

addPermissionRoles in interface RoleLocalService

Throws:

SystemException - if a system exception occurred

clearPermissionRoles

public void clearPermissionRoles(long permissionId)
                          throws SystemException

Specified by:

clearPermissionRoles in interface RoleLocalService

Throws:

SystemException - if a system exception occurred

deletePermissionRole

public void deletePermissionRole(long permissionId,
                                 long roleId)
                          throws SystemException

Specified by:

deletePermissionRole in interface RoleLocalService

Throws:

SystemException - if a system exception occurred

deletePermissionRole

public void deletePermissionRole(long permissionId,
                                 Role role)
                          throws SystemException

Specified by:

deletePermissionRole in interface RoleLocalService

Throws:

SystemException - if a system exception occurred

deletePermissionRoles

public void deletePermissionRoles(long permissionId,
                                  long[] roleIds)
                           throws SystemException

Specified by:

deletePermissionRoles in interface RoleLocalService

Throws:

SystemException - if a system exception occurred

deletePermissionRoles

public void deletePermissionRoles(long permissionId,
                                  List<Role> Roles)
                           throws SystemException

Specified by:

deletePermissionRoles in interface RoleLocalService

Throws:

SystemException - if a system exception occurred

getPermissionRoles

public List<Role> getPermissionRoles(long permissionId)
                              throws SystemException

Specified by:

getPermissionRoles in interface RoleLocalService

Throws:

SystemException - if a system exception occurred

getPermissionRoles

public List<Role> getPermissionRoles(long permissionId,
                                     int start,
                                     int end)
                              throws SystemException

Specified by:

getPermissionRoles in interface RoleLocalService

Throws:

SystemException - if a system exception occurred

getPermissionRoles

public List<Role> getPermissionRoles(long permissionId,
                                     int start,
                                     int end,
                                     OrderByComparator orderByComparator)
                              throws SystemException

Specified by:

getPermissionRoles in interface RoleLocalService

Throws:

SystemException - if a system exception occurred

getPermissionRolesCount

public int getPermissionRolesCount(long permissionId)
                            throws SystemException

Specified by:

getPermissionRolesCount in interface RoleLocalService

Throws:

SystemException - if a system exception occurred

hasPermissionRole

public boolean hasPermissionRole(long permissionId,
                                 long roleId)
                          throws SystemException

Specified by:

hasPermissionRole in interface RoleLocalService

Throws:

SystemException - if a system exception occurred

hasPermissionRoles

public boolean hasPermissionRoles(long permissionId)
                           throws SystemException

Specified by:

hasPermissionRoles in interface RoleLocalService

Throws:

SystemException - if a system exception occurred

setPermissionRoles

public void setPermissionRoles(long permissionId,
                               long[] roleIds)
                        throws SystemException

Specified by:

setPermissionRoles 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,
                         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,
                            List<Role> Roles)
                     throws SystemException

Specified by:

deleteUserRoles in interface RoleLocalService

Throws:

SystemException - if a system exception occurred

getUserRoles

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

Specified by:

getUserRoles in interface RoleLocalService

Throws:

SystemException - if a system exception occurred

getUserRoles

public 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 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 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(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,
                    String name,
                    Map<Locale,String> titleMap,
                    Map<Locale,String> descriptionMap,
                    int type)
             throws PortalException,
                    SystemException

Deprecated. addRole(long, String, long, String, Map, Map, int, String)

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,
                    String name,
                    Map<Locale,String> titleMap,
                    Map<Locale,String> descriptionMap,
                    int type,
                    String className,
                    long classPK)
             throws PortalException,
                    SystemException

Deprecated. addRole(long, String, long, String, Map, Map, int, String)

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,
                    String className,
                    long classPK,
                    String name,
                    Map<Locale,String> titleMap,
                    Map<Locale,String> descriptionMap,
                    int type,
                    String subType)
             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)

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

getResourceBlockRoles

public List<Role> getResourceBlockRoles(long resourceBlockId,
                                        String className,
                                        String actionId)
                                 throws SystemException

Specified by:

getResourceBlockRoles in interface RoleLocalService

Throws:

SystemException

getResourceRoles

public Map<String,List<String>> getResourceRoles(long companyId,
                                                 String name,
                                                 int scope,
                                                 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 List<Role> getResourceRoles(long companyId,
                                   String name,
                                   int scope,
                                   String primKey,
                                   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,
                    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 List<Role> getRoles(int type,
                           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 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 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 List<Role> getSubtypeRoles(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(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

getUserGroupGroupRoles

public 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 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 List<Role> getUserRelatedRoles(long userId,
                                      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 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 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,
                           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 role with the name could not be found in the company or 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,
                            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,
                          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,
                        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 List<Role> search(long companyId,
                         String keywords,
                         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 List<Role> search(long companyId,
                         String keywords,
                         Integer[] types,
                         LinkedHashMap<String,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 "permissionsResourceId" and "usersRoles" keys. 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 List<Role> search(long companyId,
                         String name,
                         String description,
                         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 List<Role> search(long companyId,
                         String name,
                         String description,
                         Integer[] types,
                         LinkedHashMap<String,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 "permissionsResourceId" and "usersRoles" keys. 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,
                       String keywords,
                       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,
                       String keywords,
                       Integer[] types,
                       LinkedHashMap<String,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,
                       String name,
                       String description,
                       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,
                       String name,
                       String description,
                       Integer[] types,
                       LinkedHashMap<String,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 "permissionsResourceId" and "usersRoles" keys. 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,
                       String name,
                       Map<Locale,String> titleMap,
                       Map<Locale,String> descriptionMap,
                       String subtype)
                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)

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. Renamed to getWrappedService()

setWrappedRoleLocalService

public void setWrappedRoleLocalService(RoleLocalService roleLocalService)

Deprecated. Renamed to 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>