@ProviderType
public class RoleLocalServiceUtil
extends java.lang.Object
com.liferay.portal.service.impl.RoleLocalServiceImpl and is the
primary access point for service operations in application layer code running
on the local server. Methods of this service will not have security checks
based on the propagated JAAS credentials because this service can only be
accessed from within the same VM.RoleLocalService,
RoleLocalServiceBaseImpl,
com.liferay.portal.service.impl.RoleLocalServiceImpl| Constructor and Description |
|---|
RoleLocalServiceUtil() |
| Modifier and Type | Method and Description |
|---|---|
static void |
addGroupRole(long groupId,
long roleId) |
static void |
addGroupRole(long groupId,
Role role) |
static void |
addGroupRoles(long groupId,
java.util.List<Role> Roles) |
static void |
addGroupRoles(long groupId,
long[] roleIds) |
static Role |
addRole(long userId,
long companyId,
java.lang.String name,
java.util.Map<java.util.Locale,java.lang.String> titleMap,
java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
int type)
Deprecated.
As of 6.2.0, replaced by
addRole(long, String, long,
String, Map, Map, int, String, ServiceContext) |
static Role |
addRole(long userId,
long companyId,
java.lang.String name,
java.util.Map<java.util.Locale,java.lang.String> titleMap,
java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
int type,
java.lang.String className,
long classPK)
Deprecated.
As of 6.2.0, replaced by
addRole(long, String, long,
String, Map, Map, int, String, ServiceContext) |
static Role |
addRole(long userId,
java.lang.String className,
long classPK,
java.lang.String name,
java.util.Map<java.util.Locale,java.lang.String> titleMap,
java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
int type,
java.lang.String subtype,
ServiceContext serviceContext)
Adds a role with additional parameters.
|
static Role |
addRole(Role role)
Adds the role to the database.
|
static void |
addUserRole(long userId,
long roleId) |
static void |
addUserRole(long userId,
Role role) |
static void |
addUserRoles(long userId,
java.util.List<Role> Roles) |
static void |
addUserRoles(long userId,
long[] roleIds) |
static void |
checkSystemRoles()
Checks to ensure that the system roles map has appropriate default roles
in each company.
|
static void |
checkSystemRoles(long companyId)
Checks to ensure that the system roles map has appropriate default roles
in the company.
|
static void |
clearGroupRoles(long groupId) |
static void |
clearUserRoles(long userId) |
static Role |
createRole(long roleId)
Creates a new role with the primary key.
|
static void |
deleteGroupRole(long groupId,
long roleId) |
static void |
deleteGroupRole(long groupId,
Role role) |
static void |
deleteGroupRoles(long groupId,
java.util.List<Role> Roles) |
static void |
deleteGroupRoles(long groupId,
long[] roleIds) |
static Role |
deleteRole(long roleId)
Deletes the role with the primary key from the database.
|
static Role |
deleteRole(Role role)
Deletes the role from the database.
|
static void |
deleteUserRole(long userId,
long roleId) |
static void |
deleteUserRole(long userId,
Role role) |
static void |
deleteUserRoles(long userId,
java.util.List<Role> Roles) |
static void |
deleteUserRoles(long userId,
long[] roleIds) |
static DynamicQuery |
dynamicQuery() |
static java.util.List |
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.
|
static java.util.List |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows.
|
static java.util.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.
|
static long |
dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows that match the dynamic query.
|
static long |
dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
Returns the number of rows that match the dynamic query.
|
static Role |
fetchRole(long roleId) |
static Role |
fetchRole(long companyId,
java.lang.String name)
Returns the role with the name in the company.
|
static Role |
fetchRoleByUuidAndCompanyId(java.lang.String uuid,
long companyId)
Returns the role with the matching UUID and company.
|
static java.lang.String |
getBeanIdentifier()
Returns the Spring bean ID for this bean.
|
static Role |
getDefaultGroupRole(long groupId)
Returns the default role for the group with the primary key.
|
static java.util.List<Role> |
getGroupRelatedRoles(long groupId) |
static java.util.List<Role> |
getGroupRoles(long groupId) |
static java.util.List<Role> |
getGroupRoles(long groupId,
int start,
int end) |
static java.util.List<Role> |
getGroupRoles(long groupId,
int start,
int end,
OrderByComparator orderByComparator) |
static int |
getGroupRolesCount(long groupId) |
static PersistedModel |
getPersistedModel(java.io.Serializable primaryKeyObj) |
static java.util.List<Role> |
getResourceBlockRoles(long resourceBlockId,
java.lang.String className,
java.lang.String actionId) |
static java.util.Map<java.lang.String,java.util.List<java.lang.String>> |
getResourceRoles(long companyId,
java.lang.String name,
int scope,
java.lang.String primKey)
Returns a map of role names to associated action IDs for the named
resource in the company within the permission scope.
|
static java.util.List<Role> |
getResourceRoles(long companyId,
java.lang.String name,
int scope,
java.lang.String primKey,
java.lang.String actionId)
Returns all the roles associated with the action ID in the company within
the permission scope.
|
static Role |
getRole(long roleId)
Returns the role with the primary key.
|
static Role |
getRole(long companyId,
java.lang.String name)
Returns the role with the name in the company.
|
static Role |
getRoleByUuidAndCompanyId(java.lang.String uuid,
long companyId)
Returns the role with the matching UUID and company.
|
static java.util.List<Role> |
getRoles(int start,
int end)
Returns a range of all the roles.
|
static java.util.List<Role> |
getRoles(int type,
java.lang.String subtype)
Returns all the roles of the type and subtype.
|
static java.util.List<Role> |
getRoles(long companyId)
Returns all the roles in the company.
|
static java.util.List<Role> |
getRoles(long[] roleIds)
Returns all the roles with the primary keys.
|
static java.util.List<Role> |
getRoles(long companyId,
int[] types)
Returns all the roles with the types.
|
static int |
getRolesCount()
Returns the number of roles.
|
static RoleLocalService |
getService() |
static java.util.List<Role> |
getSubtypeRoles(java.lang.String subtype)
Returns all the roles of the subtype.
|
static int |
getSubtypeRolesCount(java.lang.String subtype)
Returns the number of roles of the subtype.
|
static Role |
getTeamRole(long companyId,
long teamId)
Returns the team role in the company.
|
static java.util.Map<Team,Role> |
getTeamRoleMap(long groupId)
Returns the team role map for the group.
|
static java.util.List<Role> |
getTeamRoles(long groupId)
Returns the team roles in the group.
|
static java.util.List<Role> |
getTeamRoles(long groupId,
long[] excludedRoleIds)
Returns the team roles in the group, excluding the specified role IDs.
|
static java.util.List<Role> |
getTypeRoles(int type)
Returns all the roles of the type.
|
static java.util.List<Role> |
getTypeRoles(int type,
int start,
int end)
Returns a range of all the roles of the type.
|
static int |
getTypeRolesCount(int type)
Returns the number of roles of the type.
|
static java.util.List<Role> |
getUserGroupGroupRoles(long userId,
long groupId)
Returns all the user's roles within the user group.
|
static java.util.List<Role> |
getUserGroupRoles(long userId,
long groupId)
Returns all the user's roles within the user group.
|
static java.util.List<Role> |
getUserRelatedRoles(long userId,
java.util.List<Group> groups)
Returns the union of all the user's roles within the groups.
|
static java.util.List<Role> |
getUserRelatedRoles(long userId,
long groupId)
Returns all the user's roles within the group.
|
static java.util.List<Role> |
getUserRelatedRoles(long userId,
long[] groupIds)
Returns the union of all the user's roles within the groups.
|
static java.util.List<Role> |
getUserRoles(long userId) |
static java.util.List<Role> |
getUserRoles(long userId,
int start,
int end) |
static java.util.List<Role> |
getUserRoles(long userId,
int start,
int end,
OrderByComparator orderByComparator) |
static int |
getUserRolesCount(long userId) |
static boolean |
hasGroupRole(long groupId,
long roleId) |
static boolean |
hasGroupRoles(long groupId) |
static boolean |
hasUserRole(long userId,
long roleId) |
static boolean |
hasUserRole(long userId,
long companyId,
java.lang.String name,
boolean inherited)
Returns
true if the user is associated with the named
regular role. |
static boolean |
hasUserRoles(long userId) |
static boolean |
hasUserRoles(long userId,
long companyId,
java.lang.String[] names,
boolean inherited)
Returns
true if the user has any one of the named regular
roles. |
static Role |
loadFetchRole(long companyId,
java.lang.String name)
Returns a role with the name in the company.
|
static Role |
loadGetRole(long companyId,
java.lang.String name)
Returns a role with the name in the company.
|
static java.util.List<Role> |
search(long companyId,
java.lang.String keywords,
java.lang.Integer[] types,
int start,
int end,
OrderByComparator obc)
Returns an ordered range of all the roles that match the keywords and
types.
|
static java.util.List<Role> |
search(long companyId,
java.lang.String keywords,
java.lang.Integer[] types,
java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
int start,
int end,
OrderByComparator obc)
Returns an ordered range of all the roles that match the keywords, types,
and params.
|
static java.util.List<Role> |
search(long companyId,
java.lang.String name,
java.lang.String description,
java.lang.Integer[] types,
int start,
int end,
OrderByComparator obc)
Returns an ordered range of all the roles that match the name,
description, and types.
|
static java.util.List<Role> |
search(long companyId,
java.lang.String name,
java.lang.String description,
java.lang.Integer[] types,
java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
int start,
int end,
OrderByComparator obc)
Returns an ordered range of all the roles that match the name,
description, types, and params.
|
static int |
searchCount(long companyId,
java.lang.String keywords,
java.lang.Integer[] types)
Returns the number of roles that match the keywords and types.
|
static int |
searchCount(long companyId,
java.lang.String keywords,
java.lang.Integer[] types,
java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)
Returns the number of roles that match the keywords, types and params.
|
static int |
searchCount(long companyId,
java.lang.String name,
java.lang.String description,
java.lang.Integer[] types)
Returns the number of roles that match the name, description, and types.
|
static int |
searchCount(long companyId,
java.lang.String name,
java.lang.String description,
java.lang.Integer[] types,
java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)
Returns the number of roles that match the name, description, types, and
params.
|
static void |
setBeanIdentifier(java.lang.String beanIdentifier)
Sets the Spring bean ID for this bean.
|
static void |
setGroupRoles(long groupId,
long[] roleIds) |
void |
setService(RoleLocalService service)
Deprecated.
As of 6.2.0
|
static void |
setUserRoles(long userId,
long[] roleIds) |
static void |
unsetUserRoles(long userId,
long[] roleIds)
Removes the matching roles associated with the user.
|
static Role |
updateRole(long roleId,
java.lang.String name,
java.util.Map<java.util.Locale,java.lang.String> titleMap,
java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
java.lang.String subtype,
ServiceContext serviceContext)
Updates the role with the primary key.
|
static Role |
updateRole(Role role)
Updates the role in the database or adds it if it does not yet exist.
|
public static Role addRole(Role role) throws SystemException
role - the roleSystemException - if a system exception occurredpublic static Role createRole(long roleId)
roleId - the primary key for the new rolepublic static Role deleteRole(long roleId) throws PortalException, SystemException
roleId - the primary key of the rolePortalException - if a role with the primary key could not be foundSystemException - if a system exception occurredpublic static Role deleteRole(Role role) throws PortalException, SystemException
role - the rolePortalExceptionSystemException - if a system exception occurredpublic static DynamicQuery dynamicQuery()
public static java.util.List dynamicQuery(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery - the dynamic querySystemException - if a system exception occurredpublic static java.util.List dynamicQuery(DynamicQuery dynamicQuery, int start, int end) throws SystemException
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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from RoleModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
dynamicQuery - the dynamic querystart - the lower bound of the range of model instancesend - the upper bound of the range of model instances (not inclusive)SystemException - if a system exception occurredpublic static java.util.List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) throws SystemException
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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from RoleModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
dynamicQuery - the dynamic querystart - the lower bound of the range of model instancesend - the upper bound of the range of model instances (not inclusive)orderByComparator - the comparator to order the results by (optionally null)SystemException - if a system exception occurredpublic static long dynamicQueryCount(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery - the dynamic querySystemException - if a system exception occurredpublic static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) throws SystemException
dynamicQuery - the dynamic queryprojection - the projection to apply to the querySystemException - if a system exception occurredpublic static Role fetchRole(long roleId) throws SystemException
SystemExceptionpublic static Role fetchRoleByUuidAndCompanyId(java.lang.String uuid, long companyId) throws SystemException
uuid - the role's UUIDcompanyId - the primary key of the companynull if a matching role could not be foundSystemException - if a system exception occurredpublic static Role getRole(long roleId) throws PortalException, SystemException
roleId - the primary key of the rolePortalException - if a role with the primary key could not be foundSystemException - if a system exception occurredpublic static PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj) throws PortalException, SystemException
PortalExceptionSystemExceptionpublic static Role getRoleByUuidAndCompanyId(java.lang.String uuid, long companyId) throws PortalException, SystemException
uuid - the role's UUIDcompanyId - the primary key of the companyPortalException - if a matching role could not be foundSystemException - if a system exception occurredpublic static java.util.List<Role> getRoles(int start, int end) throws SystemException
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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from RoleModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
start - the lower bound of the range of rolesend - the upper bound of the range of roles (not inclusive)SystemException - if a system exception occurredpublic static int getRolesCount()
throws SystemException
SystemException - if a system exception occurredpublic static Role updateRole(Role role) throws SystemException
role - the roleSystemException - if a system exception occurredpublic static void addGroupRole(long groupId,
long roleId)
throws SystemException
SystemException - if a system exception occurredpublic static void addGroupRole(long groupId,
Role role)
throws SystemException
SystemException - if a system exception occurredpublic static void addGroupRoles(long groupId,
long[] roleIds)
throws SystemException
SystemException - if a system exception occurredpublic static void addGroupRoles(long groupId,
java.util.List<Role> Roles)
throws SystemException
SystemException - if a system exception occurredpublic static void clearGroupRoles(long groupId)
throws SystemException
SystemException - if a system exception occurredpublic static void deleteGroupRole(long groupId,
long roleId)
throws SystemException
SystemException - if a system exception occurredpublic static void deleteGroupRole(long groupId,
Role role)
throws SystemException
SystemException - if a system exception occurredpublic static void deleteGroupRoles(long groupId,
long[] roleIds)
throws SystemException
SystemException - if a system exception occurredpublic static void deleteGroupRoles(long groupId,
java.util.List<Role> Roles)
throws SystemException
SystemException - if a system exception occurredpublic static java.util.List<Role> getGroupRoles(long groupId) throws SystemException
SystemException - if a system exception occurredpublic static java.util.List<Role> getGroupRoles(long groupId, int start, int end) throws SystemException
SystemException - if a system exception occurredpublic static java.util.List<Role> getGroupRoles(long groupId, int start, int end, OrderByComparator orderByComparator) throws SystemException
SystemException - if a system exception occurredpublic static int getGroupRolesCount(long groupId)
throws SystemException
SystemException - if a system exception occurredpublic static boolean hasGroupRole(long groupId,
long roleId)
throws SystemException
SystemException - if a system exception occurredpublic static boolean hasGroupRoles(long groupId)
throws SystemException
SystemException - if a system exception occurredpublic static void setGroupRoles(long groupId,
long[] roleIds)
throws SystemException
SystemException - if a system exception occurredpublic static void addUserRole(long userId,
long roleId)
throws SystemException
SystemException - if a system exception occurredpublic static void addUserRole(long userId,
Role role)
throws SystemException
SystemException - if a system exception occurredpublic static void addUserRoles(long userId,
long[] roleIds)
throws PortalException,
SystemException
PortalExceptionSystemException - if a system exception occurredpublic static void addUserRoles(long userId,
java.util.List<Role> Roles)
throws PortalException,
SystemException
PortalExceptionSystemException - if a system exception occurredpublic static void clearUserRoles(long userId)
throws SystemException
SystemException - if a system exception occurredpublic static void deleteUserRole(long userId,
long roleId)
throws SystemException
SystemException - if a system exception occurredpublic static void deleteUserRole(long userId,
Role role)
throws SystemException
SystemException - if a system exception occurredpublic static void deleteUserRoles(long userId,
long[] roleIds)
throws SystemException
SystemException - if a system exception occurredpublic static void deleteUserRoles(long userId,
java.util.List<Role> Roles)
throws SystemException
SystemException - if a system exception occurredpublic static java.util.List<Role> getUserRoles(long userId) throws SystemException
SystemException - if a system exception occurredpublic static java.util.List<Role> getUserRoles(long userId, int start, int end) throws SystemException
SystemException - if a system exception occurredpublic static java.util.List<Role> getUserRoles(long userId, int start, int end, OrderByComparator orderByComparator) throws SystemException
SystemException - if a system exception occurredpublic static int getUserRolesCount(long userId)
throws SystemException
SystemException - if a system exception occurredpublic static boolean hasUserRole(long userId,
long roleId)
throws SystemException
SystemException - if a system exception occurredpublic static boolean hasUserRoles(long userId)
throws SystemException
SystemException - if a system exception occurredpublic static void setUserRoles(long userId,
long[] roleIds)
throws PortalException,
SystemException
PortalExceptionSystemException - if a system exception occurredpublic static java.lang.String getBeanIdentifier()
public static void setBeanIdentifier(java.lang.String beanIdentifier)
beanIdentifier - the Spring bean ID for this beanpublic static Role addRole(long userId, long companyId, java.lang.String name, java.util.Map<java.util.Locale,java.lang.String> titleMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, int type) throws PortalException, SystemException
addRole(long, String, long,
String, Map, Map, int, String, ServiceContext)userId - the primary key of the usercompanyId - the primary key of the companyname - 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)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 foundSystemException - if a system exception occurredpublic static Role addRole(long userId, long companyId, java.lang.String name, java.util.Map<java.util.Locale,java.lang.String> titleMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, int type, java.lang.String className, long classPK) throws PortalException, SystemException
addRole(long, String, long,
String, Map, Map, int, String, ServiceContext)userId - the primary key of the usercompanyId - the primary key of the companyname - 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)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)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 foundSystemException - if a system exception occurredpublic static Role addRole(long userId, java.lang.String className, long classPK, java.lang.String name, java.util.Map<java.util.Locale,java.lang.String> titleMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, int type, java.lang.String subtype, ServiceContext serviceContext) throws PortalException, SystemException
userId - the primary key of the userclassName - 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 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 expando bridge attributes for the
role.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 foundSystemException - if a system exception occurredpublic static void checkSystemRoles()
throws PortalException,
SystemException
PortalException - if the current user did not have permission to
set applicable permissions on a roleSystemException - if a system exception occurredpublic static void checkSystemRoles(long companyId)
throws PortalException,
SystemException
companyId - the primary key of the companyPortalException - if the current user did not have permission to
set applicable permissions on a roleSystemException - if a system exception occurredpublic static Role fetchRole(long companyId, java.lang.String name) throws SystemException
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 namenull if a role
with the name could not be found in the companySystemException - if a system exception occurredpublic static Role getDefaultGroupRole(long groupId) throws PortalException, SystemException
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.
groupId - the primary key of the groupPortalException - if a group with the primary key could not be
found, or if a default role could not be found for the groupSystemException - if a system exception occurredpublic static java.util.List<Role> getGroupRelatedRoles(long groupId) throws PortalException, SystemException
PortalExceptionSystemExceptionpublic static java.util.List<Role> getResourceBlockRoles(long resourceBlockId, java.lang.String className, java.lang.String actionId) throws SystemException
SystemExceptionpublic static java.util.Map<java.lang.String,java.util.List<java.lang.String>> getResourceRoles(long companyId,
java.lang.String name,
int scope,
java.lang.String primKey)
throws SystemException
companyId - the primary key of the companyname - the resource namescope - the permission scopeprimKey - the primary key of the resource's classSystemException - if a system exception occurredRoleFinder.findByC_N_S_P(
long, String, int, String)public static java.util.List<Role> getResourceRoles(long companyId, java.lang.String name, int scope, java.lang.String primKey, java.lang.String actionId) throws SystemException
companyId - the primary key of the companyname - the resource namescope - the permission scopeprimKey - the primary key of the resource's classactionId - the name of the resource actionSystemException - if a system exception occurredRoleFinder.findByC_N_S_P_A(
long, String, int, String, String)public static Role getRole(long companyId, java.lang.String name) throws PortalException, SystemException
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 namePortalException - if a role with the name could not be found in the
companySystemException - if a system exception occurredpublic static java.util.List<Role> getRoles(int type, java.lang.String subtype) throws SystemException
type - the role's type (optionally 0)subtype - the role's subtype (optionally null)SystemException - if a system exception occurredpublic static java.util.List<Role> getRoles(long companyId) throws SystemException
companyId - the primary key of the companySystemException - if a system exception occurredpublic static java.util.List<Role> getRoles(long companyId, int[] types) throws SystemException
companyId - the primary key of the companytypes - the role types (optionally null)SystemException - if a system exception occurredpublic static java.util.List<Role> getRoles(long[] roleIds) throws PortalException, SystemException
roleIds - the primary keys of the rolesPortalException - if any one of the roles with the primary keys
could not be foundSystemException - if a system exception occurredpublic static java.util.List<Role> getSubtypeRoles(java.lang.String subtype) throws SystemException
subtype - the role's subtype (optionally null)SystemException - if a system exception occurredpublic static int getSubtypeRolesCount(java.lang.String subtype)
throws SystemException
subtype - the role's subtype (optionally null)SystemException - if a system exception occurredpublic static Role getTeamRole(long companyId, long teamId) throws PortalException, SystemException
companyId - the primary key of the companyteamId - the primary key of the teamPortalException - if a role could not be found in the team and
companySystemException - if a system exception occurredpublic static java.util.Map<Team,Role> getTeamRoleMap(long groupId) throws PortalException, SystemException
groupId - the primary key of the groupPortalException - if a group with the primary key could not be
found, if a role could not be found in one of the group's teams,
or if a portal exception occurredSystemException - if a system exception occurredpublic static java.util.List<Role> getTeamRoles(long groupId) throws PortalException, SystemException
groupId - the primary key of the groupPortalException - if a group with the primary key could not be
found, if a role could not be found in one of the group's teams,
or if a portal exception occurredSystemException - if a system exception occurredpublic static java.util.List<Role> getTeamRoles(long groupId, long[] excludedRoleIds) throws PortalException, SystemException
groupId - the primary key of the groupexcludedRoleIds - the primary keys of the roles to exclude
(optionally null)PortalException - if a group with the primary key could not be
found, if a role could not be found in one of the group's teams,
or if a portal exception occurredSystemException - if a system exception occurredpublic static java.util.List<Role> getTypeRoles(int type) throws SystemException
type - the role's type (optionally 0)SystemException - if a system exception occurredpublic static java.util.List<Role> getTypeRoles(int type, int start, int end) throws SystemException
type - the role's type (optionally 0)start - the lower bound of the range of roles to returnend - the upper bound of the range of roles to return (not
inclusive)SystemException - if a system exception occurredpublic static int getTypeRolesCount(int type)
throws SystemException
type - the role's type (optionally 0)SystemException - if a system exception occurredpublic static java.util.List<Role> getUserGroupGroupRoles(long userId, long groupId) throws SystemException
userId - the primary key of the usergroupId - the primary key of the groupSystemException - if a system exception occurredRoleFinder.findByUserGroupGroupRole(
long, long)public static java.util.List<Role> getUserGroupRoles(long userId, long groupId) throws SystemException
userId - the primary key of the usergroupId - the primary key of the groupSystemException - if a system exception occurredRoleFinder.findByUserGroupRole(
long, long)public static java.util.List<Role> getUserRelatedRoles(long userId, java.util.List<Group> groups) throws SystemException
userId - the primary key of the usergroups - the groups (optionally null)SystemException - if a system exception occurredRoleFinder.findByU_G(
long, List)public static java.util.List<Role> getUserRelatedRoles(long userId, long groupId) throws SystemException
userId - the primary key of the usergroupId - the primary key of the groupSystemException - if a system exception occurredRoleFinder.findByU_G(
long, long)public static java.util.List<Role> getUserRelatedRoles(long userId, long[] groupIds) throws SystemException
userId - the primary key of the usergroupIds - the primary keys of the groupsSystemException - if a system exception occurredRoleFinder.findByU_G(
long, long[])public static boolean hasUserRole(long userId,
long companyId,
java.lang.String name,
boolean inherited)
throws PortalException,
SystemException
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 otherwisePortalException - if a default user for the company could not be
foundSystemException - if a system exception occurredpublic static boolean hasUserRoles(long userId,
long companyId,
java.lang.String[] names,
boolean inherited)
throws PortalException,
SystemException
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 otherwisePortalException - 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 foundSystemException - if a system exception occurredpublic static Role loadFetchRole(long companyId, java.lang.String name) throws SystemException
companyId - the primary key of the companyname - the role's name (optionally null)null if a role with the
name could not be found in the companySystemException - if a system exception occurredpublic static Role loadGetRole(long companyId, java.lang.String name) throws PortalException, SystemException
companyId - the primary key of the companyname - the role's namePortalException - if a role with the name could not be found in the
companySystemException - if a system exception occurredpublic static java.util.List<Role> search(long companyId, java.lang.String keywords, java.lang.Integer[] types, int start, int end, OrderByComparator obc) throws SystemException
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.
companyId - the primary key of the companykeywords - 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 returnend - the upper bound of the range of roles to return (not
inclusive)obc - the comparator to order the roles (optionally
null)obcSystemException - if a system exception occurredRoleFinderpublic static java.util.List<Role> search(long companyId, java.lang.String keywords, java.lang.Integer[] types, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end, OrderByComparator obc) throws SystemException
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.
companyId - the primary key of the companykeywords - 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 the
"usersRoles" key. For more information, see RoleFinderstart - the lower bound of the range of roles to returnend - the upper bound of the range of roles to return (not
inclusive)obc - the comparator to order the roles (optionally
null)obcSystemException - if a system exception occurredRoleFinderpublic static java.util.List<Role> search(long companyId, java.lang.String name, java.lang.String description, java.lang.Integer[] types, int start, int end, OrderByComparator obc) throws SystemException
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.
companyId - the primary key of the companyname - 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 returnend - the upper bound of the range of the roles to return (not
inclusive)obc - the comparator to order the roles (optionally
null)obcSystemException - if a system exception occurredRoleFinderpublic static java.util.List<Role> search(long companyId, java.lang.String name, java.lang.String description, java.lang.Integer[] types, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end, OrderByComparator obc) throws SystemException
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.
companyId - the primary key of the companyname - 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 the
"usersRoles" key. For more information, see RoleFinderstart - the lower bound of the range of the roles to returnend - the upper bound of the range of the roles to return (not
inclusive)obc - the comparator to order the roles (optionally
null)obcSystemException - if a system exception occurredRoleFinderpublic static int searchCount(long companyId,
java.lang.String keywords,
java.lang.Integer[] types)
throws SystemException
companyId - the primary key of the companykeywords - the keywords (space separated), which may occur in the
role's name or description (optionally null)types - the role types (optionally null)SystemException - if a system exception occurredpublic static int searchCount(long companyId,
java.lang.String keywords,
java.lang.Integer[] types,
java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)
throws SystemException
companyId - the primary key of the companykeywords - 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 RoleFinderSystemException - if a system exception occurredpublic static int searchCount(long companyId,
java.lang.String name,
java.lang.String description,
java.lang.Integer[] types)
throws SystemException
companyId - the primary key of the companyname - the role's name (optionally null)description - the role's description (optionally null)types - the role types (optionally null)SystemException - if a system exception occurredpublic static int searchCount(long companyId,
java.lang.String name,
java.lang.String description,
java.lang.Integer[] types,
java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)
throws SystemException
companyId - the primary key of the companyname - 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 the
"usersRoles" key. For more information, see RoleFinderSystemException - if a system exception occurredpublic static void unsetUserRoles(long userId,
long[] roleIds)
throws PortalException,
SystemException
userId - the primary key of the userroleIds - the primary keys of the rolesPortalException - 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 foundSystemException - if a system exception occurredpublic static Role updateRole(long roleId, java.lang.String name, java.util.Map<java.util.Locale,java.lang.String> titleMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.lang.String subtype, ServiceContext serviceContext) throws PortalException, SystemException
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 expando bridge attributes for the
role.PortalException - if a role with the primary could not be found or
if the role's name was invalidSystemException - if a system exception occurredpublic static RoleLocalService getService()
public void setService(RoleLocalService service)