public class RoleServiceImpl extends RoleServiceBaseImpl
counterLocalService, groupPersistence, roleFinder, roleLocalService, rolePersistence, roleService, userPersistence
Constructor and Description |
---|
RoleServiceImpl() |
Modifier and Type | Method and Description |
---|---|
com.liferay.portal.kernel.model.Role |
addRole(String className,
long classPK,
String name,
Map<Locale,String> titleMap,
Map<Locale,String> descriptionMap,
int type,
String subtype,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Adds a role.
|
void |
addUserRoles(long userId,
long[] roleIds)
Adds the roles to the user.
|
protected void |
checkUserRolesPermission(long userId,
long[] roleIds) |
void |
deleteRole(long roleId)
Deletes the role with the primary key and its associated permissions.
|
com.liferay.portal.kernel.model.Role |
fetchRole(long roleId) |
protected List<com.liferay.portal.kernel.model.Role> |
filterRoles(List<com.liferay.portal.kernel.model.Role> roles) |
List<com.liferay.portal.kernel.model.Role> |
getGroupRoles(long groupId)
Returns all the roles associated with the group.
|
List<com.liferay.portal.kernel.model.Role> |
getGroupRolesAndTeamRoles(long companyId,
String name,
List<String> excludedNames,
String title,
String description,
int[] types,
long excludedTeamRoleId,
long teamGroupId,
int start,
int end) |
int |
getGroupRolesAndTeamRolesCount(long companyId,
String name,
List<String> excludedNames,
String title,
String description,
int[] types,
long excludedTeamRoleId,
long teamGroupId) |
com.liferay.portal.kernel.model.Role |
getRole(long roleId)
Returns the role with the primary key.
|
com.liferay.portal.kernel.model.Role |
getRole(long companyId,
String name)
Returns the role with the name in the company.
|
List<com.liferay.portal.kernel.model.Role> |
getRoles(int type,
String subtype) |
List<com.liferay.portal.kernel.model.Role> |
getRoles(long companyId,
int[] types) |
List<com.liferay.portal.kernel.model.Role> |
getUserGroupGroupRoles(long userId,
long groupId)
Returns all the user's roles within the user group.
|
List<com.liferay.portal.kernel.model.Role> |
getUserGroupRoles(long userId,
long groupId)
Returns all the user's roles within the user group.
|
List<com.liferay.portal.kernel.model.Role> |
getUserRelatedRoles(long userId,
List<com.liferay.portal.kernel.model.Group> groups)
Returns the union of all the user's roles within the groups.
|
List<com.liferay.portal.kernel.model.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<com.liferay.portal.kernel.model.Role> |
search(long companyId,
String keywords,
Integer[] types,
LinkedHashMap<String,Object> params,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.Role> orderByComparator) |
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.
|
com.liferay.portal.kernel.model.Role |
updateRole(long roleId,
String name,
Map<Locale,String> titleMap,
Map<Locale,String> descriptionMap,
String subtype,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Updates the role with the primary key.
|
afterPropertiesSet, destroy, getCounterLocalService, getModelClass, getModelClassName, getOSGiServiceIdentifier, getRoleFinder, getRoleLocalService, getRolePersistence, getRoleService, runSQL, setCounterLocalService, setRoleFinder, setRoleLocalService, setRolePersistence, setRoleService
public com.liferay.portal.kernel.model.Role addRole(String className, long classPK, String name, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, int type, String subtype, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
className
- the name of the class for which the role is createdclassPK
- the primary key of the class for which the role is
created (optionally 0
)name
- the role's nametitleMap
- 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.com.liferay.portal.kernel.exception.PortalException
public void addUserRoles(long userId, long[] roleIds) throws com.liferay.portal.kernel.exception.PortalException
userId
- the primary key of the userroleIds
- the primary keys of the rolescom.liferay.portal.kernel.exception.PortalException
public void deleteRole(long roleId) throws com.liferay.portal.kernel.exception.PortalException
roleId
- the primary key of the rolecom.liferay.portal.kernel.exception.PortalException
public com.liferay.portal.kernel.model.Role fetchRole(long roleId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public List<com.liferay.portal.kernel.model.Role> getGroupRoles(long groupId) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the groupcom.liferay.portal.kernel.exception.PortalException
public List<com.liferay.portal.kernel.model.Role> getGroupRolesAndTeamRoles(long companyId, String name, List<String> excludedNames, String title, String description, int[] types, long excludedTeamRoleId, long teamGroupId, int start, int end)
public int getGroupRolesAndTeamRolesCount(long companyId, String name, List<String> excludedNames, String title, String description, int[] types, long excludedTeamRoleId, long teamGroupId)
public com.liferay.portal.kernel.model.Role getRole(long roleId) throws com.liferay.portal.kernel.exception.PortalException
roleId
- the primary key of the rolecom.liferay.portal.kernel.exception.PortalException
public com.liferay.portal.kernel.model.Role getRole(long companyId, String name) throws com.liferay.portal.kernel.exception.PortalException
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.
companyId
- the primary key of the companyname
- the role's namecom.liferay.portal.kernel.exception.PortalException
public List<com.liferay.portal.kernel.model.Role> getRoles(int type, String subtype) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public List<com.liferay.portal.kernel.model.Role> getRoles(long companyId, int[] types) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public List<com.liferay.portal.kernel.model.Role> getUserGroupGroupRoles(long userId, long groupId) throws com.liferay.portal.kernel.exception.PortalException
userId
- the primary key of the usergroupId
- the primary key of the groupcom.liferay.portal.kernel.exception.PortalException
public List<com.liferay.portal.kernel.model.Role> getUserGroupRoles(long userId, long groupId) throws com.liferay.portal.kernel.exception.PortalException
userId
- the primary key of the usergroupId
- the primary key of the groupcom.liferay.portal.kernel.exception.PortalException
public List<com.liferay.portal.kernel.model.Role> getUserRelatedRoles(long userId, List<com.liferay.portal.kernel.model.Group> groups) throws com.liferay.portal.kernel.exception.PortalException
userId
- the primary key of the usergroups
- the groups (optionally null
)com.liferay.portal.kernel.exception.PortalException
public List<com.liferay.portal.kernel.model.Role> getUserRoles(long userId) throws com.liferay.portal.kernel.exception.PortalException
userId
- the primary key of the usercom.liferay.portal.kernel.exception.PortalException
public boolean hasUserRole(long userId, long companyId, String name, boolean inherited) throws com.liferay.portal.kernel.exception.PortalException
true
if the user is associated with the named
regular role.userId
- the primary key of the usercompanyId
- the primary key of the companyname
- the name of the roleinherited
- whether to include the user's inherited roles in the
searchtrue
if the user is associated with the regular
role; false
otherwisecom.liferay.portal.kernel.exception.PortalException
public boolean hasUserRoles(long userId, long companyId, String[] names, boolean inherited) throws com.liferay.portal.kernel.exception.PortalException
true
if the user has any one of the named regular
roles.userId
- the primary key of the usercompanyId
- the primary key of the companynames
- the names of the rolesinherited
- whether to include the user's inherited roles in the
searchtrue
if the user has any one of the regular roles;
false
otherwisecom.liferay.portal.kernel.exception.PortalException
public List<com.liferay.portal.kernel.model.Role> search(long companyId, String keywords, Integer[] types, LinkedHashMap<String,Object> params, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.Role> orderByComparator)
public int searchCount(long companyId, String keywords, Integer[] types, LinkedHashMap<String,Object> params)
public void unsetUserRoles(long userId, long[] roleIds) throws com.liferay.portal.kernel.exception.PortalException
userId
- the primary key of the userroleIds
- the primary keys of the rolescom.liferay.portal.kernel.exception.PortalException
public com.liferay.portal.kernel.model.Role updateRole(long roleId, String name, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String subtype, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
roleId
- the primary key of the rolename
- the role's new nametitleMap
- the new localized titles (optionally null
)
to replace those existing for the roledescriptionMap
- the new localized descriptions (optionally
null
) to replace those existing for the rolesubtype
- 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.com.liferay.portal.kernel.exception.PortalException
protected void checkUserRolesPermission(long userId, long[] roleIds) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
protected List<com.liferay.portal.kernel.model.Role> filterRoles(List<com.liferay.portal.kernel.model.Role> roles) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException