com.liferay.portal.service
Interface RoleLocalService


public interface RoleLocalService

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.RoleLocalServiceImpl. Modify methods in that class and rerun ServiceBuilder to populate this class and all other generated classes.

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.

Author:
Brian Wing Shun Chan
See Also:
RoleLocalServiceFactory, RoleLocalServiceUtil

Method Summary
 Role addRole(long userId, long companyId, java.lang.String name, java.lang.String description, int type)
           
 Role addRole(long userId, long companyId, java.lang.String name, java.lang.String description, int type, java.lang.String className, long classPK)
           
 Role addRole(Role role)
           
 void addUserRoles(long userId, long[] roleIds)
           
 void checkSystemRoles(long companyId)
           
 void deleteRole(long roleId)
           
 void deleteRole(Role role)
           
 java.util.List<Role> dynamicQuery(com.liferay.portal.kernel.dao.DynamicQueryInitializer queryInitializer)
           
 java.util.List<Role> dynamicQuery(com.liferay.portal.kernel.dao.DynamicQueryInitializer queryInitializer, int begin, int end)
           
 Role getGroupRole(long companyId, long groupId)
           
 java.util.List<Role> getGroupRoles(long groupId)
           
 java.util.Map<java.lang.String,java.util.List<java.lang.String>> getResourceRoles(long companyId, java.lang.String name, int scope, java.lang.String primKey)
           
 Role getRole(long roleId)
           
 Role getRole(long companyId, java.lang.String name)
           
 java.util.List<Role> getRoles(long companyId)
           
 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> getUserRelatedRoles(long userId, long groupId)
           
 java.util.List<Role> getUserRelatedRoles(long userId, long[] groupIds)
           
 java.util.List<Role> getUserRoles(long userId)
           
 boolean hasUserRole(long userId, long roleId)
           
 boolean hasUserRole(long userId, long companyId, java.lang.String name, boolean inherited)
           
 boolean hasUserRoles(long userId, long companyId, java.lang.String[] names, boolean inherited)
           
 java.util.List<Role> search(long companyId, java.lang.String name, java.lang.String description, java.lang.Integer type, int begin, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
           
 java.util.List<Role> search(long companyId, java.lang.String name, java.lang.String description, java.lang.Integer type, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int begin, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
           
 int searchCount(long companyId, java.lang.String name, java.lang.String description, java.lang.Integer type)
           
 int searchCount(long companyId, java.lang.String name, java.lang.String description, java.lang.Integer type, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)
           
 void setUserRoles(long userId, long[] roleIds)
           
 void unsetUserRoles(long userId, long[] roleIds)
           
 Role updateRole(long roleId, java.lang.String name, java.lang.String description)
           
 Role updateRole(Role role)
           
 

Method Detail

addRole

Role addRole(Role role)
             throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

deleteRole

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

deleteRole

void deleteRole(Role role)
                throws com.liferay.portal.SystemException,
                       com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

dynamicQuery

java.util.List<Role> dynamicQuery(com.liferay.portal.kernel.dao.DynamicQueryInitializer queryInitializer)
                                  throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

dynamicQuery

java.util.List<Role> dynamicQuery(com.liferay.portal.kernel.dao.DynamicQueryInitializer queryInitializer,
                                  int begin,
                                  int end)
                                  throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

updateRole

Role updateRole(Role role)
                throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

addRole

Role addRole(long userId,
             long companyId,
             java.lang.String name,
             java.lang.String description,
             int type)
             throws com.liferay.portal.SystemException,
                    com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

addRole

Role addRole(long userId,
             long companyId,
             java.lang.String name,
             java.lang.String description,
             int type,
             java.lang.String className,
             long classPK)
             throws com.liferay.portal.SystemException,
                    com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

addUserRoles

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

checkSystemRoles

void checkSystemRoles(long companyId)
                      throws com.liferay.portal.SystemException,
                             com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

getGroupRole

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

getGroupRoles

java.util.List<Role> getGroupRoles(long groupId)
                                   throws com.liferay.portal.SystemException,
                                          com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

getResourceRoles

java.util.Map<java.lang.String,java.util.List<java.lang.String>> getResourceRoles(long companyId,
                                                                                  java.lang.String name,
                                                                                  int scope,
                                                                                  java.lang.String primKey)
                                                                                  throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

getRole

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

getRole

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

getRoles

java.util.List<Role> getRoles(long companyId)
                              throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

getUserGroupRoles

java.util.List<Role> getUserGroupRoles(long userId,
                                       long groupId)
                                       throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

getUserRelatedRoles

java.util.List<Role> getUserRelatedRoles(long userId,
                                         long groupId)
                                         throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

getUserRelatedRoles

java.util.List<Role> getUserRelatedRoles(long userId,
                                         long[] groupIds)
                                         throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

getUserRelatedRoles

java.util.List<Role> getUserRelatedRoles(long userId,
                                         java.util.List<Group> groups)
                                         throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

getUserRoles

java.util.List<Role> getUserRoles(long userId)
                                  throws com.liferay.portal.SystemException,
                                         com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

hasUserRole

boolean hasUserRole(long userId,
                    long roleId)
                    throws com.liferay.portal.SystemException,
                           com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

hasUserRole

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

hasUserRoles

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

search

java.util.List<Role> search(long companyId,
                            java.lang.String name,
                            java.lang.String description,
                            java.lang.Integer type,
                            int begin,
                            int end,
                            com.liferay.portal.kernel.util.OrderByComparator obc)
                            throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

search

java.util.List<Role> search(long companyId,
                            java.lang.String name,
                            java.lang.String description,
                            java.lang.Integer type,
                            java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                            int begin,
                            int end,
                            com.liferay.portal.kernel.util.OrderByComparator obc)
                            throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

searchCount

int searchCount(long companyId,
                java.lang.String name,
                java.lang.String description,
                java.lang.Integer type)
                throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

searchCount

int searchCount(long companyId,
                java.lang.String name,
                java.lang.String description,
                java.lang.Integer type,
                java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)
                throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

setUserRoles

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

unsetUserRoles

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

updateRole

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