com.liferay.portal.service
Interface RoleService
- 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:
RoleServiceFactory
,
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 |
getGroupRoles(long groupId)
|
Role |
getRole(long roleId)
|
Role |
getRole(long companyId,
java.lang.String name)
|
java.util.List |
getUserGroupRoles(long userId,
long groupId)
|
java.util.List |
getUserRelatedRoles(long userId,
java.util.List groups)
|
java.util.List |
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.lang.String description)
|
addRole
public Role addRole(java.lang.String name,
java.lang.String description,
int type)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
addUserRoles
public void addUserRoles(long userId,
long[] roleIds)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
deleteRole
public void deleteRole(long roleId)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
getGroupRole
public Role getGroupRole(long companyId,
long groupId)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
getGroupRoles
public java.util.List getGroupRoles(long groupId)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
getRole
public Role getRole(long roleId)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
getRole
public Role getRole(long companyId,
java.lang.String name)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
getUserGroupRoles
public java.util.List getUserGroupRoles(long userId,
long groupId)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
getUserRelatedRoles
public java.util.List getUserRelatedRoles(long userId,
java.util.List groups)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
getUserRoles
public java.util.List getUserRoles(long userId)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
hasUserRole
public boolean hasUserRole(long userId,
long companyId,
java.lang.String name,
boolean inherited)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
hasUserRoles
public boolean hasUserRoles(long userId,
long companyId,
java.lang.String[] names,
boolean inherited)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
unsetUserRoles
public void unsetUserRoles(long userId,
long[] roleIds)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
updateRole
public Role updateRole(long roleId,
java.lang.String name,
java.lang.String description)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException