public class RoleServiceUtil
extends Object
com.liferay.portal.service.impl.RoleServiceImpl and is an
access point for service operations in application layer code running on a
remote server. Methods of this service are expected to have security checks
based on the propagated JAAS credentials because this service can be
accessed remotely.RoleService| Constructor and Description |
|---|
RoleServiceUtil() |
| Modifier and Type | Method and Description |
|---|---|
static Role |
addRole(String externalReferenceCode,
String className,
long classPK,
String name,
Map<Locale,String> titleMap,
Map<Locale,String> descriptionMap,
int type,
String subtype,
ServiceContext serviceContext) |
static void |
addUserRoles(long userId,
long[] roleIds)
Adds the roles to the user.
|
static void |
deleteRole(long roleId)
Deletes the role with the primary key and its associated permissions.
|
static Role |
fetchRole(long roleId) |
static Role |
fetchRole(long companyId,
String name) |
static Role |
fetchRoleByExternalReferenceCode(String externalReferenceCode,
long companyId) |
static List<Role> |
getGroupRoles(long groupId)
Returns all the roles associated with the group.
|
static List<Role> |
getGroupRolesAndTeamRoles(long companyId,
String name,
List<String> excludedNames,
String title,
String description,
int[] types,
long excludedTeamRoleId,
long teamGroupId,
int start,
int end) |
static int |
getGroupRolesAndTeamRolesCount(long companyId,
String name,
List<String> excludedNames,
String title,
String description,
int[] types,
long excludedTeamRoleId,
long teamGroupId) |
static String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
static Role |
getRole(long roleId)
Returns the role with the primary key.
|
static Role |
getRole(long companyId,
String name)
Returns the role with the name in the company.
|
static Role |
getRoleByExternalReferenceCode(String externalReferenceCode,
long companyId) |
static List<Role> |
getRoles(int type,
String subtype) |
static List<Role> |
getRoles(long companyId,
int[] types) |
static RoleService |
getService() |
static List<Role> |
getUserGroupGroupRoles(long userId,
long groupId)
Returns all the user's roles within the user group.
|
static List<Role> |
getUserGroupRoles(long userId,
long groupId)
Returns all the user's roles within the user group.
|
static List<Role> |
getUserRelatedRoles(long userId,
List<Group> groups)
Returns the union of all the user's roles within the groups.
|
static List<Role> |
getUserRoles(long userId)
Returns all the roles associated with the user.
|
static boolean |
hasUserRole(long userId,
long companyId,
String name,
boolean inherited)
Returns
true if the user is associated with the named
regular role. |
static boolean |
hasUserRoles(long userId,
long companyId,
String[] names,
boolean inherited)
Returns
true if the user has any one of the named regular
roles. |
static List<Role> |
search(long companyId,
String keywords,
Integer[] types,
LinkedHashMap<String,Object> params,
int start,
int end,
OrderByComparator<Role> orderByComparator) |
static int |
searchCount(long companyId,
String keywords,
Integer[] types,
LinkedHashMap<String,Object> params) |
static void |
setService(RoleService service) |
static void |
unsetUserRoles(long userId,
long[] roleIds)
Removes the matching roles associated with the user.
|
static Role |
updateExternalReferenceCode(long roleId,
String externalReferenceCode) |
static Role |
updateExternalReferenceCode(Role role,
String externalReferenceCode) |
static 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.
|
public static Role addRole(String externalReferenceCode, String className, long classPK, String name, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, int type, String subtype, ServiceContext serviceContext) throws PortalException
PortalExceptionpublic static void addUserRoles(long userId,
long[] roleIds)
throws PortalException
userId - the primary key of the userroleIds - the primary keys of the rolesPortalExceptionpublic static void deleteRole(long roleId)
throws PortalException
roleId - the primary key of the rolePortalExceptionpublic static Role fetchRole(long roleId) throws PortalException
PortalExceptionpublic static Role fetchRole(long companyId, String name) throws PortalException
PortalExceptionpublic static Role fetchRoleByExternalReferenceCode(String externalReferenceCode, long companyId) throws PortalException
PortalExceptionpublic static List<Role> getGroupRoles(long groupId) throws PortalException
groupId - the primary key of the groupPortalExceptionpublic static List<Role> getGroupRolesAndTeamRoles(long companyId, String name, List<String> excludedNames, String title, String description, int[] types, long excludedTeamRoleId, long teamGroupId, int start, int end)
public static int getGroupRolesAndTeamRolesCount(long companyId,
String name,
List<String> excludedNames,
String title,
String description,
int[] types,
long excludedTeamRoleId,
long teamGroupId)
public static String getOSGiServiceIdentifier()
public static Role getRole(long roleId) throws PortalException
roleId - the primary key of the rolePortalExceptionpublic static Role getRole(long companyId, String name) throws 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 namePortalExceptionpublic static Role getRoleByExternalReferenceCode(String externalReferenceCode, long companyId) throws PortalException
PortalExceptionpublic static List<Role> getRoles(int type, String subtype) throws PortalException
PortalExceptionpublic static List<Role> getRoles(long companyId, int[] types) throws PortalException
PortalExceptionpublic static List<Role> getUserGroupGroupRoles(long userId, long groupId) throws PortalException
userId - the primary key of the usergroupId - the primary key of the groupPortalExceptionpublic static List<Role> getUserGroupRoles(long userId, long groupId) throws PortalException
userId - the primary key of the usergroupId - the primary key of the groupPortalExceptionpublic static List<Role> getUserRelatedRoles(long userId, List<Group> groups) throws PortalException
userId - the primary key of the usergroups - the groups (optionally null)PortalExceptionpublic static List<Role> getUserRoles(long userId) throws PortalException
userId - the primary key of the userPortalExceptionpublic static boolean hasUserRole(long userId,
long companyId,
String name,
boolean inherited)
throws 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 otherwisePortalExceptionpublic static boolean hasUserRoles(long userId,
long companyId,
String[] names,
boolean inherited)
throws 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 otherwisePortalExceptionpublic static List<Role> search(long companyId, String keywords, Integer[] types, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator<Role> orderByComparator)
public static int searchCount(long companyId,
String keywords,
Integer[] types,
LinkedHashMap<String,Object> params)
public static void unsetUserRoles(long userId,
long[] roleIds)
throws PortalException
userId - the primary key of the userroleIds - the primary keys of the rolesPortalExceptionpublic static Role updateExternalReferenceCode(long roleId, String externalReferenceCode) throws PortalException
PortalExceptionpublic static Role updateExternalReferenceCode(Role role, String externalReferenceCode) throws PortalException
PortalExceptionpublic static Role updateRole(long roleId, String name, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String subtype, ServiceContext serviceContext) throws 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.PortalExceptionpublic static RoleService getService()
public static void setService(RoleService service)