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, int type)
           
 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)
           
 Role updateRole(long roleId, java.lang.String name)
           
 

Method Detail

addRole

public Role addRole(java.lang.String name,
                    int type)
             throws com.liferay.portal.SystemException,
                    com.liferay.portal.PortalException,
                    java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

deleteRole

public void deleteRole(long roleId)
                throws com.liferay.portal.SystemException,
                       com.liferay.portal.PortalException,
                       java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

getGroupRole

public Role getGroupRole(long companyId,
                         long groupId)
                  throws com.liferay.portal.SystemException,
                         com.liferay.portal.PortalException,
                         java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

getGroupRoles

public java.util.List getGroupRoles(long groupId)
                             throws com.liferay.portal.SystemException,
                                    com.liferay.portal.PortalException,
                                    java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

getRole

public Role getRole(long roleId)
             throws com.liferay.portal.SystemException,
                    com.liferay.portal.PortalException,
                    java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

getRole

public Role getRole(long companyId,
                    java.lang.String name)
             throws com.liferay.portal.SystemException,
                    com.liferay.portal.PortalException,
                    java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

getUserGroupRoles

public java.util.List getUserGroupRoles(long userId,
                                        long groupId)
                                 throws com.liferay.portal.SystemException,
                                        com.liferay.portal.PortalException,
                                        java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

getUserRelatedRoles

public java.util.List getUserRelatedRoles(long userId,
                                          java.util.List groups)
                                   throws com.liferay.portal.SystemException,
                                          com.liferay.portal.PortalException,
                                          java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

getUserRoles

public java.util.List getUserRoles(long userId)
                            throws com.liferay.portal.SystemException,
                                   com.liferay.portal.PortalException,
                                   java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

hasUserRole

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

hasUserRoles

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

updateRole

public Role updateRole(long roleId,
                       java.lang.String name)
                throws com.liferay.portal.SystemException,
                       com.liferay.portal.PortalException,
                       java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException