Liferay 7.0-ce-b4

com.liferay.portal.service
Class RoleLocalServiceWrapper

java.lang.Object
  extended by com.liferay.portal.service.RoleLocalServiceWrapper
All Implemented Interfaces:
BaseLocalService, PersistedModelLocalService, RoleLocalService, ServiceWrapper<RoleLocalService>

@ProviderType
public class RoleLocalServiceWrapper
extends Object
implements RoleLocalService, ServiceWrapper<RoleLocalService>

Provides a wrapper for RoleLocalService.

See Also:
RoleLocalService

Constructor Summary
RoleLocalServiceWrapper(RoleLocalService roleLocalService)
           
 
Method Summary
 void addGroupRole(long groupId, long roleId)
           
 void addGroupRole(long groupId, Role role)
           
 void addGroupRoles(long groupId, List<Role> Roles)
           
 void addGroupRoles(long groupId, long[] roleIds)
           
 Role addRole(long userId, long companyId, String name, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, int type)
          Deprecated. As of 6.2.0, replaced by addRole(long, String, long, String, Map, Map, int, String, ServiceContext)
 Role addRole(long userId, long companyId, String name, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, int type, String className, long classPK)
          Deprecated. As of 6.2.0, replaced by addRole(long, String, long, String, Map, Map, int, String, ServiceContext)
 Role addRole(long userId, String className, long classPK, String name, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, int type, String subtype, ServiceContext serviceContext)
          Adds a role with additional parameters.
 Role addRole(Role role)
          Adds the role to the database.
 void addUserRole(long userId, long roleId)
           
 void addUserRole(long userId, Role role)
           
 void addUserRoles(long userId, List<Role> Roles)
           
 void addUserRoles(long userId, long[] roleIds)
           
 void checkSystemRoles()
          Checks to ensure that the system roles map has appropriate default roles in each company.
 void checkSystemRoles(long companyId)
          Checks to ensure that the system roles map has appropriate default roles in the company.
 void clearGroupRoles(long groupId)
           
 void clearUserRoles(long userId)
           
 Role createRole(long roleId)
          Creates a new role with the primary key.
 void deleteGroupRole(long groupId, long roleId)
           
 void deleteGroupRole(long groupId, Role role)
           
 void deleteGroupRoles(long groupId, List<Role> Roles)
           
 void deleteGroupRoles(long groupId, long[] roleIds)
           
 PersistedModel deletePersistedModel(PersistedModel persistedModel)
           
 Role deleteRole(long roleId)
          Deletes the role with the primary key from the database.
 Role deleteRole(Role role)
          Deletes the role from the database.
 void deleteUserRole(long userId, long roleId)
           
 void deleteUserRole(long userId, Role role)
           
 void deleteUserRoles(long userId, List<Role> Roles)
           
 void deleteUserRoles(long userId, long[] roleIds)
           
 DynamicQuery dynamicQuery()
           
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator)
          Performs a dynamic query on the database and returns an ordered range of the matching rows.
 long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows matching the dynamic query.
 long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows matching the dynamic query.
 Role fetchRole(long roleId)
           
 Role fetchRole(long companyId, String name)
          Returns the role with the name in the company.
 Role fetchRoleByUuidAndCompanyId(String uuid, long companyId)
          Returns the role with the matching UUID and company.
 ActionableDynamicQuery getActionableDynamicQuery()
           
 Role getDefaultGroupRole(long groupId)
          Returns the default role for the group with the primary key.
 ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
           
 long[] getGroupPrimaryKeys(long roleId)
          Returns the groupIds of the groups associated with the role.
 List<Role> getGroupRelatedRoles(long groupId)
           
 List<Role> getGroupRoles(long groupId)
           
 List<Role> getGroupRoles(long groupId, int start, int end)
           
 List<Role> getGroupRoles(long groupId, int start, int end, OrderByComparator<Role> orderByComparator)
           
 int getGroupRolesCount(long groupId)
           
 IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
           
 String getOSGiServiceIdentifier()
          Returns the OSGi service identifier.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 List<Role> getResourceBlockRoles(long resourceBlockId, String className, String actionId)
           
 Map<String,List<String>> getResourceRoles(long companyId, String name, int scope, String primKey)
          Returns a map of role names to associated action IDs for the named resource in the company within the permission scope.
 List<Role> getResourceRoles(long companyId, String name, int scope, String primKey, String actionId)
          Returns all the roles associated with the action ID in the company within the permission scope.
 Role getRole(long roleId)
          Returns the role with the primary key.
 Role getRole(long companyId, String name)
          Returns the role with the name in the company.
 Role getRoleByUuidAndCompanyId(String uuid, long companyId)
          Returns the role with the matching UUID and company.
 List<Role> getRoles(int start, int end)
          Returns a range of all the roles.
 List<Role> getRoles(int type, String subtype)
          Returns all the roles of the type and subtype.
 List<Role> getRoles(long companyId)
          Returns all the roles in the company.
 List<Role> getRoles(long[] roleIds)
          Returns all the roles with the primary keys.
 List<Role> getRoles(long companyId, int[] types)
          Returns all the roles with the types.
 int getRolesCount()
          Returns the number of roles.
 List<Role> getSubtypeRoles(String subtype)
          Returns all the roles of the subtype.
 int getSubtypeRolesCount(String subtype)
          Returns the number of roles of the subtype.
 Role getTeamRole(long companyId, long teamId)
          Returns the team role in the company.
 Map<Team,Role> getTeamRoleMap(long groupId)
          Returns the team role map for the group.
 List<Role> getTeamRoles(long groupId)
          Returns the team roles in the group.
 List<Role> getTeamRoles(long groupId, long[] excludedRoleIds)
          Returns the team roles in the group, excluding the specified role IDs.
 List<Role> getTypeRoles(int type)
          Returns all the roles of the type.
 List<Role> getTypeRoles(int type, int start, int end)
          Returns a range of all the roles of the type.
 int getTypeRolesCount(int type)
          Returns the number of roles of the type.
 List<Role> getUserGroupGroupRoles(long userId, long groupId)
          Returns all the user's roles within the user group.
 List<Role> getUserGroupGroupRoles(long userId, long groupId, int start, int end)
           
 int getUserGroupGroupRolesCount(long userId, long groupId)
           
 List<Role> getUserGroupRoles(long userId, long groupId)
          Returns all the user's roles within the user group.
 long[] getUserPrimaryKeys(long roleId)
          Returns the userIds of the users associated with the role.
 List<Role> getUserRelatedRoles(long userId, List<Group> groups)
          Returns the union of all the user's roles within the groups.
 List<Role> getUserRelatedRoles(long userId, long groupId)
          Returns all the user's roles within the group.
 List<Role> getUserRelatedRoles(long userId, long[] groupIds)
          Returns the union of all the user's roles within the groups.
 List<Role> getUserRoles(long userId)
           
 List<Role> getUserRoles(long userId, int start, int end)
           
 List<Role> getUserRoles(long userId, int start, int end, OrderByComparator<Role> orderByComparator)
           
 int getUserRolesCount(long userId)
           
 RoleLocalService getWrappedService()
           
 boolean hasGroupRole(long groupId, long roleId)
           
 boolean hasGroupRoles(long groupId)
           
 boolean hasUserRole(long userId, long roleId)
           
 boolean hasUserRole(long userId, long companyId, String name, boolean inherited)
          Returns true if the user is associated with the named regular role.
 boolean hasUserRoles(long userId)
           
 boolean hasUserRoles(long userId, long companyId, String[] names, boolean inherited)
          Returns true if the user has any one of the named regular roles.
 Role loadFetchRole(long companyId, String name)
          Returns a role with the name in the company.
 Role loadGetRole(long companyId, String name)
          Returns a role with the name in the company.
 List<Role> search(long companyId, String keywords, Integer[] types, int start, int end, OrderByComparator<Role> obc)
          Returns an ordered range of all the roles that match the keywords and types.
 List<Role> search(long companyId, String keywords, Integer[] types, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator<Role> obc)
          Returns an ordered range of all the roles that match the keywords, types, and params.
 List<Role> search(long companyId, String name, String description, Integer[] types, int start, int end, OrderByComparator<Role> obc)
          Returns an ordered range of all the roles that match the name, description, and types.
 List<Role> search(long companyId, String name, String description, Integer[] types, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator<Role> obc)
          Returns an ordered range of all the roles that match the name, description, types, and params.
 int searchCount(long companyId, String keywords, Integer[] types)
          Returns the number of roles that match the keywords and types.
 int searchCount(long companyId, String keywords, Integer[] types, LinkedHashMap<String,Object> params)
          Returns the number of roles that match the keywords, types and params.
 int searchCount(long companyId, String name, String description, Integer[] types)
          Returns the number of roles that match the name, description, and types.
 int searchCount(long companyId, String name, String description, Integer[] types, LinkedHashMap<String,Object> params)
          Returns the number of roles that match the name, description, types, and params.
 void setGroupRoles(long groupId, long[] roleIds)
           
 void setUserRoles(long userId, long[] roleIds)
           
 void setWrappedService(RoleLocalService roleLocalService)
           
 void unsetUserRoles(long userId, long[] roleIds)
          Removes the matching roles associated with the user.
 Role updateRole(long roleId, String name, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String subtype, ServiceContext serviceContext)
          Updates the role with the primary key.
 Role updateRole(Role role)
          Updates the role in the database or adds it if it does not yet exist.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RoleLocalServiceWrapper

