|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
@AccessControlled
@JSONWebService
@ProviderType
@Transactional(isolation=PORTAL,
rollbackFor={PortalException.class,SystemException.class})
public interface RoleServiceProvides the remote service interface for Role. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.
RoleServiceUtil,
RoleServiceBaseImpl,
com.liferay.portal.service.impl.RoleServiceImpl| Method Summary | |
|---|---|
Role |
addRole(String className,
long classPK,
String name,
Map<Locale,String> titleMap,
Map<Locale,String> descriptionMap,
int type,
String subtype,
ServiceContext serviceContext)
Adds a role. |
Role |
addRole(String name,
Map<Locale,String> titleMap,
Map<Locale,String> descriptionMap,
int type)
Deprecated. As of 6.2.0, replaced by addRole(String, long,
String, Map, Map, int, String, ServiceContext) |
void |
addUserRoles(long userId,
long[] roleIds)
Adds the roles to the user. |
void |
deleteRole(long roleId)
Deletes the role with the primary key and its associated permissions. |
Role |
fetchRole(long roleId)
|
List<Role> |
getGroupRoles(long groupId)
Returns all the roles associated with the group. |
String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier. |
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. |
List<Role> |
getRoles(int type,
String subtype)
|
List<Role> |
getRoles(long companyId,
int[] types)
|
List<Role> |
getUserGroupGroupRoles(long userId,
long groupId)
Returns all the user's roles within the user group. |
List<Role> |
getUserGroupRoles(long userId,
long groupId)
Returns all the user's roles within the user group. |
List<Role> |
getUserRelatedRoles(long userId,
List<Group> groups)
Returns the union of all the user's roles within the groups. |
List<Role> |
getUserRoles(long userId)
Returns all the roles associated with the user. |
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,
long companyId,
String[] names,
boolean inherited)
Returns true if the user has any one of the named regular
roles. |
List<Role> |
search(long companyId,
String keywords,
Integer[] types,
LinkedHashMap<String,Object> params,
int start,
int end,
OrderByComparator<Role> obc)
|
int |
searchCount(long companyId,
String keywords,
Integer[] types,
LinkedHashMap<String,Object> params)
|
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. |
| Method Detail |
|---|
Role addRole(String className,
long classPK,
String name,
Map<Locale,String> titleMap,
Map<Locale,String> descriptionMap,
int type,
String subtype,
ServiceContext serviceContext)
throws PortalException
className - the name of the class for which the role is createdclassPK - 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 the expando bridge attributes for the
role.
PortalException
@Deprecated
Role addRole(String name,
Map<Locale,String> titleMap,
Map<Locale,String> descriptionMap,
int type)
throws PortalException
addRole(String, long,
String, Map, Map, int, String, ServiceContext)
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)
PortalException
void addUserRoles(long userId,
long[] roleIds)
throws PortalException
userId - the primary key of the userroleIds - the primary keys of the roles
PortalException
void deleteRole(long roleId)
throws PortalException
roleId - the primary key of the role
PortalException
@Transactional(propagation=SUPPORTS,
readOnly=true)
Role fetchRole(long roleId)
throws PortalException
PortalException
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Role> getGroupRoles(long groupId)
throws PortalException
groupId - the primary key of the group
PortalExceptionString getOSGiServiceIdentifier()
@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 name
PortalException
@Transactional(propagation=SUPPORTS,
readOnly=true)
Role getRole(long roleId)
throws PortalException
roleId - the primary key of the role
PortalException
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Role> getRoles(long companyId,
int[] types)
throws PortalException
PortalException
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Role> getRoles(int type,
String subtype)
throws PortalException
PortalException
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Role> getUserGroupGroupRoles(long userId,
long groupId)
throws PortalException
userId - the primary key of the usergroupId - the primary key of the group
PortalException
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Role> getUserGroupRoles(long userId,
long groupId)
throws PortalException
userId - the primary key of the usergroupId - the primary key of the group
PortalException
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Role> getUserRelatedRoles(long userId,
List<Group> groups)
throws PortalException
userId - the primary key of the usergroups - the groups (optionally null)
PortalException
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Role> getUserRoles(long userId)
throws PortalException
userId - the primary key of the user
PortalException
@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
search
true if the user is associated with the regular
role; false otherwise
PortalException
@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
search
true if the user has any one of the regular roles;
false otherwise
PortalException
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Role> search(long companyId,
String keywords,
Integer[] types,
LinkedHashMap<String,Object> params,
int start,
int end,
OrderByComparator<Role> obc)
@Transactional(propagation=SUPPORTS,
readOnly=true)
int searchCount(long companyId,
String keywords,
Integer[] types,
LinkedHashMap<String,Object> params)
void unsetUserRoles(long userId,
long[] roleIds)
throws PortalException
userId - the primary key of the userroleIds - the primary keys of the roles
PortalException
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 the expando bridge attributes for the
role.
PortalException
|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||