Class RoleLocalServiceUtil
com.liferay.portal.service.impl.RoleLocalServiceImpl
and
is an 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.- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic boolean
addGroupRole
(long groupId, long roleId) static boolean
addGroupRole
(long groupId, Role role) static boolean
addGroupRoles
(long groupId, long[] roleIds) static boolean
addGroupRoles
(long groupId, List<Role> roles) static Role
Adds the role to the database.static Role
addRole
(String externalReferenceCode, long userId, String className, long classPK, String name, Map<Locale, String> titleMap, Map<Locale, String> descriptionMap, int type, String subtype, ServiceContext serviceContext) static boolean
addUserRole
(long userId, long roleId) static boolean
addUserRole
(long userId, Role role) static boolean
addUserRoles
(long userId, long[] roleIds) static boolean
addUserRoles
(long userId, List<Role> roles) static void
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 PersistedModel
createPersistedModel
(Serializable primaryKeyObj) 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, long[] roleIds) static void
deleteGroupRoles
(long groupId, List<Role> roles) static PersistedModel
deletePersistedModel
(PersistedModel persistedModel) 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, long[] roleIds) static void
deleteUserRoles
(long userId, List<Role> roles) static <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static DynamicQuery
static <T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.static <T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.static <T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> 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 matching the dynamic query.static long
dynamicQueryCount
(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.static Role
fetchRole
(long roleId) static Role
Returns the role with the name in the company.static Role
fetchRoleByExternalReferenceCode
(String externalReferenceCode, long companyId) static Role
fetchRoleByUuidAndCompanyId
(String uuid, long companyId) Returns the role with the matching UUID and company.static ActionableDynamicQuery
static int
getAssigneesTotal
(long roleId) static Role
getDefaultGroupRole
(long groupId) Returns the default role for the group with the primary key.static ExportActionableDynamicQuery
getExportActionableDynamicQuery
(PortletDataContext portletDataContext) static long[]
getGroupPrimaryKeys
(long roleId) Returns the groupIds of the groups associated with the role.getGroupRelatedRoles
(long groupId) getGroupRoles
(long groupId) getGroupRoles
(long groupId, int start, int end) getGroupRoles
(long groupId, int start, int end, OrderByComparator<Role> orderByComparator) 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 int
getGroupRolesCount
(long groupId) static String
Returns the OSGi service identifier.static PersistedModel
getPersistedModel
(Serializable primaryKeyObj) 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.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.static Role
getRole
(long roleId) Returns the role with the primary key.static Role
Returns the role with the name in the company.static Role
getRoleByExternalReferenceCode
(String externalReferenceCode, long companyId) static Role
getRoleByUuidAndCompanyId
(String uuid, long companyId) Returns the role with the matching UUID and company.getRoles
(int start, int end) Returns a range of all the roles.Returns all the roles of the type and subtype.getRoles
(long companyId) Returns all the roles in the company.getRoles
(long[] roleIds) Returns all the roles with the primary keys.getRoles
(long companyId, int[] types) Returns all the roles with the types.getRoles
(long companyId, long classNameId, long[] classPKs, int type) static int
Returns the number of roles.static RoleLocalService
getSubtypeRoles
(String subtype) Returns all the roles of the subtype.static int
getSubtypeRolesCount
(String subtype) Returns the number of roles of the subtype.static Role
getTeamRole
(long companyId, long teamId) Returns the team role in the company.getTeamRoleMap
(long groupId) Returns the team role map for the group.getTeamRoles
(long groupId) Returns the team roles in the group.getTeamRoles
(long groupId, long[] excludedRoleIds) Returns the team roles in the group, excluding the specified role IDs.getTeamsRoles
(long companyId, long[] teamIds) Returns the team roles in the company.getTypeRoles
(int type) Returns all the roles of the type.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.getUserGroupGroupRoles
(long userId, long groupId) Returns all the user's roles within the user group.getUserGroupGroupRoles
(long userId, long groupId, int start, int end) static int
getUserGroupGroupRolesCount
(long userId, long groupId) getUserGroupRoles
(long userId, long groupId) Returns all the user's roles within the user group.static long[]
getUserPrimaryKeys
(long roleId) Returns the userIds of the users associated with the role.getUserRelatedRoles
(long userId, long groupId) Returns all the user's roles within the group.getUserRelatedRoles
(long userId, long[] groupIds) Returns the union of all the user's roles within the groups.getUserRelatedRoles
(long userId, List<Group> groups) Returns the union of all the user's roles within the groups.getUserRoles
(long userId) getUserRoles
(long userId, int start, int end) getUserRoles
(long userId, int start, int end, OrderByComparator<Role> orderByComparator) static int
getUserRolesCount
(long userId) getUserTeamRoles
(long userId, long groupId) 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, String name, boolean inherited) Returnstrue
if the user is associated with the named regular role.static boolean
hasUserRoles
(long userId) static boolean
hasUserRoles
(long userId, long companyId, String[] names, boolean inherited) Returnstrue
if the user has any one of the named regular roles.search
(long companyId, String keywords, Integer[] types, int start, int end, OrderByComparator<Role> orderByComparator) Returns an ordered range of all the roles that match the keywords and types.search
(long companyId, String keywords, Integer[] types, LinkedHashMap<String, Object> params, int start, int end, OrderByComparator<Role> orderByComparator) Returns an ordered range of all the roles that match the keywords, types, and params.search
(long companyId, String name, String description, Integer[] types, int start, int end, OrderByComparator<Role> orderByComparator) Returns an ordered range of all the roles that match the name, description, and types.search
(long companyId, String name, String description, Integer[] types, LinkedHashMap<String, Object> params, int start, int end, OrderByComparator<Role> orderByComparator) Returns an ordered range of all the roles that match the name, description, types, and params.static int
searchCount
(long companyId, String keywords, Integer[] types) Returns the number of roles that match the keywords and types.static int
searchCount
(long companyId, String keywords, Integer[] types, LinkedHashMap<String, Object> params) Returns the number of roles that match the keywords, types and params.static int
searchCount
(long companyId, String name, String description, Integer[] types) Returns the number of roles that match the name, description, and types.static 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.static void
setGroupRoles
(long groupId, long[] roleIds) static void
setService
(RoleLocalService service) static void
setUserRoles
(long userId, long[] roleIds) 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.static Role
updateRole
(Role role) Updates the role in the database or adds it if it does not yet exist.static void
validateName
(String name)
-
Constructor Details
-
RoleLocalServiceUtil
public RoleLocalServiceUtil()
-
-
Method Details
-
addGroupRole
public static boolean addGroupRole(long groupId, long roleId) -
addGroupRole
-
addGroupRoles
-
addGroupRoles
public static boolean addGroupRoles(long groupId, long[] roleIds) -
addRole
Adds the role to the database. Also notifies the appropriate model listeners.Important: Inspect RoleLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
role
- the role- Returns:
- the role that was added
-
addRole
public static Role addRole(String externalReferenceCode, long userId, String className, long classPK, String name, Map<Locale, String> titleMap, Map<Locale, throws PortalExceptionString> descriptionMap, int type, String subtype, ServiceContext serviceContext) - Throws:
PortalException
-
addUserRole
- Throws:
PortalException
-
addUserRole
- Throws:
PortalException
-
addUserRoles
- Throws:
PortalException
-
addUserRoles
- Throws:
PortalException
-
checkSystemRoles
Checks to ensure that the system roles map has appropriate default roles in each company.- Throws:
PortalException
-
checkSystemRoles
Checks to ensure that the system roles map has appropriate default roles in the company.- Parameters:
companyId
- the primary key of the company- Throws:
PortalException
-
clearGroupRoles
public static void clearGroupRoles(long groupId) -
clearUserRoles
- Throws:
PortalException
-
createPersistedModel
public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException - Throws:
PortalException
-
createRole
Creates a new role with the primary key. Does not add the role to the database.- Parameters:
roleId
- the primary key for the new role- Returns:
- the new role
-
deleteGroupRole
public static void deleteGroupRole(long groupId, long roleId) -
deleteGroupRole
-
deleteGroupRoles
-
deleteGroupRoles
public static void deleteGroupRoles(long groupId, long[] roleIds) -
deletePersistedModel
public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException - Throws:
PortalException
-
deleteRole
Deletes the role with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect RoleLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- 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
-
deleteRole
Deletes the role from the database. Also notifies the appropriate model listeners.Important: Inspect RoleLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
role
- the role- Returns:
- the role that was removed
- Throws:
PortalException
-
deleteUserRole
- Throws:
PortalException
-
deleteUserRole
- Throws:
PortalException
-
deleteUserRoles
- Throws:
PortalException
-
deleteUserRoles
- Throws:
PortalException
-
dslQuery
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dslQueryCount
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dynamicQuery
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.RoleModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)- Returns:
- the range of matching rows
-
dynamicQuery
public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.RoleModelImpl
.- Parameters:
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 (optionallynull
)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchRole
-
fetchRole
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.
- Parameters:
companyId
- the primary key of the companyname
- 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
-
fetchRoleByExternalReferenceCode
-
fetchRoleByUuidAndCompanyId
Returns the role with the matching UUID and company.- Parameters:
uuid
- the role's UUIDcompanyId
- the primary key of the company- Returns:
- the matching role, or
null
if a matching role could not be found
-
getActionableDynamicQuery
-
getAssigneesTotal
- Throws:
PortalException
-
getDefaultGroupRole
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 isRoleConstants#ORGANIZATION_USER
. If the group is a user or user group, then the default role isRoleConstants#POWER_USER
. For all other group types, the default role isRoleConstants#USER
.- Parameters:
groupId
- the primary key of the group- Returns:
- the default role for the group with the primary key
- Throws:
PortalException
-
getExportActionableDynamicQuery
public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext) -
getGroupPrimaryKeys
public static long[] getGroupPrimaryKeys(long roleId) Returns the groupIds of the groups associated with the role.- Parameters:
roleId
- the roleId of the role- Returns:
- long[] the groupIds of groups associated with the role
-
getGroupRelatedRoles
- Throws:
PortalException
-
getGroupRoles
-
getGroupRoles
-
getGroupRoles
public static List<Role> getGroupRoles(long groupId, int start, int end, OrderByComparator<Role> orderByComparator) -
getGroupRolesAndTeamRoles
-
getGroupRolesAndTeamRolesCount
-
getGroupRolesCount
public static int getGroupRolesCount(long groupId) -
getIndexableActionableDynamicQuery
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
- Throws:
PortalException
-
getResourceRoles
public static 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.- Parameters:
companyId
- the primary key of the companyname
- the resource namescope
- the permission scopeprimKey
- the primary key of the resource's class- Returns:
- the role names and action IDs
-
getResourceRoles
public static 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.- Parameters:
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 action- Returns:
- the roles
-
getRole
Returns the role with the primary key.- Parameters:
roleId
- the primary key of the role- Returns:
- the role
- Throws:
PortalException
- if a role with the primary key could not be found
-
getRole
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.
- Parameters:
companyId
- the primary key of the companyname
- the role's name- Returns:
- the role with the name
- Throws:
PortalException
-
getRoleByExternalReferenceCode
public static Role getRoleByExternalReferenceCode(String externalReferenceCode, long companyId) throws PortalException - Throws:
PortalException
-
getRoleByUuidAndCompanyId
Returns the role with the matching UUID and company.- Parameters:
uuid
- the role's UUIDcompanyId
- the primary key of the company- Returns:
- the matching role
- Throws:
PortalException
- if a matching role could not be found
-
getRoles
Returns a range of all the roles.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.RoleModelImpl
.- Parameters:
start
- the lower bound of the range of rolesend
- the upper bound of the range of roles (not inclusive)- Returns:
- the range of roles
-
getRoles
Returns all the roles of the type and subtype.- Parameters:
type
- the role's type (optionally0
)subtype
- the role's subtype (optionallynull
)- Returns:
- the roles of the type and subtype
-
getRoles
Returns all the roles in the company.- Parameters:
companyId
- the primary key of the company- Returns:
- the roles in the company
-
getRoles
Returns all the roles with the types.- Parameters:
companyId
- the primary key of the companytypes
- the role types (optionallynull
)- Returns:
- the roles with the types
-
getRoles
-
getRoles
Returns all the roles with the primary keys.- Parameters:
roleIds
- the primary keys of the roles- Returns:
- the roles with the primary keys
- Throws:
PortalException
-
getRolesCount
public static int getRolesCount()Returns the number of roles.- Returns:
- the number of roles
-
getSubtypeRoles
Returns all the roles of the subtype.- Parameters:
subtype
- the role's subtype (optionallynull
)- Returns:
- the roles of the subtype
-
getSubtypeRolesCount
Returns the number of roles of the subtype.- Parameters:
subtype
- the role's subtype (optionallynull
)- Returns:
- the number of roles of the subtype
-
getTeamRole
Returns the team role in the company.- Parameters:
companyId
- the primary key of the companyteamId
- the primary key of the team- Returns:
- the team role in the company
- Throws:
PortalException
-
getTeamRoleMap
Returns the team role map for the group.- Parameters:
groupId
- the primary key of the group- Returns:
- the team role map for the group
- Throws:
PortalException
-
getTeamRoles
Returns the team roles in the group.- Parameters:
groupId
- the primary key of the group- Returns:
- the team roles in the group
- Throws:
PortalException
-
getTeamRoles
Returns the team roles in the group, excluding the specified role IDs.- Parameters:
groupId
- the primary key of the groupexcludedRoleIds
- the primary keys of the roles to exclude (optionallynull
)- Returns:
- the team roles in the group, excluding the specified role IDs
- Throws:
PortalException
-
getTeamsRoles
Returns the team roles in the company.- Parameters:
companyId
- the primary key of the companyteamIds
- the primary keys of the teams- Returns:
- the team roles in the company
- Throws:
PortalException
-
getTypeRoles
Returns all the roles of the type.- Parameters:
type
- the role's type (optionally0
)- Returns:
- the range of the roles of the type
-
getTypeRoles
Returns a range of all the roles of the type.- Parameters:
type
- the role's type (optionally0
)start
- the lower bound of the range of roles to returnend
- the upper bound of the range of roles to return (not inclusive)- Returns:
- the range of the roles of the type
-
getTypeRolesCount
public static int getTypeRolesCount(int type) Returns the number of roles of the type.- Parameters:
type
- the role's type (optionally0
)- Returns:
- the number of roles of the type
-
getUserGroupGroupRoles
Returns all the user's roles within the user group.- Parameters:
userId
- the primary key of the usergroupId
- the primary key of the group- Returns:
- the user's roles within the user group
-
getUserGroupGroupRoles
-
getUserGroupGroupRolesCount
public static int getUserGroupGroupRolesCount(long userId, long groupId) -
getUserGroupRoles
Returns all the user's roles within the user group.- Parameters:
userId
- the primary key of the usergroupId
- the primary key of the group- Returns:
- the user's roles within the user group
-
getUserPrimaryKeys
public static long[] getUserPrimaryKeys(long roleId) Returns the userIds of the users associated with the role.- Parameters:
roleId
- the roleId of the role- Returns:
- long[] the userIds of users associated with the role
-
getUserRelatedRoles
Returns the union of all the user's roles within the groups. If no groups are provided, only the user's directly assigned roles are returned.- Parameters:
userId
- the primary key of the usergroups
- the groups (optionallynull
)- Returns:
- the union of all the user's roles within the groups
-
getUserRelatedRoles
Returns all the user's roles within the group.- Parameters:
userId
- the primary key of the usergroupId
- the primary key of the group- Returns:
- the user's roles within the group
-
getUserRelatedRoles
Returns the union of all the user's roles within the groups. If no groupIds are provided, only the user's directly assigned roles are returned.- Parameters:
userId
- the primary key of the usergroupIds
- the primary keys of the groups- Returns:
- the union of all the user's roles within the groups
-
getUserRoles
-
getUserRoles
-
getUserRoles
public static List<Role> getUserRoles(long userId, int start, int end, OrderByComparator<Role> orderByComparator) -
getUserRolesCount
public static int getUserRolesCount(long userId) -
getUserTeamRoles
-
hasGroupRole
public static boolean hasGroupRole(long groupId, long roleId) -
hasGroupRoles
public static boolean hasGroupRoles(long groupId) -
hasUserRole
public static boolean hasUserRole(long userId, long roleId) -
hasUserRole
public static boolean hasUserRole(long userId, long companyId, String name, boolean inherited) throws PortalException Returnstrue
if the user is associated with the named regular role.- Parameters:
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 search- Returns:
true
if the user is associated with the regular role;false
otherwise- Throws:
PortalException
-
hasUserRoles
public static boolean hasUserRoles(long userId) -
hasUserRoles
public static boolean hasUserRoles(long userId, long companyId, String[] names, boolean inherited) throws PortalException Returnstrue
if the user has any one of the named regular roles.- Parameters:
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 search- Returns:
true
if the user has any one of the regular roles;false
otherwise- Throws:
PortalException
-
search
public static List<Role> search(long companyId, String keywords, Integer[] types, int start, int end, OrderByComparator<Role> orderByComparator) 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
companyId
- the primary key of the companykeywords
- the keywords (space separated), which may occur in the role's name or description (optionallynull
)types
- the role types (optionallynull
)start
- the lower bound of the range of roles to returnend
- the upper bound of the range of roles to return (not inclusive)orderByComparator
- the comparator to order the roles (optionallynull
)- Returns:
- the ordered range of the matching roles, ordered by
orderByComparator
- See Also:
-
search
public static List<Role> search(long companyId, String keywords, Integer[] types, LinkedHashMap<String, Object> params, int start, int end, OrderByComparator<Role> orderByComparator) 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
companyId
- the primary key of the companykeywords
- the keywords (space separated), which may occur in the role's name or description (optionallynull
)types
- the role types (optionallynull
)params
- the finder parameters. Can specify values for the "usersRoles" key. For more information, seeRoleFinder
start
- the lower bound of the range of roles to returnend
- the upper bound of the range of roles to return (not inclusive)orderByComparator
- the comparator to order the roles (optionallynull
)- Returns:
- the ordered range of the matching roles, ordered by
orderByComparator
- See Also:
-
search
public static List<Role> search(long companyId, String name, String description, Integer[] types, int start, int end, OrderByComparator<Role> orderByComparator) 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
companyId
- the primary key of the companyname
- the role's name (optionallynull
)description
- the role's description (optionallynull
)types
- the role types (optionallynull
)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)orderByComparator
- the comparator to order the roles (optionallynull
)- Returns:
- the ordered range of the matching roles, ordered by
orderByComparator
- See Also:
-
search
public static List<Role> search(long companyId, String name, String description, Integer[] types, LinkedHashMap<String, Object> params, int start, int end, OrderByComparator<Role> orderByComparator) 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
companyId
- the primary key of the companyname
- the role's name (optionallynull
)description
- the role's description (optionallynull
)types
- the role types (optionallynull
)params
- the finder's parameters. Can specify values for the "usersRoles" key. For more information, seeRoleFinder
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)orderByComparator
- the comparator to order the roles (optionallynull
)- Returns:
- the ordered range of the matching roles, ordered by
orderByComparator
- See Also:
-
searchCount
Returns the number of roles that match the keywords and types.- Parameters:
companyId
- the primary key of the companykeywords
- the keywords (space separated), which may occur in the role's name or description (optionallynull
)types
- the role types (optionallynull
)- Returns:
- the number of matching roles
-
searchCount
public static int searchCount(long companyId, String keywords, Integer[] types, LinkedHashMap<String, Object> params) Returns the number of roles that match the keywords, types and params.- Parameters:
companyId
- the primary key of the companykeywords
- the keywords (space separated), which may occur in the role's name or description (optionallynull
)types
- the role types (optionallynull
)params
- the finder parameters. For more information, seeRoleFinder
- Returns:
- the number of matching roles
-
searchCount
Returns the number of roles that match the name, description, and types.- Parameters:
companyId
- the primary key of the companyname
- the role's name (optionallynull
)description
- the role's description (optionallynull
)types
- the role types (optionallynull
)- Returns:
- the number of matching roles
-
searchCount
public static 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.- Parameters:
companyId
- the primary key of the companyname
- the role's name (optionallynull
)description
- the role's description (optionallynull
)types
- the role types (optionallynull
)params
- the finder parameters. Can specify values for the "usersRoles" key. For more information, seeRoleFinder
- Returns:
- the number of matching roles
-
setGroupRoles
public static void setGroupRoles(long groupId, long[] roleIds) -
setUserRoles
- Throws:
PortalException
-
unsetUserRoles
Removes the matching roles associated with the user. The user is reindexed after the roles are removed.- Parameters:
userId
- the primary key of the userroleIds
- the primary keys of the roles- Throws:
PortalException
-
updateExternalReferenceCode
public static Role updateExternalReferenceCode(long roleId, String externalReferenceCode) throws PortalException - Throws:
PortalException
-
updateExternalReferenceCode
public static Role updateExternalReferenceCode(Role role, String externalReferenceCode) throws PortalException - Throws:
PortalException
-
updateRole
public static Role updateRole(long roleId, String name, Map<Locale, String> titleMap, Map<Locale, throws PortalExceptionString> descriptionMap, String subtype, ServiceContext serviceContext) Updates the role with the primary key.- Parameters:
roleId
- the primary key of the rolename
- the role's new nametitleMap
- the new localized titles (optionallynull
) to replace those existing for the roledescriptionMap
- the new localized descriptions (optionallynull
) to replace those existing for the rolesubtype
- the role's new subtype (optionallynull
)serviceContext
- the service context to be applied (optionallynull
). Can set expando bridge attributes for the role.- Returns:
- the role with the primary key
- Throws:
PortalException
-
updateRole
Updates the role in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect RoleLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
role
- the role- Returns:
- the role that was updated
-
validateName
- Throws:
PortalException
-
getService
-
setService
-