@CTAware @ProviderType @Transactional(isolation=PORTAL, rollbackFor={PortalException.class,SystemException.class}) public interface RoleLocalService extends BaseLocalService, CTService<Role>, PersistedModelLocalService
RoleLocalServiceUtil
Modifier and Type | Method and Description |
---|---|
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,
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) |
PersistedModel |
createPersistedModel(Serializable primaryKeyObj) |
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) |
<T> T |
dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) |
int |
dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) |
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() |
int |
getAssigneesTotal(long roleId) |
CTPersistence<Role> |
getCTPersistence() |
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) |
List<Role> |
getGroupRolesAndTeamRoles(long companyId,
String keywords,
List<String> excludedNames,
int[] types,
long excludedTeamRoleId,
long teamGroupId,
int start,
int end) |
int |
getGroupRolesAndTeamRolesCount(long companyId,
String keywords,
List<String> excludedNames,
int[] types,
long excludedTeamRoleId,
long teamGroupId) |
int |
getGroupRolesCount(long groupId) |
IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
Class<Role> |
getModelClass() |
String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
PersistedModel |
getPersistedModel(Serializable primaryKeyObj) |
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.
|
List<Role> |
getRoles(long companyId,
long classNameId,
long[] classPKs,
int type) |
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> |
getTeamsRoles(long companyId,
long[] teamIds)
Returns the team roles in the company.
|
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) |
List<Role> |
getUserTeamRoles(long userId,
long groupId) |
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)
Deprecated.
As of Athanasius (7.3.x), replaced by
fetchRole(long, String) |
Role |
loadGetRole(long companyId,
String name)
Deprecated.
As of Athanasius (7.3.x), replaced by
getRole(long, String) |
List<Role> |
search(long companyId,
String keywords,
Integer[] types,
int start,
int end,
OrderByComparator<Role> orderByComparator)
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> orderByComparator)
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> orderByComparator)
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> orderByComparator)
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 |
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.
|
<R,E extends Throwable> |
updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<Role>,R,E> updateUnsafeFunction) |
void |
validateName(String name) |
getBasePersistence
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, String className, long classPK, String name, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, int type, String subtype, ServiceContext serviceContext) throws PortalException
userId
- the primary key of the userclassName
- 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 nametitleMap
- 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.PortalException
@Indexable(type=REINDEX) Role addRole(Role role)
Important: Inspect RoleLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
role
- the rolevoid addUserRole(long userId, long roleId) throws PortalException
PortalException
void addUserRole(long userId, Role role) throws PortalException
PortalException
void addUserRoles(long userId, List<Role> roles) throws PortalException
PortalException
void addUserRoles(long userId, long[] roleIds) throws PortalException
PortalException
void checkSystemRoles() throws PortalException
PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) void checkSystemRoles(long companyId) throws PortalException
companyId
- the primary key of the companyPortalException
void clearGroupRoles(long groupId)
void clearUserRoles(long userId) throws PortalException
PortalException
PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
createPersistedModel
in interface PersistedModelLocalService
PortalException
@Transactional(enabled=false) Role createRole(long roleId)
roleId
- the primary key for the new rolevoid 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) throws PortalException
deletePersistedModel
in interface PersistedModelLocalService
PortalException
@Indexable(type=DELETE) Role deleteRole(long roleId) throws PortalException
Important: Inspect RoleLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
roleId
- the primary key of the rolePortalException
- if a role with the primary key could not be found@Indexable(type=DELETE) @SystemEvent(action=1, type=1) Role deleteRole(Role role) throws PortalException
Important: Inspect RoleLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
role
- the rolePortalException
void deleteUserRole(long userId, long roleId) throws PortalException
PortalException
void deleteUserRole(long userId, Role role) throws PortalException
PortalException
void deleteUserRoles(long userId, List<Role> roles) throws PortalException
PortalException
void deleteUserRoles(long userId, long[] roleIds) throws PortalException
PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
dslQuery
in interface PersistedModelLocalService
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
dslQueryCount
in interface PersistedModelLocalService
@Transactional(propagation=SUPPORTS, readOnly=true) DynamicQuery dynamicQuery()
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic query@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.RoleModelImpl
.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator)
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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.RoleModelImpl
.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic query@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query@Transactional(propagation=SUPPORTS, readOnly=true) Role fetchRole(long roleId)
@Transactional(propagation=SUPPORTS, readOnly=true) Role fetchRole(long companyId, String name)
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.
companyId
- the primary key of the companyname
- the role's namenull
if a role
with the name could not be found in the company@Transactional(propagation=SUPPORTS, readOnly=true) Role fetchRoleByUuidAndCompanyId(String uuid, long companyId)
uuid
- the role's UUIDcompanyId
- the primary key of the companynull
if a matching role could not be found@Transactional(propagation=SUPPORTS, readOnly=true) ActionableDynamicQuery getActionableDynamicQuery()
@Transactional(propagation=SUPPORTS, readOnly=true) int getAssigneesTotal(long roleId) throws PortalException
PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) Role getDefaultGroupRole(long groupId) throws PortalException
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
.
groupId
- the primary key of the groupPortalException
@Transactional(propagation=SUPPORTS, readOnly=true) ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
@Transactional(propagation=SUPPORTS, readOnly=true) long[] getGroupPrimaryKeys(long roleId)
roleId
- the roleId of the role@Transactional(propagation=SUPPORTS, readOnly=true) List<Role> getGroupRelatedRoles(long groupId) throws PortalException
PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) List<Role> getGroupRoles(long groupId)
@Transactional(propagation=SUPPORTS, readOnly=true) List<Role> getGroupRoles(long groupId, int start, int end)
@Transactional(propagation=SUPPORTS, readOnly=true) List<Role> getGroupRoles(long groupId, int start, int end, OrderByComparator<Role> orderByComparator)
@Transactional(propagation=SUPPORTS, readOnly=true) List<Role> getGroupRolesAndTeamRoles(long companyId, String keywords, List<String> excludedNames, int[] types, long excludedTeamRoleId, long teamGroupId, int start, int end)
@Transactional(propagation=SUPPORTS, readOnly=true) int getGroupRolesAndTeamRolesCount(long companyId, String keywords, List<String> excludedNames, int[] types, long excludedTeamRoleId, long teamGroupId)
@Transactional(propagation=SUPPORTS, readOnly=true) int getGroupRolesCount(long groupId)
@Transactional(propagation=SUPPORTS, readOnly=true) IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
String getOSGiServiceIdentifier()
@Transactional(propagation=SUPPORTS, readOnly=true) PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
getPersistedModel
in interface PersistedModelLocalService
PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) Map<String,List<String>> getResourceRoles(long companyId, String name, int scope, String primKey)
companyId
- the primary key of the companyname
- the resource namescope
- the permission scopeprimKey
- the primary key of the resource's class@Transactional(propagation=SUPPORTS, readOnly=true) List<Role> getResourceRoles(long companyId, String name, int scope, String primKey, String actionId)
companyId
- the primary key of the companyname
- the resource namescope
- the permission scopeprimKey
- the primary key of the resource's classactionId
- the name of the resource action@Transactional(propagation=SUPPORTS, readOnly=true) Role getRole(long roleId) throws PortalException
roleId
- the primary key of the rolePortalException
- if a role with the primary key could not be found@Transactional(propagation=SUPPORTS, readOnly=true) Role getRole(long companyId, String name) throws PortalException
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.
companyId
- the primary key of the companyname
- the role's namePortalException
@Transactional(propagation=SUPPORTS, readOnly=true) Role getRoleByUuidAndCompanyId(String uuid, long companyId) throws PortalException
uuid
- the role's UUIDcompanyId
- the primary key of the companyPortalException
- if a matching role could not be found@Transactional(propagation=SUPPORTS, readOnly=true) List<Role> getRoles(int start, int end)
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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.RoleModelImpl
.
start
- the lower bound of the range of rolesend
- the upper bound of the range of roles (not inclusive)@Transactional(propagation=SUPPORTS, readOnly=true) List<Role> getRoles(int type, String subtype)
type
- the role's type (optionally 0
)subtype
- the role's subtype (optionally null
)@Transactional(propagation=SUPPORTS, readOnly=true) List<Role> getRoles(long companyId)
companyId
- the primary key of the company@Transactional(propagation=SUPPORTS, readOnly=true) List<Role> getRoles(long companyId, int[] types)
companyId
- the primary key of the companytypes
- the role types (optionally null
)@Transactional(propagation=SUPPORTS, readOnly=true) List<Role> getRoles(long companyId, long classNameId, long[] classPKs, int type)
@Transactional(propagation=SUPPORTS, readOnly=true) List<Role> getRoles(long[] roleIds) throws PortalException
roleIds
- the primary keys of the rolesPortalException
@Transactional(propagation=SUPPORTS, readOnly=true) int getRolesCount()
@Transactional(propagation=SUPPORTS, readOnly=true) List<Role> getSubtypeRoles(String subtype)
subtype
- the role's subtype (optionally null
)@Transactional(propagation=SUPPORTS, readOnly=true) int getSubtypeRolesCount(String subtype)
subtype
- the role's subtype (optionally null
)@Transactional(propagation=SUPPORTS, readOnly=true) Role getTeamRole(long companyId, long teamId) throws PortalException
companyId
- the primary key of the companyteamId
- the primary key of the teamPortalException
@Transactional(propagation=SUPPORTS, readOnly=true) Map<Team,Role> getTeamRoleMap(long groupId) throws PortalException
groupId
- the primary key of the groupPortalException
@Transactional(propagation=SUPPORTS, readOnly=true) List<Role> getTeamRoles(long groupId) throws PortalException
groupId
- the primary key of the groupPortalException
@Transactional(propagation=SUPPORTS, readOnly=true) List<Role> getTeamRoles(long groupId, long[] excludedRoleIds) throws PortalException
groupId
- the primary key of the groupexcludedRoleIds
- the primary keys of the roles to exclude
(optionally null
)PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) List<Role> getTeamsRoles(long companyId, long[] teamIds) throws PortalException
companyId
- the primary key of the companyteamIds
- the primary keys of the teamsPortalException
@Transactional(propagation=SUPPORTS, readOnly=true) List<Role> getTypeRoles(int type)
type
- the role's type (optionally 0
)@Transactional(propagation=SUPPORTS, readOnly=true) List<Role> getTypeRoles(int type, int start, int end)
type
- the role's type (optionally 0
)start
- the lower bound of the range of roles to returnend
- the upper bound of the range of roles to return (not
inclusive)@Transactional(propagation=SUPPORTS, readOnly=true) int getTypeRolesCount(int type)
type
- the role's type (optionally 0
)@Transactional(propagation=SUPPORTS, readOnly=true) List<Role> getUserGroupGroupRoles(long userId, long groupId)
userId
- the primary key of the usergroupId
- the primary key of the group@Transactional(propagation=SUPPORTS, readOnly=true) List<Role> getUserGroupGroupRoles(long userId, long groupId, int start, int end)
@Transactional(propagation=SUPPORTS, readOnly=true) int getUserGroupGroupRolesCount(long userId, long groupId)
@Transactional(propagation=SUPPORTS, readOnly=true) List<Role> getUserGroupRoles(long userId, long groupId)
userId
- the primary key of the usergroupId
- the primary key of the group@Transactional(propagation=SUPPORTS, readOnly=true) long[] getUserPrimaryKeys(long roleId)
roleId
- the roleId of the role@Transactional(propagation=SUPPORTS, readOnly=true) List<Role> getUserRelatedRoles(long userId, List<Group> groups)
userId
- the primary key of the usergroups
- the groups (optionally null
)@Transactional(propagation=SUPPORTS, readOnly=true) List<Role> getUserRelatedRoles(long userId, long groupId)
userId
- the primary key of the usergroupId
- the primary key of the group@Transactional(propagation=SUPPORTS, readOnly=true) List<Role> getUserRelatedRoles(long userId, long[] groupIds)
userId
- the primary key of the usergroupIds
- the primary keys of the groups@Transactional(propagation=SUPPORTS, readOnly=true) List<Role> getUserRoles(long userId)
@Transactional(propagation=SUPPORTS, readOnly=true) List<Role> getUserRoles(long userId, int start, int end)
@Transactional(propagation=SUPPORTS, readOnly=true) List<Role> getUserRoles(long userId, int start, int end, OrderByComparator<Role> orderByComparator)
@Transactional(propagation=SUPPORTS, readOnly=true) int getUserRolesCount(long userId)
@Transactional(propagation=SUPPORTS, readOnly=true) List<Role> getUserTeamRoles(long userId, long groupId)
@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasGroupRole(long groupId, long roleId)
@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasGroupRoles(long groupId)
@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasUserRole(long userId, long roleId)
@ThreadLocalCachable @Transactional(propagation=SUPPORTS, readOnly=true) boolean hasUserRole(long userId, long companyId, String name, boolean inherited) throws PortalException
true
if the user is associated with the named
regular role.userId
- the primary key of the usercompanyId
- the primary key of the companyname
- the name of the roleinherited
- whether to include the user's inherited roles in the
searchtrue
if the user is associated with the regular
role; false
otherwisePortalException
@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasUserRoles(long userId)
@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasUserRoles(long userId, long companyId, String[] names, boolean inherited) throws PortalException
true
if the user has any one of the named regular
roles.userId
- the primary key of the usercompanyId
- the primary key of the companynames
- the names of the rolesinherited
- whether to include the user's inherited roles in the
searchtrue
if the user has any one of the regular roles;
false
otherwisePortalException
@Deprecated @Transactional(propagation=SUPPORTS, readOnly=true) Role loadFetchRole(long companyId, String name)
fetchRole(long, String)
companyId
- the primary key of the companyname
- the role's name (optionally null
)null
if a role with the
name could not be found in the company@Deprecated @Transactional(propagation=SUPPORTS, readOnly=true) Role loadGetRole(long companyId, String name) throws PortalException
getRole(long, String)
companyId
- the primary key of the companyname
- the role's namePortalException
@Transactional(propagation=SUPPORTS, readOnly=true) List<Role> search(long companyId, String keywords, Integer[] types, int start, int end, OrderByComparator<Role> orderByComparator)
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.
companyId
- the primary key of the companykeywords
- 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 returnend
- the upper bound of the range of roles to return (not
inclusive)orderByComparator
- the comparator to order the roles (optionally
null
)orderByComparator
RoleFinder
@Transactional(propagation=SUPPORTS, readOnly=true) List<Role> search(long companyId, String keywords, Integer[] types, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator<Role> orderByComparator)
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.
companyId
- the primary key of the companykeywords
- 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 returnend
- the upper bound of the range of roles to return (not
inclusive)orderByComparator
- the comparator to order the roles (optionally
null
)orderByComparator
RoleFinder
@Transactional(propagation=SUPPORTS, readOnly=true) List<Role> search(long companyId, String name, String description, Integer[] types, int start, int end, OrderByComparator<Role> orderByComparator)
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.
companyId
- the primary key of the companyname
- 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 returnend
- the upper bound of the range of the roles to return (not
inclusive)orderByComparator
- the comparator to order the roles (optionally
null
)orderByComparator
RoleFinder
@Transactional(propagation=SUPPORTS, readOnly=true) List<Role> search(long companyId, String name, String description, Integer[] types, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator<Role> orderByComparator)
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.
companyId
- the primary key of the companyname
- 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 returnend
- the upper bound of the range of the roles to return (not
inclusive)orderByComparator
- the comparator to order the roles (optionally
null
)orderByComparator
RoleFinder
@Transactional(propagation=SUPPORTS, readOnly=true) int searchCount(long companyId, String keywords, Integer[] types)
companyId
- the primary key of the companykeywords
- the keywords (space separated), which may occur in the
role's name or description (optionally null
)types
- the role types (optionally null
)@Transactional(propagation=SUPPORTS, readOnly=true) int searchCount(long companyId, String keywords, Integer[] types, LinkedHashMap<String,Object> params)
companyId
- the primary key of the companykeywords
- 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
@Transactional(propagation=SUPPORTS, readOnly=true) int searchCount(long companyId, String name, String description, Integer[] types)
companyId
- the primary key of the companyname
- the role's name (optionally null
)description
- the role's description (optionally null
)types
- the role types (optionally null
)@Transactional(propagation=SUPPORTS, readOnly=true) int searchCount(long companyId, String name, String description, Integer[] types, LinkedHashMap<String,Object> params)
companyId
- the primary key of the companyname
- 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
void setGroupRoles(long groupId, long[] roleIds)
void setUserRoles(long userId, long[] roleIds) throws PortalException
PortalException
void unsetUserRoles(long userId, long[] roleIds) throws PortalException
userId
- the primary key of the userroleIds
- the primary keys of the rolesPortalException
Role updateRole(long roleId, String name, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String subtype, ServiceContext serviceContext) throws PortalException
roleId
- the primary key of the rolename
- the role's new nametitleMap
- the new localized titles (optionally null
)
to replace those existing for the roledescriptionMap
- the new localized descriptions (optionally
null
) to replace those existing for the rolesubtype
- the role's new subtype (optionally null
)serviceContext
- the service context to be applied (optionally
null
). Can set expando bridge attributes for the
role.PortalException
@Indexable(type=REINDEX) Role updateRole(Role role)
Important: Inspect RoleLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
role
- the rolevoid validateName(String name) throws PortalException
PortalException
@Transactional(enabled=false) CTPersistence<Role> getCTPersistence()
getCTPersistence
in interface CTService<Role>
@Transactional(enabled=false) Class<Role> getModelClass()
getModelClass
in interface CTService<Role>
@Transactional(rollbackFor=java.lang.Throwable.class) <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<Role>,R,E> updateUnsafeFunction) throws E extends Throwable
updateWithUnsafeFunction
in interface CTService<Role>
E extends Throwable