com.liferay.portal.service
Class RoleLocalServiceUtil

java.lang.Object
  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.

Never modify this class directly. Add custom service methods to RoleLocalServiceImpl and rerun ServiceBuilder to regenerate this class.

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 is generated.

Constructor Summary

RoleLocalServiceUtil()

Method Summary

static Role	addRole(long userId, long companyId, String name, Map<Locale,String> titleMap, String description, int type)
static Role	addRole(long userId, long companyId, String name, Map<Locale,String> titleMap, String description, int type, String className, long classPK)
static Role	addRole(Role role) Adds the role to the database.
static void	addUserRoles(long userId, long[] roleIds)
static void	checkSystemRoles(long companyId)
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) Counts the number of rows that match the dynamic query.
static Role	getDefaultGroupRole(long groupId)
static List<Role>	getGroupRoles(long groupId)
static Map<String,List<String>>	getResourceRoles(long companyId, String name, int scope, String primKey)
static Role	getRole(long roleId) Gets the role with the primary key.
static Role	getRole(long companyId, String name)
static List<Role>	getRoles(int start, int end) Gets a range of all the roles.
static List<Role>	getRoles(int type, String subtype)
static List<Role>	getRoles(long companyId)
static List<Role>	getRoles(long[] roleIds)
static int	getRolesCount() Gets the number of roles.
static RoleLocalService	getService()
static List<Role>	getSubtypeRoles(String subtype)
static int	getSubtypeRolesCount(String subtype)
static Role	getTeamRole(long companyId, long teamId)
static List<Role>	getUserGroupGroupRoles(long userId, long groupId)
static List<Role>	getUserGroupRoles(long userId, long groupId)
static List<Role>	getUserRelatedRoles(long userId, List<Group> groups)
static List<Role>	getUserRelatedRoles(long userId, long groupId)
static List<Role>	getUserRelatedRoles(long userId, long[] groupIds)
static List<Role>	getUserRoles(long userId)
static boolean	hasUserRole(long userId, long roleId)
static boolean	hasUserRole(long userId, long companyId, String name, boolean inherited) Returns true if the user has the regular role.
static boolean	hasUserRoles(long userId, long companyId, String[] names, boolean inherited) Returns true if the user has any one of the specified regular roles.
static List<Role>	search(long companyId, String name, String description, Integer[] types, int start, int end, OrderByComparator obc)
static List<Role>	search(long companyId, String name, String description, Integer[] types, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator obc)
static int	searchCount(long companyId, String name, String description, Integer[] types)
static int	searchCount(long companyId, String name, String description, Integer[] types, LinkedHashMap<String,Object> params)
void	setService(RoleLocalService service)
static void	setUserRoles(long userId, long[] roleIds)
static void	unsetUserRoles(long userId, long[] roleIds)
static Role	updateRole(long roleId, String name, Map<Locale,String> titleMap, String description, String subtype)
static Role	updateRole(Role role) Updates the role in the database.
static Role	updateRole(Role role, boolean merge) Updates the role in the database.

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 to add

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 to delete

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 SystemException

Deletes the role from the database. Also notifies the appropriate model listeners.

Parameters:

role - the role to delete

Throws:

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 to search with

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 to search with

start - the lower bound of the range of model instances to return

end - the upper bound of the range of model instances to return (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 to search with

start - the lower bound of the range of model instances to return

end - the upper bound of the range of model instances to return (not inclusive)

orderByComparator - the comparator to order the results by

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException

Counts the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

getRole

public static Role getRole(long roleId)
                    throws PortalException,
                           SystemException

Gets the role with the primary key.

Parameters:

roleId - the primary key of the role to get

Returns:

the role

Throws:

PortalException - if a role with the primary key could not be found

SystemException - if a system exception occurred

getRoles

public static List<Role> getRoles(int start,
                                  int end)
                           throws SystemException

Gets 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 to return

end - the upper bound of the range of roles to return (not inclusive)

Returns:

the range of roles

Throws:

SystemException - if a system exception occurred

getRolesCount

public static int getRolesCount()
                         throws SystemException

Gets 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. Also notifies the appropriate model listeners.

Parameters:

role - the role to update

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. Also notifies the appropriate model listeners.

Parameters:

role - the role to update

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

addRole

public static Role addRole(long userId,
                           long companyId,
                           String name,
                           Map<Locale,String> titleMap,
                           String description,
                           int type)
                    throws PortalException,
                           SystemException

Throws:

PortalException

SystemException

addRole

public static Role addRole(long userId,
                           long companyId,
                           String name,
                           Map<Locale,String> titleMap,
                           String description,
                           int type,
                           String className,
                           long classPK)
                    throws PortalException,
                           SystemException

Throws:

PortalException

SystemException

addUserRoles

public static void addUserRoles(long userId,
                                long[] roleIds)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

checkSystemRoles

public static void checkSystemRoles(long companyId)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

getDefaultGroupRole

public static Role getDefaultGroupRole(long groupId)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

getGroupRoles

public static List<Role> getGroupRoles(long groupId)
                                throws SystemException

Throws:

SystemException

getResourceRoles

public static Map<String,List<String>> getResourceRoles(long companyId,
                                                        String name,
                                                        int scope,
                                                        String primKey)
                                                 throws SystemException

Throws:

SystemException

getRole

public static Role getRole(long companyId,
                           String name)
                    throws PortalException,
                           SystemException

Throws:

PortalException

SystemException

getRoles

public static List<Role> getRoles(long companyId)
                           throws SystemException

Throws:

SystemException

getRoles

public static List<Role> getRoles(long[] roleIds)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

getRoles

public static List<Role> getRoles(int type,
                                  String subtype)
                           throws SystemException

Throws:

SystemException

getSubtypeRoles

public static List<Role> getSubtypeRoles(String subtype)
                                  throws SystemException

Throws:

SystemException

getSubtypeRolesCount

public static int getSubtypeRolesCount(String subtype)
                                throws SystemException

Throws:

SystemException

getTeamRole

public static Role getTeamRole(long companyId,
                               long teamId)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

getUserGroupGroupRoles

public static List<Role> getUserGroupGroupRoles(long userId,
                                                long groupId)
                                         throws SystemException

Throws:

SystemException

getUserGroupRoles

public static List<Role> getUserGroupRoles(long userId,
                                           long groupId)
                                    throws SystemException

Throws:

SystemException

getUserRelatedRoles

public static List<Role> getUserRelatedRoles(long userId,
                                             long groupId)
                                      throws SystemException

Throws:

SystemException

getUserRelatedRoles

public static List<Role> getUserRelatedRoles(long userId,
                                             long[] groupIds)
                                      throws SystemException

Throws:

SystemException

getUserRelatedRoles

public static List<Role> getUserRelatedRoles(long userId,
                                             List<Group> groups)
                                      throws SystemException

Throws:

SystemException

getUserRoles

public static List<Role> getUserRoles(long userId)
                               throws SystemException

Throws:

SystemException

hasUserRole

public static boolean hasUserRole(long userId,
                                  long roleId)
                           throws SystemException

Throws:

SystemException

hasUserRole

public static boolean hasUserRole(long userId,
                                  long companyId,
                                  String name,
                                  boolean inherited)
                           throws PortalException,
                                  SystemException

Returns true if the user has the regular role.

Returns:

true if the user has the regular role

Throws:

PortalException

SystemException

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 specified regular roles.

Returns:

true if the user has the regular role

Throws:

PortalException

SystemException

search

public static List<Role> search(long companyId,
                                String name,
                                String description,
                                Integer[] types,
                                int start,
                                int end,
                                OrderByComparator obc)
                         throws SystemException

Throws:

SystemException

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

Throws:

SystemException

searchCount

public static int searchCount(long companyId,
                              String name,
                              String description,
                              Integer[] types)
                       throws SystemException

Throws:

SystemException

searchCount

public static int searchCount(long companyId,
                              String name,
                              String description,
                              Integer[] types,
                              LinkedHashMap<String,Object> params)
                       throws SystemException

Throws:

SystemException

setUserRoles

public static void setUserRoles(long userId,
                                long[] roleIds)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

unsetUserRoles

public static void unsetUserRoles(long userId,
                                  long[] roleIds)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

updateRole

public static Role updateRole(long roleId,
                              String name,
                              Map<Locale,String> titleMap,
                              String description,
                              String subtype)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

getService

public static RoleLocalService getService()

setService

public void setService(RoleLocalService service)