Class RoleServiceUtil

Object
com.liferay.portal.kernel.service.RoleServiceUtil

public class RoleServiceUtil extends Object
Provides the remote service utility for Role. This utility wraps com.liferay.portal.service.impl.RoleServiceImpl and is an access point for service operations in application layer code running on a remote server. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.
Author:
Brian Wing Shun Chan
See Also:
{$generated.description}
  • Constructor Details

    • RoleServiceUtil

      public RoleServiceUtil()
  • Method Details

    • addRole

      public static Role addRole(String externalReferenceCode, String className, long classPK, String name, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, int type, String subtype, ServiceContext serviceContext) throws PortalException
      Throws:
      PortalException
    • addUserRoles

      public static void addUserRoles(long userId, long[] roleIds) throws PortalException
      Adds the roles to the user. The user is reindexed after the roles are added.
      Parameters:
      userId - the primary key of the user
      roleIds - the primary keys of the roles
      Throws:
      PortalException
    • deleteRole

      public static void deleteRole(long roleId) throws PortalException
      Deletes the role with the primary key and its associated permissions.
      Parameters:
      roleId - the primary key of the role
      Throws:
      PortalException
    • fetchRole

      public static Role fetchRole(long roleId) throws PortalException
      Throws:
      PortalException
    • fetchRole

      public static Role fetchRole(long companyId, String name) throws PortalException
      Throws:
      PortalException
    • fetchRoleByExternalReferenceCode

      public static Role fetchRoleByExternalReferenceCode(String externalReferenceCode, long companyId) throws PortalException
      Throws:
      PortalException
    • getGroupRoles

      public static List<Role> getGroupRoles(long groupId) throws PortalException
      Returns all the roles associated with the group.
      Parameters:
      groupId - the primary key of the group
      Returns:
      the roles associated with the group
      Throws:
      PortalException
    • 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)
    • getOSGiServiceIdentifier

      public static String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • 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 with the primary key
      Throws:
      PortalException
    • 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
    • getRoles

      public static List<Role> getRoles(int type, String subtype) throws PortalException
      Throws:
      PortalException
    • getRoles

      public static List<Role> getRoles(long companyId, int[] types) throws PortalException
      Throws:
      PortalException
    • getUserGroupGroupRoles

      public static List<Role> getUserGroupGroupRoles(long userId, long groupId) throws PortalException
      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
      Throws:
      PortalException
    • getUserGroupRoles

      public static List<Role> getUserGroupRoles(long userId, long groupId) throws PortalException
      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
      Throws:
      PortalException
    • getUserRelatedRoles

      public static List<Role> getUserRelatedRoles(long userId, List<Group> groups) throws PortalException
      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
      Throws:
      PortalException
    • getUserRoles

      public static List<Role> getUserRoles(long userId) throws PortalException
      Returns all the roles associated with the user.
      Parameters:
      userId - the primary key of the user
      Returns:
      the roles associated with the user
      Throws:
      PortalException
    • 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, 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, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator<Role> orderByComparator)
    • searchCount

      public static int searchCount(long companyId, String keywords, Integer[] types, LinkedHashMap<String,Object> params)
    • 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 the expando bridge attributes for the role.
      Returns:
      the role with the primary key
      Throws:
      PortalException
    • getService

      public static RoleService getService()
    • setService

      public static void setService(RoleService service)