public RoleLocalServiceWrapper(RoleLocalService roleLocalService)
Method Detail

addGroupRole

public void addGroupRole(long groupId,
                         Role role)
Specified by:
addGroupRole in interface RoleLocalService

addGroupRole

public void addGroupRole(long groupId,
                         long roleId)
Specified by:
addGroupRole in interface RoleLocalService

addGroupRoles

public void addGroupRoles(long groupId,
                          List<Role> Roles)
Specified by:
addGroupRoles in interface RoleLocalService

addGroupRoles

public void addGroupRoles(long groupId,
                          long[] roleIds)
Specified by:
addGroupRoles in interface RoleLocalService

addRole

public Role addRole(Role role)
Adds the role to the database. Also notifies the appropriate model listeners.

Specified by:
addRole in interface RoleLocalService
Parameters:
role - the role
Returns:
the role that was added

addRole

public Role addRole(long userId,
                    String className,
                    long classPK,
                    String name,
                    Map<Locale,String> titleMap,
                    Map<Locale,String> descriptionMap,
                    int type,
                    String subtype,
                    ServiceContext serviceContext)
             throws PortalException
Adds a role with additional parameters. The user is reindexed after role is added.

Specified by:
addRole in interface RoleLocalService
Parameters:
userId - the primary key of the user
className - the name of the class for which the role is created (optionally null)
classPK - the primary key of the class for which the role is created (optionally 0)
name - the role's name
titleMap - the role's localized titles (optionally null)
descriptionMap - the role's localized descriptions (optionally null)
type - the role's type (optionally 0)
subtype - the role's subtype (optionally null)
serviceContext - the service context to be applied (optionally null). Can set expando bridge attributes for the role.
Returns:
the role
Throws:
PortalException

