Liferay 7.0-ce-b4

com.liferay.portal.service
Class RoleServiceUtil

java.lang.Object
  extended by com.liferay.portal.service.RoleServiceUtil

@ProviderType
public class RoleServiceUtil
extends Object

Provides the remote service utility for Role. This utility wraps com.liferay.portal.service.impl.RoleServiceImpl and is the primary 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.

See Also:
RoleService, RoleServiceBaseImpl, com.liferay.portal.service.impl.RoleServiceImpl

Constructor Summary
RoleServiceUtil()
           
 
Method Summary
static Role addRole(String className, long classPK, String name, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, int type, String subtype, ServiceContext serviceContext)
          Adds a role.
static Role addRole(String name, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, int type)
          Deprecated. As of 6.2.0, replaced by addRole(String, long, String, Map, Map, int, String, ServiceContext)
static void addUserRoles(long userId, long[] roleIds)
          Adds the roles to the user.
static void deleteRole(long roleId)
          Deletes the role with the primary key and its associated permissions.
static Role fetchRole(long roleId)
           
static List<Role> getGroupRoles(long groupId)
          Returns all the roles associated with the group.
static String getOSGiServiceIdentifier()
          Returns the OSGi service identifier.
static Role getRole(long roleId)
          Returns the role with the primary key.
static Role getRole(long companyId, String name)
          Returns the role with the name in the company.
static List<Role> getRoles(int type, String subtype)
           
static List<Role> getRoles(long companyId, int[] types)
           
static RoleService getService()
           
static List<Role> getUserGroupGroupRoles(long userId, long groupId)
          Returns all the user's roles within the user group.
static List<Role> getUserGroupRoles(long userId, long groupId)
          Returns all the user's roles within the user group.
static List<Role> getUserRelatedRoles(long userId, List<Group> groups)
          Returns the union of all the user's roles within the groups.
static List<Role> getUserRoles(long userId)
          Returns all the roles associated with the user.
static boolean hasUserRole(long userId, long companyId, String name, boolean inherited)
          Returns true if the user is associated with the named regular role.
static boolean hasUserRoles(long userId, long companyId, String[] names, boolean inherited)
          Returns true if the user has any one of the named regular roles.
static List<Role> search(long companyId, String keywords, Integer[] types, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator<Role> obc)
           
static int searchCount(long companyId, String keywords, Integer[] types, LinkedHashMap<String,Object> params)
           
static void unsetUserRoles(long userId, long[] roleIds)
          Removes the matching roles associated with the user.
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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RoleServiceUtil

public RoleServiceUtil()
Method Detail

addRole

public static Role addRole(String className,
                           long classPK,
                           String name,
                           Map<Locale,String> titleMap,
                           Map<Locale,String> descriptionMap,
                           int type,
                           String subtype,
                           ServiceContext serviceContext)
                    throws PortalException
Adds a role. The user is reindexed after role is added.

Parameters:
className - the name of the class for which the role is created
classPK - the primary key of the class for which the role is created (optionally 0)
name - the role's name
titleMap - 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 the expando bridge attributes for the role.
Returns:
the role
Throws:
PortalException

addRole

@Deprecated
public static Role addRole(String name,
                                      Map<Locale,String> titleMap,
                                      Map<Locale,String> descriptionMap,
                                      int type)
                    throws PortalException
Deprecated. As of 6.2.0, replaced by addRole(String, long, String, Map, Map, int, String, ServiceContext)

Adds a role. The user is reindexed after role is added.

Parameters:
name - the role's name
titleMap - the role's localized titles (optionally null)
descriptionMap - the role's localized descriptions (optionally null)
type - the role's type (optionally 0)
Returns:
the role
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

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

getOSGiServiceIdentifier

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

Returns:
the OSGi service identifier

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

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

getRoles

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

getRoles

public static List<Role> getRoles(int type,
                                  String subtype)
                           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.

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> obc)

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

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()

Liferay 7.0-ce-b4