Liferay 6.1.10-ee-ga1

com.liferay.portal.service
Class RoleLocalServiceUtil

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

public class RoleLocalServiceUtil
extends Object

The utility for the role local service. This utility wraps RoleLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

This is a local service. 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.

See Also:
RoleLocalService, RoleLocalServiceBaseImpl, RoleLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
RoleLocalServiceUtil()
           
 
Method Summary
static Role addRole(long userId, long companyId, String name, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, int type)
          Adds a role.
static Role addRole(long userId, long companyId, String name, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, int type, String className, long classPK)
          Adds a role with additional parameters.
static Role addRole(Role role)
          Adds the role to the database.
static void addUserRoles(long userId, long[] roleIds)
          Adds the roles to the user.
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 Role createRole(long roleId)
          Creates a new role with the primary key.
static void deleteRole(long roleId)
          Deletes the role with the primary key from the database.
static void deleteRole(Role role)
          Deletes the role from the database.
static List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
static 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 Role fetchRole(long roleId)
           
static Role fetchRole(long companyId, String name)
          Returns the role with the name in the company.
static 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 List<Role> getGroupRoles(long groupId)
          Returns all the roles associated with the group.
static PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
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.
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.
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 start, int end)
          Returns a range of all the roles.
static List<Role> getRoles(int type, String subtype)
          Returns all the roles of the type and subtype.
static List<Role> getRoles(long companyId)
          Returns all the roles in the company.
static List<Role> getRoles(long[] roleIds)
          Returns all the roles with the primary keys.
static int getRolesCount()
          Returns the number of roles.
static RoleLocalService getService()
           
static List<Role> 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.
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> getUserRelatedRoles(long userId, long groupId)
          Returns all the user's roles within the group.
static List<Role> getUserRelatedRoles(long userId, long[] groupIds)
          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 roleId)
          Returns true if the user is associated with the role.
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 Role loadFetchRole(long companyId, String name)
          Returns a role with the name in the company.
static Role loadGetRole(long companyId, String name)
          Returns a role with the name in the company.
static List<Role> search(long companyId, String keywords, Integer[] types, int start, int end, OrderByComparator obc)
          Returns an ordered range of all the roles that match the keywords and types.
static List<Role> search(long companyId, String keywords, Integer[] types, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator obc)
          Returns an ordered range of all the roles that match the keywords, types, and params.
static List<Role> search(long companyId, String name, String description, Integer[] types, int start, int end, OrderByComparator obc)
          Returns an ordered range of all the roles that match the name, description, and types.
static List<Role> search(long companyId, String name, String description, Integer[] types, LinkedHashMap<String,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, 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 setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setService(RoleLocalService service)
           
static void setUserRoles(long userId, long[] roleIds)
          Sets the roles associated with the user, replacing the user's existing roles.
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)
          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 Role updateRole(Role role, boolean merge)
          Updates the role in the database or adds it if it does not yet exist.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RoleLocalServiceUtil

public RoleLocalServiceUtil()
Method Detail

addRole

public static Role addRole(Role role)
                    throws SystemException
Adds the role to the database. Also notifies the appropriate model listeners.

Parameters:
role - the role
Returns:
the role that was added
Throws:
SystemException - if a system exception occurred

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

deleteRole

public static void deleteRole(long roleId)
                       throws PortalException,
                              SystemException
Deletes the role with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
roleId - the primary key of the role
Throws:
PortalException - if a role with the primary key could not be found
SystemException - if a system exception occurred

deleteRole

public static void deleteRole(Role role)
                       throws PortalException,
                              SystemException
Deletes the role from the database. Also notifies the appropriate model listeners.

Parameters:
role - the role
Throws:
PortalException
SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end)
                         throws SystemException
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 QueryUtil.ALL_POS will return the full result set.

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
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                         throws SystemException
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 QueryUtil.ALL_POS will return the full result set.

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
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

fetchRole

public static Role fetchRole(long roleId)
                      throws SystemException
Throws:
SystemException

getRole

public static Role getRole(long roleId)
                    throws PortalException,
                           SystemException
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
SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException
Throws:
PortalException
SystemException

getRoles

public static List<Role> getRoles(int start,
                                  int end)
                           throws SystemException
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 QueryUtil.ALL_POS will return the full result set.

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
Throws:
SystemException - if a system exception occurred

getRolesCount

public static int getRolesCount()
                         throws SystemException
Returns the number of roles.

Returns:
the number of roles
Throws:
SystemException - if a system exception occurred

updateRole

public static Role updateRole(Role role)
                       throws SystemException
Updates the role in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
role - the role
Returns:
the role that was updated
Throws:
SystemException - if a system exception occurred

updateRole

public static Role updateRole(Role role,
                              boolean merge)
                       throws SystemException
Updates the role in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
role - the role
merge - whether to merge the role with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.
Returns:
the role that was updated
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

public static String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

addRole

public static Role addRole(long userId,
                           long companyId,
                           String name,
                           Map<Locale,String> titleMap,
                           Map<Locale,String> descriptionMap,
                           int type)
                    throws PortalException,
                           SystemException
Adds a role. The user is reindexed after role is added.

Parameters:
userId - the primary key of the user
companyId - the primary key of the company
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 - 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 found
SystemException - if a system exception occurred

addRole

public static Role addRole(long userId,
                           long companyId,
                           String name,
                           Map<Locale,String> titleMap,
                           Map<Locale,String> descriptionMap,
                           int type,
                           String className,
                           long classPK)
                    throws PortalException,
                           SystemException
Adds a role with additional parameters. The user is reindexed after role is added.

Parameters:
userId - the primary key of the user
companyId - the primary key of the company
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)
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)
Returns:
the role
Throws:
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 found
SystemException - if a system exception occurred

addUserRoles

public static void addUserRoles(long userId,
                                long[] roleIds)
                         throws PortalException,
                                SystemException
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 - if a user with the primary key could not be found
SystemException - if a system exception occurred
See Also:
UserPersistence.addRoles( long, long[])

checkSystemRoles

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

Throws:
PortalException - if the current user did not have permission to set applicable permissions on a role
SystemException - if a system exception occurred

checkSystemRoles

public static void checkSystemRoles(long companyId)
                             throws PortalException,
                                    SystemException
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 - if the current user did not have permission to set applicable permissions on a role
SystemException - if a system exception occurred

fetchRole

public static Role fetchRole(long companyId,
                             String name)
                      throws SystemException
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
Throws:
SystemException - if a system exception occurred

getDefaultGroupRole

public static Role getDefaultGroupRole(long groupId)
                                throws PortalException,
                                       SystemException
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 - if a group with the primary key could not be found, or if a default role could not be found for the group
SystemException - if a system exception occurred

getGroupRoles

public static List<Role> getGroupRoles(long groupId)
                                throws SystemException
Returns all the roles associated with the group.

Parameters:
groupId - the primary key of the group
Returns:
the roles associated with the group
Throws:
SystemException - if a system exception occurred

getResourceRoles

public static Map<String,List<String>> getResourceRoles(long companyId,
                                                        String name,
                                                        int scope,
                                                        String primKey)
                                                 throws SystemException
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
Throws:
SystemException - if a system exception occurred
See Also:
RoleFinder.findByC_N_S_P( long, String, int, String)

getResourceRoles

public static List<Role> getResourceRoles(long companyId,
                                          String name,
                                          int scope,
                                          String primKey,
                                          String actionId)
                                   throws SystemException
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
Throws:
SystemException - if a system exception occurred
See Also:
RoleFinder.findByC_N_S_P_A( long, String, int, String, String)

getRole

public static Role getRole(long companyId,
                           String name)
                    throws PortalException,
                           SystemException
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 - if a role with the name could not be found in the company
SystemException - if a system exception occurred

getRoles

public static List<Role> getRoles(int type,
                                  String subtype)
                           throws SystemException
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
Throws:
SystemException - if a system exception occurred

getRoles

public static List<Role> getRoles(long companyId)
                           throws SystemException
Returns all the roles in the company.

Parameters:
companyId - the primary key of the company
Returns:
the roles in the company
Throws:
SystemException - if a system exception occurred

getRoles

public static List<Role> getRoles(long[] roleIds)
                           throws PortalException,
                                  SystemException
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 - if any one of the roles with the primary keys could not be found
SystemException - if a system exception occurred

getSubtypeRoles

public static List<Role> getSubtypeRoles(String subtype)
                                  throws SystemException
Returns all the roles of the subtype.

Parameters:
subtype - the role's subtype (optionally null)
Returns:
the roles of the subtype
Throws:
SystemException - if a system exception occurred

getSubtypeRolesCount

public static int getSubtypeRolesCount(String subtype)
                                throws SystemException
Returns the number of roles of the subtype.

Parameters:
subtype - the role's subtype (optionally null)
Returns:
the number of roles of the subtype
Throws:
SystemException - if a system exception occurred

getTeamRole

public static Role getTeamRole(long companyId,
                               long teamId)
                        throws PortalException,
                               SystemException
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 - if a role could not be found in the team and company
SystemException - if a system exception occurred

getUserGroupGroupRoles

public static List<Role> getUserGroupGroupRoles(long userId,
                                                long groupId)
                                         throws SystemException
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:
SystemException - if a system exception occurred
See Also:
RoleFinder.findByUserGroupGroupRole( long, long)

getUserGroupRoles

public static List<Role> getUserGroupRoles(long userId,
                                           long groupId)
                                    throws SystemException
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:
SystemException - if a system exception occurred
See Also:
RoleFinder.findByUserGroupRole( long, long)

getUserRelatedRoles

public static List<Role> getUserRelatedRoles(long userId,
                                             List<Group> groups)
                                      throws SystemException
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:
SystemException - if a system exception occurred
See Also:
RoleFinder.findByU_G( long, List)

getUserRelatedRoles

public static List<Role> getUserRelatedRoles(long userId,
                                             long groupId)
                                      throws SystemException
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
Throws:
SystemException - if a system exception occurred
See Also:
RoleFinder.findByU_G( long, long)

getUserRelatedRoles

public static List<Role> getUserRelatedRoles(long userId,
                                             long[] groupIds)
                                      throws SystemException
Returns the union of all the user's roles within the groups.

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
Throws:
SystemException - if a system exception occurred
See Also:
RoleFinder.findByU_G( long, long[])

getUserRoles

public static List<Role> getUserRoles(long userId)
                               throws SystemException
Returns all the roles associated with the user.

Parameters:
userId - the primary key of the user
Returns:
the roles associated with the user
Throws:
SystemException - if a system exception occurred

hasUserRole

public static boolean hasUserRole(long userId,
                                  long roleId)
                           throws SystemException
Returns true if the user is associated with the role.

Parameters:
userId - the primary key of the user
roleId - the primary key of the role
Returns:
true if the user is associated with the role; false otherwise
Throws:
SystemException - if a system exception occurred

hasUserRole

public static boolean hasUserRole(long userId,
                                  long companyId,
                                  String name,
                                  boolean inherited)
                           throws PortalException,
                                  SystemException
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 - if a role with the name could not be found in the company or if a default user for the company could not be found
SystemException - if a system exception occurred

hasUserRoles

public static boolean hasUserRoles(long userId,
                                   long companyId,
                                   String[] names,
                                   boolean inherited)
                            throws PortalException,
                                   SystemException
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 - 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 found
SystemException - if a system exception occurred

loadFetchRole

public static Role loadFetchRole(long companyId,
                                 String name)
                          throws SystemException
Returns a role with the name in the company.

Parameters:
companyId - the primary key of the company
name - the role's name (optionally null)
Returns:
the role with the name, or null if a role with the name could not be found in the company
Throws:
SystemException - if a system exception occurred

loadGetRole

public static Role loadGetRole(long companyId,
                               String name)
                        throws PortalException,
                               SystemException
Returns a role with the name in the company.

Parameters:
companyId - the primary key of the company
name - the role's name
Returns:
the role with the name in the company
Throws:
PortalException - if a role with the name could not be found in the company
SystemException - if a system exception occurred

search

public static List<Role> search(long companyId,
                                String keywords,
                                Integer[] types,
                                int start,
                                int end,
                                OrderByComparator obc)
                         throws SystemException
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)
obc - the comparator to order the roles (optionally null)
Returns:
the ordered range of the matching roles, ordered by obc
Throws:
SystemException - if a system exception occurred
See Also:
RoleFinder

search

public static List<Role> search(long companyId,
                                String keywords,
                                Integer[] types,
                                LinkedHashMap<String,Object> params,
                                int start,
                                int end,
                                OrderByComparator obc)
                         throws SystemException
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 "permissionsResourceId" and "usersRoles" keys. 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)
obc - the comparator to order the roles (optionally null)
Returns:
the ordered range of the matching roles, ordered by obc
Throws:
SystemException - if a system exception occurred
See Also:
RoleFinder

search

public static List<Role> search(long companyId,
                                String name,
                                String description,
                                Integer[] types,
                                int start,
                                int end,
                                OrderByComparator obc)
                         throws SystemException
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)
obc - the comparator to order the roles (optionally null)
Returns:
the ordered range of the matching roles, ordered by obc
Throws:
SystemException - if a system exception occurred
See Also:
RoleFinder

search

public static List<Role> search(long companyId,
                                String name,
                                String description,
                                Integer[] types,
                                LinkedHashMap<String,Object> params,
                                int start,
                                int end,
                                OrderByComparator obc)
                         throws SystemException
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 "permissionsResourceId" and "usersRoles" keys. 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)
obc - the comparator to order the roles (optionally null)
Returns:
the ordered range of the matching roles, ordered by obc
Throws:
SystemException - if a system exception occurred
See Also:
RoleFinder

searchCount

public static int searchCount(long companyId,
                              String keywords,
                              Integer[] types)
                       throws SystemException
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
Throws:
SystemException - if a system exception occurred

searchCount

public static int searchCount(long companyId,
                              String keywords,
                              Integer[] types,
                              LinkedHashMap<String,Object> params)
                       throws SystemException
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
Throws:
SystemException - if a system exception occurred

searchCount

public static int searchCount(long companyId,
                              String name,
                              String description,
                              Integer[] types)
                       throws SystemException
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
Throws:
SystemException - if a system exception occurred

searchCount

public static int searchCount(long companyId,
                              String name,
                              String description,
                              Integer[] types,
                              LinkedHashMap<String,Object> params)
                       throws SystemException
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 "permissionsResourceId" and "usersRoles" keys. For more information, see RoleFinder
Returns:
the number of matching roles
Throws:
SystemException - if a system exception occurred

setUserRoles

public static void setUserRoles(long userId,
                                long[] roleIds)
                         throws PortalException,
                                SystemException
Sets the roles associated with the user, replacing the user's existing roles. The user is reindexed after the roles are set.

Parameters:
userId - the primary key of the user
roleIds - the primary keys of the roles
Throws:
PortalException - if a user with the primary could not be found or if any one of the roles with the primary keys could not be found
SystemException - if a system exception occurred

unsetUserRoles

public static void unsetUserRoles(long userId,
                                  long[] roleIds)
                           throws PortalException,
                                  SystemException
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 - 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 found
SystemException - if a system exception occurred

updateRole

public static Role updateRole(long roleId,
                              String name,
                              Map<Locale,String> titleMap,
                              Map<Locale,String> descriptionMap,
                              String subtype)
                       throws PortalException,
                              SystemException
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)
Returns:
the role with the primary key
Throws:
PortalException - if a role with the primary could not be found or if the role's name was invalid
SystemException - if a system exception occurred

getService

public static RoleLocalService getService()

setService

public void setService(RoleLocalService service)

Liferay 6.1.10-ee-ga1