Class RoleLocalServiceUtil

Object
com.liferay.portal.kernel.service.RoleLocalServiceUtil

public class RoleLocalServiceUtil extends Object
Provides the local service utility for Role. This utility wraps 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 Details

    • RoleLocalServiceUtil

      public RoleLocalServiceUtil()
  • Method Details

    • addGroupRole

      public static boolean addGroupRole(long groupId, long roleId)
    • addGroupRole

      public static boolean addGroupRole(long groupId, Role role)
    • addGroupRoles

      public static boolean addGroupRoles(long groupId, List<Role> roles)
    • addGroupRoles

      public static boolean addGroupRoles(long groupId, long[] roleIds)
    • addRole

      public static Role addRole(Role role)
      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,String> descriptionMap, int type, String subtype, ServiceContext serviceContext) throws PortalException
      Throws:
      PortalException
    • addUserRole

      public static boolean addUserRole(long userId, long roleId) throws PortalException
      Throws:
      PortalException
    • addUserRole

      public static boolean addUserRole(long userId, Role role) throws PortalException
      Throws:
      PortalException
    • addUserRoles

      public static boolean addUserRoles(long userId, List<Role> roles) throws PortalException
      Throws:
      PortalException
    • addUserRoles

      public static boolean addUserRoles(long userId, long[] roleIds) throws PortalException
      Throws:
      PortalException
    • checkSystemRoles

      public static void checkSystemRoles() throws PortalException
      Checks to ensure that the system roles map has appropriate default roles in each company.
      Throws:
      PortalException
    • checkSystemRoles

      public static void checkSystemRoles(long companyId) throws PortalException
      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

      public static void clearUserRoles(long userId) throws PortalException
      Throws:
      PortalException
    • createPersistedModel

      public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
      Throws:
      PortalException
    • createRole

      public static Role createRole(long roleId)
      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

      public static void deleteGroupRole(long groupId, Role role)
    • deleteGroupRoles

      public static void deleteGroupRoles(long groupId, List<Role> roles)
    • deleteGroupRoles

      public static void deleteGroupRoles(long groupId, long[] roleIds)
    • deletePersistedModel

      public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
      Throws:
      PortalException
    • deleteRole

      public static Role deleteRole(long roleId) throws PortalException
      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

      public static Role deleteRole(Role role) throws PortalException
      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

      public static void deleteUserRole(long userId, long roleId) throws PortalException
      Throws:
      PortalException
    • deleteUserRole

      public static void deleteUserRole(long userId, Role role) throws PortalException
      Throws:
      PortalException
    • deleteUserRoles

      public static void deleteUserRoles(long userId, List<Role> roles) throws PortalException
      Throws:
      PortalException
    • deleteUserRoles

      public static void deleteUserRoles(long userId, long[] roleIds) throws PortalException
      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

      public static DynamicQuery dynamicQuery()
    • dynamicQuery

      public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
      Performs a dynamic query on the database and returns the matching rows.
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the matching rows
    • dynamicQuery

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

      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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.RoleModelImpl.

      Parameters:
      dynamicQuery - the dynamic query
      start - the lower bound of the range of model instances
      end - the upper bound of the range of model instances (not inclusive)
      Returns:
      the range of matching rows
    • 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 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.RoleModelImpl.

      Parameters:
      dynamicQuery - the dynamic query
      start - the lower bound of the range of model instances
      end - the upper bound of the range of model instances (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the ordered range of matching rows
    • dynamicQueryCount

      public static long dynamicQueryCount(DynamicQuery dynamicQuery)
      Returns the number of rows matching the dynamic query.
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the number of rows matching the dynamic query
    • dynamicQueryCount

      public static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
      Returns the number of rows matching the dynamic query.
      Parameters:
      dynamicQuery - the dynamic query
      projection - the projection to apply to the query
      Returns:
      the number of rows matching the dynamic query
    • fetchRole

      public static Role fetchRole(long roleId)
    • fetchRole

      public static Role fetchRole(long companyId, String name)
      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 company
      name - the role's name
      Returns:
      Returns the role with the name or null if a role with the name could not be found in the company
    • fetchRoleByExternalReferenceCode

      public static Role fetchRoleByExternalReferenceCode(String externalReferenceCode, long companyId)
    • fetchRoleByUuidAndCompanyId

      public static Role fetchRoleByUuidAndCompanyId(String uuid, long companyId)
      Returns the role with the matching UUID and company.
      Parameters:
      uuid - the role's UUID
      companyId - the primary key of the company
      Returns:
      the matching role, or null if a matching role could not be found
    • getActionableDynamicQuery

      public static ActionableDynamicQuery getActionableDynamicQuery()
    • getAssigneesTotal

      public static int getAssigneesTotal(long roleId) throws PortalException
      Throws:
      PortalException
    • getDefaultGroupRole

      public static Role getDefaultGroupRole(long groupId) throws PortalException
      Returns the default role for the group with the primary key.

      If the group is a site, then the default role is RoleConstants#SITE_MEMBER. If the group is an organization, then the default role is RoleConstants#ORGANIZATION_USER. If the group is a user or user group, then the default role is RoleConstants#POWER_USER. For all other group types, the default role is RoleConstants#USER.

      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

      public static List<Role> getGroupRelatedRoles(long groupId) throws PortalException
      Throws:
      PortalException
    • getGroupRoles

      public static List<Role> getGroupRoles(long groupId)
    • getGroupRoles

      public static List<Role> getGroupRoles(long groupId, int start, int end)
    • getGroupRoles

      public static List<Role> getGroupRoles(long groupId, int start, int end, OrderByComparator<Role> orderByComparator)
    • getGroupRolesAndTeamRoles

      public 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)
    • getGroupRolesAndTeamRolesCount

      public static int getGroupRolesAndTeamRolesCount(long companyId, String name, List<String> excludedNames, String title, String description, int[] types, long excludedTeamRoleId, long teamGroupId)
    • getGroupRolesCount

      public static int getGroupRolesCount(long groupId)
    • getIndexableActionableDynamicQuery

      public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

      public static String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • getPersistedModel

      public static PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
      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 company
      name - the resource name
      scope - the permission scope
      primKey - the primary key of the resource's class
      Returns:
      the role names and action IDs
    • 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 company
      name - the resource name
      scope - the permission scope
      primKey - the primary key of the resource's class
      actionId - the name of the resource action
      Returns:
      the roles
    • getRole

      public static Role getRole(long roleId) throws PortalException
      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

      public static Role getRole(long companyId, String name) throws PortalException
      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 company
      name - 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

      public static Role getRoleByUuidAndCompanyId(String uuid, long companyId) throws PortalException
      Returns the role with the matching UUID and company.
      Parameters:
      uuid - the role's UUID
      companyId - the primary key of the company
      Returns:
      the matching role
      Throws:
      PortalException - if a matching role could not be found
    • getRoles

      public static List<Role> getRoles(int start, int end)
      Returns a range of all the roles.

      Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.RoleModelImpl.

      Parameters:
      start - the lower bound of the range of roles
      end - the upper bound of the range of roles (not inclusive)
      Returns:
      the range of roles
    • getRoles

      public static List<Role> getRoles(int type, String subtype)
      Returns all the roles of the type and subtype.
      Parameters:
      type - the role's type (optionally 0)
      subtype - the role's subtype (optionally null)
      Returns:
      the roles of the type and subtype
    • getRoles

      public static List<Role> getRoles(long companyId)
      Returns all the roles in the company.
      Parameters:
      companyId - the primary key of the company
      Returns:
      the roles in the company
    • getRoles

      public static List<Role> getRoles(long companyId, int[] types)
      Returns all the roles with the types.
      Parameters:
      companyId - the primary key of the company
      types - the role types (optionally null)
      Returns:
      the roles with the types
    • getRoles

      public static List<Role> getRoles(long companyId, long classNameId, long[] classPKs, int type)
    • getRoles

      public static List<Role> getRoles(long[] roleIds) throws PortalException
      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

      public static List<Role> getSubtypeRoles(String subtype)
      Returns all the roles of the subtype.
      Parameters:
      subtype - the role's subtype (optionally null)
      Returns:
      the roles of the subtype
    • getSubtypeRolesCount

      public static int getSubtypeRolesCount(String subtype)
      Returns the number of roles of the subtype.
      Parameters:
      subtype - the role's subtype (optionally null)
      Returns:
      the number of roles of the subtype
    • getTeamRole

      public static Role getTeamRole(long companyId, long teamId) throws PortalException
      Returns the team role in the company.
      Parameters:
      companyId - the primary key of the company
      teamId - the primary key of the team
      Returns:
      the team role in the company
      Throws:
      PortalException
    • getTeamRoleMap

      public static Map<Team,Role> getTeamRoleMap(long groupId) throws PortalException
      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

      public static List<Role> getTeamRoles(long groupId) throws PortalException
      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

      public static List<Role> getTeamRoles(long groupId, long[] excludedRoleIds) throws PortalException
      Returns the team roles in the group, excluding the specified role IDs.
      Parameters:
      groupId - the primary key of the group
      excludedRoleIds - the primary keys of the roles to exclude (optionally null)
      Returns:
      the team roles in the group, excluding the specified role IDs
      Throws:
      PortalException
    • getTeamsRoles

      public static List<Role> getTeamsRoles(long companyId, long[] teamIds) throws PortalException
      Returns the team roles in the company.
      Parameters:
      companyId - the primary key of the company
      teamIds - the primary keys of the teams
      Returns:
      the team roles in the company
      Throws:
      PortalException
    • getTypeRoles

      public static List<Role> getTypeRoles(int type)
      Returns all the roles of the type.
      Parameters:
      type - the role's type (optionally 0)
      Returns:
      the range of the roles of the type
    • getTypeRoles

      public static List<Role> getTypeRoles(int type, int start, int end)
      Returns a range of all the roles of the type.
      Parameters:
      type - the role's type (optionally 0)
      start - the lower bound of the range of roles to return
      end - 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 (optionally 0)
      Returns:
      the number of roles of the type
    • getUserGroupGroupRoles

      public static List<Role> getUserGroupGroupRoles(long userId, long groupId)
      Returns all the user's roles within the user group.
      Parameters:
      userId - the primary key of the user
      groupId - the primary key of the group
      Returns:
      the user's roles within the user group
    • getUserGroupGroupRoles

      public static List<Role> getUserGroupGroupRoles(long userId, long groupId, int start, int end)
    • getUserGroupGroupRolesCount

      public static int getUserGroupGroupRolesCount(long userId, long groupId)
    • getUserGroupRoles

      public static List<Role> getUserGroupRoles(long userId, long groupId)
      Returns all the user's roles within the user group.
      Parameters:
      userId - the primary key of the user
      groupId - 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

      public static List<Role> getUserRelatedRoles(long userId, List<Group> groups)
      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 user
      groups - the groups (optionally null)
      Returns:
      the union of all the user's roles within the groups
    • getUserRelatedRoles

      public static List<Role> getUserRelatedRoles(long userId, long groupId)
      Returns all the user's roles within the group.
      Parameters:
      userId - the primary key of the user
      groupId - the primary key of the group
      Returns:
      the user's roles within the group
    • getUserRelatedRoles

      public static List<Role> getUserRelatedRoles(long userId, long[] groupIds)
      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 user
      groupIds - the primary keys of the groups
      Returns:
      the union of all the user's roles within the groups
    • getUserRoles

      public static List<Role> getUserRoles(long userId)
    • getUserRoles

      public static List<Role> getUserRoles(long userId, int start, int end)
    • getUserRoles

      public static List<Role> getUserRoles(long userId, int start, int end, OrderByComparator<Role> orderByComparator)
    • getUserRolesCount

      public static int getUserRolesCount(long userId)
    • getUserTeamRoles

      public static List<Role> getUserTeamRoles(long userId, long groupId)
    • 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
      Returns true if the user is associated with the named regular role.
      Parameters:
      userId - the primary key of the user
      companyId - the primary key of the company
      name - the name of the role
      inherited - whether to include the user's inherited roles in the search
      Returns:
      true if the user is associated with the regular role; false otherwise
      Throws:
      PortalException
    • hasUserRoles

      public static boolean hasUserRoles(long userId)
    • hasUserRoles

      public static boolean hasUserRoles(long userId, long companyId, String[] names, boolean inherited) throws PortalException
      Returns true if the user has any one of the named regular roles.
      Parameters:
      userId - the primary key of the user
      companyId - the primary key of the company
      names - the names of the roles
      inherited - whether to include the user's inherited roles in the search
      Returns:
      true if the user has any one of the regular roles; false otherwise
      Throws:
      PortalException
    • 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 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.

      Parameters:
      companyId - the primary key of the company
      keywords - the keywords (space separated), which may occur in the role's name or description (optionally null)
      types - the role types (optionally null)
      start - the lower bound of the range of roles to return
      end - the upper bound of the range of roles to return (not inclusive)
      orderByComparator - the comparator to order the roles (optionally null)
      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 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.

      Parameters:
      companyId - the primary key of the company
      keywords - the keywords (space separated), which may occur in the role's name or description (optionally null)
      types - the role types (optionally null)
      params - the finder parameters. Can specify values for the "usersRoles" key. For more information, see RoleFinder
      start - the lower bound of the range of roles to return
      end - the upper bound of the range of roles to return (not inclusive)
      orderByComparator - the comparator to order the roles (optionally null)
      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 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.

      Parameters:
      companyId - the primary key of the company
      name - the role's name (optionally null)
      description - the role's description (optionally null)
      types - the role types (optionally null)
      start - the lower bound of the range of the roles to return
      end - the upper bound of the range of the roles to return (not inclusive)
      orderByComparator - the comparator to order the roles (optionally null)
      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 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.

      Parameters:
      companyId - the primary key of the company
      name - the role's name (optionally null)
      description - the role's description (optionally null)
      types - the role types (optionally null)
      params - the finder's parameters. Can specify values for the "usersRoles" key. For more information, see RoleFinder
      start - the lower bound of the range of the roles to return
      end - the upper bound of the range of the roles to return (not inclusive)
      orderByComparator - the comparator to order the roles (optionally null)
      Returns:
      the ordered range of the matching roles, ordered by orderByComparator
      See Also:
    • searchCount

      public static int searchCount(long companyId, String keywords, Integer[] types)
      Returns the number of roles that match the keywords and types.
      Parameters:
      companyId - the primary key of the company
      keywords - the keywords (space separated), which may occur in the role's name or description (optionally null)
      types - the role types (optionally null)
      Returns:
      the number of matching roles
    • 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 company
      keywords - the keywords (space separated), which may occur in the role's name or description (optionally null)
      types - the role types (optionally null)
      params - the finder parameters. For more information, see RoleFinder
      Returns:
      the number of matching roles
    • searchCount

      public static int searchCount(long companyId, String name, String description, Integer[] types)
      Returns the number of roles that match the name, description, and types.
      Parameters:
      companyId - the primary key of the company
      name - the role's name (optionally null)
      description - the role's description (optionally null)
      types - the role types (optionally null)
      Returns:
      the number of matching roles
    • 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 company
      name - the role's name (optionally null)
      description - the role's description (optionally null)
      types - the role types (optionally null)
      params - the finder parameters. Can specify values for the "usersRoles" key. For more information, see RoleFinder
      Returns:
      the number of matching roles
    • setGroupRoles

      public static void setGroupRoles(long groupId, long[] roleIds)
    • setUserRoles

      public static void setUserRoles(long userId, long[] roleIds) throws PortalException
      Throws:
      PortalException
    • unsetUserRoles

      public static void unsetUserRoles(long userId, long[] roleIds) throws PortalException
      Removes the matching roles associated with the user. The user is reindexed after the roles are removed.
      Parameters:
      userId - the primary key of the user
      roleIds - 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,String> descriptionMap, String subtype, ServiceContext serviceContext) throws PortalException
      Updates the role with the primary key.
      Parameters:
      roleId - the primary key of the role
      name - the role's new name
      titleMap - the new localized titles (optionally null) to replace those existing for the role
      descriptionMap - the new localized descriptions (optionally null) to replace those existing for the role
      subtype - the role's new subtype (optionally null)
      serviceContext - the service context to be applied (optionally null). Can set expando bridge attributes for the role.
      Returns:
      the role with the primary key
      Throws:
      PortalException
    • updateRole

      public static Role updateRole(Role role)
      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

      public static void validateName(String name) throws PortalException
      Throws:
      PortalException
    • getService

      public static RoleLocalService getService()
    • setService

      public static void setService(RoleLocalService service)