addRole

@Deprecated
public Role addRole(long userId,
                               long companyId,
                               String name,
                               Map<Locale,String> titleMap,
                               Map<Locale,String> descriptionMap,
                               int type)
             throws PortalException
Deprecated. As of 6.2.0, replaced by addRole(long, String, long, String, Map, Map, int, String, ServiceContext)

Adds a role. The user is reindexed after role is added.

Specified by:
addRole in interface RoleLocalService
Parameters:
userId - the primary key of the user
companyId - the primary key of the company
name - the role's name
titleMap - the role's localized titles (optionally null)
descriptionMap - the role's localized descriptions (optionally null)
type - the role's type (optionally 0)
Returns:
the role
Throws:
PortalException

addRole

@Deprecated
public Role addRole(long userId,
                               long companyId,
                               String name,
                               Map<Locale,String> titleMap,
                               Map<Locale,String> descriptionMap,
                               int type,
                               String className,
                               long classPK)
             throws PortalException
Deprecated. As of 6.2.0, replaced by addRole(long, String, long, String, Map, Map, int, String, ServiceContext)

Adds a role with additional parameters. The user is reindexed after role is added.

Specified by:
addRole in interface RoleLocalService
Parameters:
userId - the primary key of the user
companyId - the primary key of the company
name - the role's name
titleMap - the role's localized titles (optionally null)
descriptionMap - the role's localized descriptions (optionally null)
type - the role's type (optionally 0)
className - the name of the class for which the role is created (optionally null)
classPK - the primary key of the class for which the role is created (optionally 0)
Returns:
the role
Throws:
PortalException

addUserRole

public void addUserRole(long userId,
                        Role role)
Specified by:
addUserRole in interface RoleLocalService

addUserRole

public void addUserRole(long userId,
                        long roleId)
Specified by:
addUserRole in interface RoleLocalService

addUserRoles

public void addUserRoles(long userId,
                         List<Role> Roles)
                  throws PortalException
Specified by:
addUserRoles in interface RoleLocalService
Throws:
PortalException

addUserRoles

public void addUserRoles(long userId,
                         long[] roleIds)
                  throws PortalException
Specified by:
addUserRoles in interface RoleLocalService
Throws:
PortalException

checkSystemRoles

public void checkSystemRoles()
                      throws PortalException
Checks to ensure that the system roles map has appropriate default roles in each company.

Specified by:
checkSystemRoles in interface RoleLocalService
Throws:
PortalException

checkSystemRoles

public void checkSystemRoles(long companyId)
                      throws PortalException
Checks to ensure that the system roles map has appropriate default roles in the company.

Specified by:
checkSystemRoles in interface RoleLocalService
Parameters:
companyId - the primary key of the company
Throws:
PortalException

clearGroupRoles

public void clearGroupRoles(long groupId)
Specified by:
clearGroupRoles in interface RoleLocalService

clearUserRoles

public void clearUserRoles(long userId)
Specified by:
clearUserRoles in interface RoleLocalService

createRole

public Role createRole(long roleId)
Creates a new role with the primary key. Does not add the role to the database.

Specified by:
createRole in interface RoleLocalService
Parameters:
roleId - the primary key for the new role
Returns:
the new role

deleteGroupRole

public void deleteGroupRole(long groupId,
                            Role role)
Specified by:
deleteGroupRole in interface RoleLocalService

deleteGroupRole

public void deleteGroupRole(long groupId,
                            long roleId)
Specified by:
deleteGroupRole in interface RoleLocalService

deleteGroupRoles

public void deleteGroupRoles(long groupId,
                             List<Role> Roles)
Specified by:
deleteGroupRoles in interface RoleLocalService

deleteGroupRoles

public void deleteGroupRoles(long groupId,
                             long[] roleIds)
Specified by:
deleteGroupRoles in interface RoleLocalService

deletePersistedModel

public PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                    throws PortalException
Specified by:
deletePersistedModel in interface PersistedModelLocalService
Specified by:
deletePersistedModel in interface RoleLocalService
Throws:
PortalException

deleteRole

public Role deleteRole(Role role)
                throws PortalException
Deletes the role from the database. Also notifies the appropriate model listeners.

Specified by:
deleteRole in interface RoleLocalService
Parameters:
role - the role
Returns:
the role that was removed
Throws:
PortalException

deleteRole

public Role deleteRole(long roleId)
                throws PortalException
Deletes the role with the primary key from the database. Also notifies the appropriate model listeners.

Specified by:
deleteRole in interface RoleLocalService
Parameters:
roleId - the primary key of the role
Returns:
the role that was removed
Throws:
PortalException - if a role with the primary key could not be found

deleteUserRole

public void deleteUserRole(long userId,
                           Role role)
Specified by:
deleteUserRole in interface RoleLocalService

deleteUserRole

public void deleteUserRole(long userId,
                           long roleId)
Specified by:
deleteUserRole in interface RoleLocalService

deleteUserRoles

public void deleteUserRoles(long userId,
                            List<Role> Roles)
Specified by:
deleteUserRoles in interface RoleLocalService

deleteUserRoles

public void deleteUserRoles(long userId,
                            long[] roleIds)
Specified by:
deleteUserRoles in interface RoleLocalService

dynamicQuery

public DynamicQuery dynamicQuery()
Specified by:
dynamicQuery in interface RoleLocalService

dynamicQuery

public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.

Specified by:
dynamicQuery in interface RoleLocalService
Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows

dynamicQuery

public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end)
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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from RoleModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Specified by:
dynamicQuery in interface RoleLocalService
Parameters:
dynamicQuery - the dynamic query
start - the lower bound of the range of model instances
end - the upper bound of the range of model instances (not inclusive)
Returns:
the range of matching rows

dynamicQuery

public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end,
                                OrderByComparator<T> orderByComparator)
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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from RoleModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Specified by:
dynamicQuery in interface RoleLocalService
Parameters:
dynamicQuery - the dynamic query
start - the lower bound of the range of model instances
end - the upper bound of the range of model instances (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of matching rows

dynamicQueryCount

public long dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query.

Specified by:
dynamicQueryCount in interface RoleLocalService
Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows matching the dynamic query

dynamicQueryCount

public long dynamicQueryCount(DynamicQuery dynamicQuery,
                              Projection projection)
Returns the number of rows matching the dynamic query.

Specified by:
dynamicQueryCount in interface RoleLocalService
Parameters:
dynamicQuery - the dynamic query
projection - the projection to apply to the query
Returns:
the number of rows matching the dynamic query

fetchRole

public Role fetchRole(long companyId,
                      String name)
Returns the role with the name in the company.

The method searches the system roles map first for default roles. If a role with the name is not found, then the method will query the database.

Specified by:
fetchRole in interface RoleLocalService
Parameters:
companyId - the primary key of the company
name - the role's name
Returns:
Returns the role with the name or null if a role with the name could not be found in the company

fetchRole

public Role fetchRole(long roleId)
Specified by:
fetchRole in interface RoleLocalService

fetchRoleByUuidAndCompanyId

public Role fetchRoleByUuidAndCompanyId(String uuid,
                                        long companyId)
Returns the role with the matching UUID and company.

Specified by:
fetchRoleByUuidAndCompanyId in interface RoleLocalService
Parameters:
uuid - the role's UUID
companyId - the primary key of the company
Returns:
the matching role, or null if a matching role could not be found

getActionableDynamicQuery

public ActionableDynamicQuery getActionableDynamicQuery()
Specified by:
getActionableDynamicQuery in interface RoleLocalService

getDefaultGroupRole

public Role getDefaultGroupRole(long groupId)
                         throws PortalException
Returns the default role for the group with the primary key.

If the group is a site, then the default role is RoleConstants#SITE_MEMBER. If the group is an organization, then the default role is RoleConstants#ORGANIZATION_USER. If the group is a user or user group, then the default role is RoleConstants#POWER_USER. For all other group types, the default role is RoleConstants#USER.

Specified by:
getDefaultGroupRole in interface RoleLocalService
Parameters:
groupId - the primary key of the group
Returns:
the default role for the group with the primary key
Throws:
PortalException

getExportActionableDynamicQuery

public ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
Specified by:
getExportActionableDynamicQuery in interface RoleLocalService

getGroupPrimaryKeys

public long[] getGroupPrimaryKeys(long roleId)
Returns the groupIds of the groups associated with the role.

Specified by:
getGroupPrimaryKeys in interface RoleLocalService
Parameters:
roleId - the roleId of the role
Returns:
long[] the groupIds of groups associated with the role

getGroupRelatedRoles

public List<Role> getGroupRelatedRoles(long groupId)
                                throws PortalException
Specified by:
getGroupRelatedRoles in interface RoleLocalService
Throws:
PortalException

getGroupRoles

public List<Role> getGroupRoles(long groupId)
Specified by:
getGroupRoles in interface RoleLocalService

getGroupRoles

public List<Role> getGroupRoles(long groupId,
                                int start,
                                int end)
Specified by:
getGroupRoles in interface RoleLocalService

getGroupRoles

public List<Role> getGroupRoles(long groupId,
                                int start,
                                int end,
                                OrderByComparator<Role> orderByComparator)
Specified by:
getGroupRoles in interface RoleLocalService

getGroupRolesCount

public int getGroupRolesCount(long groupId)
Specified by:
getGroupRolesCount in interface RoleLocalService

getIndexableActionableDynamicQuery

public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
Specified by:
getIndexableActionableDynamicQuery in interface RoleLocalService

getOSGiServiceIdentifier

public String getOSGiServiceIdentifier()
Returns the OSGi service identifier.

Specified by:
getOSGiServiceIdentifier in interface RoleLocalService
Returns:
the OSGi service identifier

getPersistedModel

public PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Specified by:
getPersistedModel in interface RoleLocalService
Throws:
PortalException

getResourceBlockRoles

public List<Role> getResourceBlockRoles(long resourceBlockId,
                                        String className,
                                        String actionId)
Specified by:
getResourceBlockRoles in interface RoleLocalService

getResourceRoles

public Map<String,List<String>> getResourceRoles(long companyId,
                                                 String name,
                                                 int scope,
                                                 String primKey)
Returns a map of role names to associated action IDs for the named resource in the company within the permission scope.

Specified by:
getResourceRoles in interface RoleLocalService
Parameters:
companyId - the primary key of the company
name - the resource name
scope - the permission scope
primKey - the primary key of the resource's class
Returns:
the role names and action IDs
See Also:
RoleFinder.findByC_N_S_P( long, String, int, String)

getResourceRoles

public List<Role> getResourceRoles(long companyId,
                                   String name,
                                   int scope,
                                   String primKey,
                                   String actionId)
Returns all the roles associated with the action ID in the company within the permission scope.

Specified by:
getResourceRoles in interface RoleLocalService
Parameters:
companyId - the primary key of the company
name - the resource name
scope - the permission scope
primKey - the primary key of the resource's class
actionId - the name of the resource action
Returns:
the roles
See Also:
RoleFinder.findByC_N_S_P_A( long, String, int, String, String)

getRole

public Role getRole(long companyId,
                    String name)
             throws PortalException
Returns the role with the name in the company.

The method searches the system roles map first for default roles. If a role with the name is not found, then the method will query the database.

Specified by:
getRole in interface RoleLocalService
Parameters:
companyId - the primary key of the company
name - the role's name
Returns:
the role with the name
Throws:
PortalException

getRole

public Role getRole(long roleId)
             throws PortalException
Returns the role with the primary key.

Specified by:
getRole in interface RoleLocalService
Parameters:
roleId - the primary key of the role
Returns:
the role
Throws:
PortalException - if a role with the primary key could not be found

getRoleByUuidAndCompanyId

public Role getRoleByUuidAndCompanyId(String uuid,
                                      long companyId)
                               throws PortalException
Returns the role with the matching UUID and company.

Specified by:
getRoleByUuidAndCompanyId in interface RoleLocalService
Parameters:
uuid - the role's UUID
companyId - the primary key of the company
Returns:
the matching role
Throws:
PortalException - if a matching role could not be found

getRoles

public List<Role> getRoles(long companyId)
Returns all the roles in the company.

Specified by:
getRoles in interface RoleLocalService
Parameters:
companyId - the primary key of the company
Returns:
the roles in the company

getRoles

public List<Role> getRoles(long companyId,
                           int[] types)
Returns all the roles with the types.

Specified by:
getRoles in interface RoleLocalService
Parameters:
companyId - the primary key of the company
types - the role types (optionally null)
Returns:
the roles with the types

getRoles

public List<Role> getRoles(long[] roleIds)
                    throws PortalException
Returns all the roles with the primary keys.

Specified by:
getRoles in interface RoleLocalService
Parameters:
roleIds - the primary keys of the roles
Returns:
the roles with the primary keys
Throws:
PortalException

getRoles

public List<Role> getRoles(int start,
                           int end)
Returns 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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from RoleModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Specified by:
getRoles in interface RoleLocalService
Parameters:
start - the lower bound of the range of roles
end - the upper bound of the range of roles (not inclusive)
Returns:
the range of roles

getRoles

public List<Role> getRoles(int type,
                           String subtype)
Returns all the roles of the type and subtype.

Specified by:
getRoles in interface RoleLocalService
Parameters:
type - the role's type (optionally 0)
subtype - the role's subtype (optionally null)
Returns:
the roles of the type and subtype

getRolesCount

public int getRolesCount()
Returns the number of roles.

Specified by:
getRolesCount in interface RoleLocalService
Returns:
the number of roles

getSubtypeRoles

public List<Role> getSubtypeRoles(String subtype)
Returns all the roles of the subtype.

Specified by:
getSubtypeRoles in interface RoleLocalService
Parameters:
subtype - the role's subtype (optionally null)
Returns:
the roles of the subtype

getSubtypeRolesCount

public int getSubtypeRolesCount(String subtype)
Returns the number of roles of the subtype.

Specified by:
getSubtypeRolesCount in interface RoleLocalService
Parameters:
subtype - the role's subtype (optionally null)
Returns:
the number of roles of the subtype

getTeamRole

public Role getTeamRole(long companyId,
                        long teamId)
                 throws PortalException
Returns the team role in the company.

Specified by:
getTeamRole in interface RoleLocalService
Parameters:
companyId - the primary key of the company
teamId - the primary key of the team
Returns:
the team role in the company
Throws:
PortalException

getTeamRoleMap

public Map<Team,Role> getTeamRoleMap(long groupId)
                              throws PortalException
Returns the team role map for the group.

Specified by:
getTeamRoleMap in interface RoleLocalService
Parameters:
groupId - the primary key of the group
Returns:
the team role map for the group
Throws:
PortalException

getTeamRoles

public List<Role> getTeamRoles(long groupId)
                        throws PortalException
Returns the team roles in the group.

Specified by:
getTeamRoles in interface RoleLocalService
Parameters:
groupId - the primary key of the group
Returns:
the team roles in the group
Throws:
PortalException

getTeamRoles

public List<Role> getTeamRoles(long groupId,
                               long[] excludedRoleIds)
                        throws PortalException
Returns the team roles in the group, excluding the specified role IDs.

Specified by:
getTeamRoles in interface RoleLocalService
Parameters:
groupId - the primary key of the group
excludedRoleIds - the primary keys of the roles to exclude (optionally null)
Returns:
the team roles in the group, excluding the specified role IDs
Throws:
PortalException

getTypeRoles

public List<Role> getTypeRoles(int type)
Returns all the roles of the type.

Specified by:
getTypeRoles in interface RoleLocalService
Parameters:
type - the role's type (optionally 0)
Returns:
the range of the roles of the type

getTypeRoles

public List<Role> getTypeRoles(int type,
                               int start,
                               int end)
Returns a range of all the roles of the type.

Specified by:
getTypeRoles in interface RoleLocalService
Parameters:
type - the role's type (optionally 0)
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 the roles of the type

getTypeRolesCount

public int getTypeRolesCount(int type)
Returns the number of roles of the type.

Specified by:
getTypeRolesCount in interface RoleLocalService
Parameters:
type - the role's type (optionally 0)
Returns:
the number of roles of the type

getUserGroupGroupRoles

public List<Role> getUserGroupGroupRoles(long userId,
                                         long groupId)
Returns all the user's roles within the user group.

Specified by:
getUserGroupGroupRoles in interface RoleLocalService
Parameters:
userId - the primary key of the user
groupId - the primary key of the group
Returns:
the user's roles within the user group
See Also:
RoleFinder.findByUserGroupGroupRole( long, long)

getUserGroupGroupRoles

public List<Role> getUserGroupGroupRoles(long userId,
                                         long groupId,
                                         int start,
                                         int end)
Specified by:
getUserGroupGroupRoles in interface RoleLocalService

getUserGroupGroupRolesCount

public int getUserGroupGroupRolesCount(long userId,
                                       long groupId)
Specified by:
getUserGroupGroupRolesCount in interface RoleLocalService

getUserGroupRoles

public List<Role> getUserGroupRoles(long userId,
                                    long groupId)
Returns all the user's roles within the user group.

Specified by:
getUserGroupRoles in interface RoleLocalService
Parameters:
userId - the primary key of the user
groupId - the primary key of the group
Returns:
the user's roles within the user group
See Also:
RoleFinder.findByUserGroupRole( long, long)

getUserPrimaryKeys

public long[] getUserPrimaryKeys(long roleId)
Returns the userIds of the users associated with the role.

Specified by:
getUserPrimaryKeys in interface RoleLocalService
Parameters:
roleId - the roleId of the role
Returns:
long[] the userIds of users associated with the role

getUserRelatedRoles

public List<Role> getUserRelatedRoles(long userId,
                                      long groupId)
Returns all the user's roles within the group.

Specified by:
getUserRelatedRoles in interface RoleLocalService
Parameters:
userId - the primary key of the user
groupId - the primary key of the group
Returns:
the user's roles within the group
See Also:
RoleFinder.findByU_G(long, long)

getUserRelatedRoles

public List<Role> getUserRelatedRoles(long userId,
                                      long[] groupIds)
Returns the union of all the user's roles within the groups.

Specified by:
getUserRelatedRoles in interface RoleLocalService
Parameters:
userId - the primary key of the user
groupIds - the primary keys of the groups
Returns:
the union of all the user's roles within the groups
See Also:
RoleFinder.findByU_G(long, long[])

getUserRelatedRoles

public List<Role> getUserRelatedRoles(long userId,
                                      List<Group> groups)
Returns the union of all the user's roles within the groups.

Specified by:
getUserRelatedRoles in interface RoleLocalService
Parameters:
userId - the primary key of the user
groups - the groups (optionally null)
Returns:
the union of all the user's roles within the groups
See Also:
RoleFinder.findByU_G(long, List)

getUserRoles

public List<Role> getUserRoles(long userId)
Specified by:
getUserRoles in interface RoleLocalService

getUserRoles

public List<Role> getUserRoles(long userId,
                               int start,
                               int end)
Specified by:
getUserRoles in interface RoleLocalService

getUserRoles

public List<Role> getUserRoles(long userId,
                               int start,
                               int end,
                               OrderByComparator<Role> orderByComparator)
Specified by:
getUserRoles in interface RoleLocalService

getUserRolesCount

public int getUserRolesCount(long userId)
Specified by:
getUserRolesCount in interface RoleLocalService

hasGroupRole

public boolean hasGroupRole(long groupId,
                            long roleId)
Specified by:
hasGroupRole in interface RoleLocalService

hasGroupRoles

public boolean hasGroupRoles(long groupId)
Specified by:
hasGroupRoles in interface RoleLocalService

hasUserRole

public boolean hasUserRole(long userId,
                           long companyId,
                           String name,
                           boolean inherited)
                    throws PortalException
Returns true if the user is associated with the named regular role.

Specified by:
hasUserRole in interface RoleLocalService
Parameters:
userId - the primary key of the user
companyId - the primary key of the company
name - the name of the role
inherited - whether to include the user's inherited roles in the search
Returns:
true if the user is associated with the regular role; false otherwise
Throws:
PortalException

hasUserRole

public boolean hasUserRole(long userId,
                           long roleId)
Specified by:
hasUserRole in interface RoleLocalService

hasUserRoles

public boolean hasUserRoles(long userId)
Specified by:
hasUserRoles in interface RoleLocalService

hasUserRoles

public boolean hasUserRoles(long userId,
                            long companyId,
                            String[] names,
                            boolean inherited)
                     throws PortalException
Returns true if the user has any one of the named regular roles.

Specified by:
hasUserRoles in interface RoleLocalService
Parameters:
userId - the primary key of the user
companyId - the primary key of the company
names - the names of the roles
inherited - whether to include the user's inherited roles in the search
Returns:
true if the user has any one of the regular roles; false otherwise
Throws:
PortalException

loadFetchRole

public Role loadFetchRole(long companyId,
                          String name)
Returns a role with the name in the company.

Specified by:
loadFetchRole in interface RoleLocalService
Parameters:
companyId - the primary key of the company
name - the role's name (optionally null)
Returns:
the role with the name, or null if a role with the name could not be found in the company

loadGetRole

public Role loadGetRole(long companyId,
                        String name)
                 throws PortalException
Returns a role with the name in the company.

Specified by:
loadGetRole in interface RoleLocalService
Parameters:
companyId - the primary key of the company
name - the role's name
Returns:
the role with the name in the company
Throws:
PortalException

search

public List<Role> search(long companyId,
                         String keywords,
                         Integer[] types,
                         LinkedHashMap<String,Object> params,
                         int start,
                         int end,
                         OrderByComparator<Role> obc)
Returns an ordered range of all the roles that match the keywords, types, and params.

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.

Specified by:
search in interface RoleLocalService
Parameters:
companyId - the primary key of the company
keywords - the keywords (space separated), which may occur in the role's name or description (optionally null)
types - the role types (optionally null)
params - the finder parameters. Can specify values for the "usersRoles" key. For more information, see RoleFinder
start - the lower bound of the range of roles to return
end - the upper bound of the range of roles to return (not inclusive)
obc - the comparator to order the roles (optionally null)
Returns:
the ordered range of the matching roles, ordered by obc
See Also:
RoleFinder

search

public List<Role> search(long companyId,
                         String keywords,
                         Integer[] types,
                         int start,
                         int end,
                         OrderByComparator<Role> obc)
Returns an ordered range of all the roles that match the keywords and types.

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.

Specified by:
search in interface RoleLocalService
Parameters:
companyId - the primary key of the company
keywords - the keywords (space separated), which may occur in the role's name or description (optionally null)
types - the role types (optionally null)
start - the lower bound of the range of roles to return
end - the upper bound of the range of roles to return (not inclusive)
obc - the comparator to order the roles (optionally null)
Returns:
the ordered range of the matching roles, ordered by obc
See Also:
RoleFinder

search

public List<Role> search(long companyId,
                         String name,
                         String description,
                         Integer[] types,
                         LinkedHashMap<String,Object> params,
                         int start,
                         int end,
                         OrderByComparator<Role> obc)
Returns an ordered range of all the roles that match the name, description, types, and params.

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.

Specified by:
search in interface RoleLocalService
Parameters:
companyId - the primary key of the company
name - the role's name (optionally null)
description - the role's description (optionally null)
types - the role types (optionally null)
params - the finder's parameters. Can specify values for the "usersRoles" key. For more information, see RoleFinder
start - the lower bound of the range of the roles to return
end - the upper bound of the range of the roles to return (not inclusive)
obc - the comparator to order the roles (optionally null)
Returns:
the ordered range of the matching roles, ordered by obc
See Also:
RoleFinder

search

public List<Role> search(long companyId,
                         String name,
                         String description,
                         Integer[] types,
                         int start,
                         int end,
                         OrderByComparator<Role> obc)
Returns an ordered range of all the roles that match the name, description, and types.

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.

Specified by:
search in interface RoleLocalService
Parameters:
companyId - the primary key of the company
name - the role's name (optionally null)
description - the role's description (optionally null)
types - the role types (optionally null)
start - the lower bound of the range of the roles to return
end - the upper bound of the range of the roles to return (not inclusive)
obc - the comparator to order the roles (optionally null)
Returns:
the ordered range of the matching roles, ordered by obc
See Also:
RoleFinder

searchCount

public int searchCount(long companyId,
                       String keywords,
                       Integer[] types)
Returns the number of roles that match the keywords and types.

Specified by:
searchCount in interface RoleLocalService
Parameters:
companyId - the primary key of the company
keywords - the keywords (space separated), which may occur in the role's name or description (optionally null)
types - the role types (optionally null)
Returns:
the number of matching roles

searchCount

public int searchCount(long companyId,
                       String keywords,
                       Integer[] types,
                       LinkedHashMap<String,Object> params)
Returns the number of roles that match the keywords, types and params.

Specified by:
searchCount in interface RoleLocalService
Parameters:
companyId - the primary key of the company
keywords - the keywords (space separated), which may occur in the role's name or description (optionally null)
types - the role types (optionally null)
params - the finder parameters. For more information, see RoleFinder
Returns:
the number of matching roles

searchCount

public int searchCount(long companyId,
                       String name,
                       String description,
                       Integer[] types)
Returns the number of roles that match the name, description, and types.

Specified by:
searchCount in interface RoleLocalService
Parameters:
companyId - the primary key of the company
name - the role's name (optionally null)
description - the role's description (optionally null)
types - the role types (optionally null)
Returns:
the number of matching roles

searchCount

public int searchCount(long companyId,
                       String name,
                       String description,
                       Integer[] types,
                       LinkedHashMap<String,Object> params)
Returns the number of roles that match the name, description, types, and params.

Specified by:
searchCount in interface RoleLocalService
Parameters:
companyId - the primary key of the company
name - the role's name (optionally null)
description - the role's description (optionally null)
types - the role types (optionally null)
params - the finder parameters. Can specify values for the "usersRoles" key. For more information, see RoleFinder
Returns:
the number of matching roles

setGroupRoles

public void setGroupRoles(long groupId,
                          long[] roleIds)
Specified by:
setGroupRoles in interface RoleLocalService

setUserRoles

public void setUserRoles(long userId,
                         long[] roleIds)
                  throws PortalException
Specified by:
setUserRoles in interface RoleLocalService
Throws:
PortalException

unsetUserRoles

public void unsetUserRoles(long userId,
                           long[] roleIds)
                    throws PortalException
Removes the matching roles associated with the user. The user is reindexed after the roles are removed.

Specified by:
unsetUserRoles in interface RoleLocalService
Parameters:
userId - the primary key of the user
roleIds - the primary keys of the roles
Throws:
PortalException

updateRole

public Role updateRole(Role role)
Updates the role in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Specified by:
updateRole in interface RoleLocalService
Parameters:
role - the role
Returns:
the role that was updated

updateRole

public Role updateRole(long roleId,
                       String name,
                       Map<Locale,String> titleMap,
                       Map<Locale,String> descriptionMap,
                       String subtype,
                       ServiceContext serviceContext)
                throws PortalException
Updates the role with the primary key.

Specified by:
updateRole in interface RoleLocalService
Parameters:
roleId - the primary key of the role
name - the role's new name
titleMap - the new localized titles (optionally null) to replace those existing for the role
descriptionMap - the new localized descriptions (optionally null) to replace those existing for the role
subtype - the role's new subtype (optionally null)
serviceContext - the service context to be applied (optionally null). Can set expando bridge attributes for the role.
Returns:
the role with the primary key
Throws:
PortalException

getWrappedService

public RoleLocalService getWrappedService()
Specified by:
getWrappedService in interface ServiceWrapper<RoleLocalService>

setWrappedService

public void setWrappedService(RoleLocalService roleLocalService)
Specified by:
setWrappedService in interface ServiceWrapper<RoleLocalService>

Liferay 7.0-ce-b4