com.liferay.portal.service
Interface RoleService

@Transactional(rollbackFor={com.liferay.portal.PortalException.class,com.liferay.portal.SystemException.class})
public interface RoleService

View Source

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

This interface defines the service. The default implementation is com.liferay.portal.service.impl.RoleServiceImpl. Modify methods in that class and rerun ServiceBuilder to populate this class and all other generated classes.

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

RoleServiceUtil

Method Summary

Role	addRole(java.lang.String name, java.lang.String description, int type)
void	addUserRoles(long userId, long[] roleIds)
void	deleteRole(long roleId)
Role	getGroupRole(long companyId, long groupId)
java.util.List<Role>	getGroupRoles(long groupId)
Role	getRole(long roleId)
Role	getRole(long companyId, java.lang.String name)
java.util.List<Role>	getUserGroupRoles(long userId, long groupId)
java.util.List<Role>	getUserRelatedRoles(long userId, java.util.List<Group> groups)
java.util.List<Role>	getUserRoles(long userId)
boolean	hasUserRole(long userId, long companyId, java.lang.String name, boolean inherited)
boolean	hasUserRoles(long userId, long companyId, java.lang.String[] names, boolean inherited)
void	unsetUserRoles(long userId, long[] roleIds)
Role	updateRole(long roleId, java.lang.String name, java.util.Map<java.util.Locale,java.lang.String> localeTitlesMap, java.lang.String description, java.lang.String subtype)

Method Detail

addRole

Role addRole(java.lang.String name,
             java.lang.String description,
             int type)
             throws com.liferay.portal.PortalException,
                    com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

addUserRoles

void addUserRoles(long userId,
                  long[] roleIds)
                  throws com.liferay.portal.PortalException,
                         com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

deleteRole

void deleteRole(long roleId)
                throws com.liferay.portal.PortalException,
                       com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getGroupRole

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Role getGroupRole(long companyId,
                                long groupId)
                  throws com.liferay.portal.PortalException,
                         com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getGroupRoles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Role> getGroupRoles(long groupId)
                                   throws com.liferay.portal.SystemException

Throws:

com.liferay.portal.SystemException

getRole

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Role getRole(long roleId)
             throws com.liferay.portal.PortalException,
                    com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getRole

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Role getRole(long companyId,
                           java.lang.String name)
             throws com.liferay.portal.PortalException,
                    com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getUserGroupRoles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Role> getUserGroupRoles(long userId,
                                                     long groupId)
                                       throws com.liferay.portal.SystemException

Throws:

com.liferay.portal.SystemException

getUserRelatedRoles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Role> getUserRelatedRoles(long userId,
                                                       java.util.List<Group> groups)
                                         throws com.liferay.portal.SystemException

Throws:

com.liferay.portal.SystemException

getUserRoles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Role> getUserRoles(long userId)
                                  throws com.liferay.portal.SystemException

Throws:

com.liferay.portal.SystemException

hasUserRole

boolean hasUserRole(long userId,
                    long companyId,
                    java.lang.String name,
                    boolean inherited)
                    throws com.liferay.portal.PortalException,
                           com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

hasUserRoles

boolean hasUserRoles(long userId,
                     long companyId,
                     java.lang.String[] names,
                     boolean inherited)
                     throws com.liferay.portal.PortalException,
                            com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

unsetUserRoles

void unsetUserRoles(long userId,
                    long[] roleIds)
                    throws com.liferay.portal.PortalException,
                           com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

updateRole

Role updateRole(long roleId,
                java.lang.String name,
                java.util.Map<java.util.Locale,java.lang.String> localeTitlesMap,
                java.lang.String description,
                java.lang.String subtype)
                throws com.liferay.portal.PortalException,
                       com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException