|
Liferay 6.1.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
@JSONWebService
@Transactional(isolation=PORTAL,
rollbackFor={PortalException.class,SystemException.class})
public interface RoleServiceThe interface for the role remote service.
This is a remote service. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.
RoleServiceUtil,
RoleServiceBaseImpl,
com.liferay.portal.service.impl.RoleServiceImpl| Method Summary | |
|---|---|
Role |
addRole(String name,
Map<Locale,String> titleMap,
Map<Locale,String> descriptionMap,
int type)
Adds a role. |
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. |
List<Role> |
getGroupRoles(long groupId)
Returns all the roles associated with the group. |
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> |
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. |
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)
Updates the role with the primary key. |
| Method Detail |
|---|
Role addRole(String name,
Map<Locale,String> titleMap,
Map<Locale,String> descriptionMap,
int type)
throws PortalException,
SystemException
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 - if a user with the primary key could not be
found, if the user did not have permission to add roles, if the
class name or the role name were invalid, or if the role is a
duplicate
SystemException - if a system exception occurred
void addUserRoles(long userId,
long[] roleIds)
throws PortalException,
SystemException
userId - the primary key of the userroleIds - the primary keys of the roles
PortalException - if a user with the primary key could not be
found or if the user did not have permission to assign members
to one of the roles
SystemException - if a system exception occurred
void deleteRole(long roleId)
throws PortalException,
SystemException
roleId - the primary key of the role
PortalException - if the user did not have permission to delete
the role, if a role with the primary key could not be found, if
the role is a default system role, or if the role's resource
could not be found
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Role> getGroupRoles(long groupId)
throws PortalException,
SystemException
groupId - the primary key of the group
PortalException - if a portal exception occurred
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
Role getRole(long roleId)
throws PortalException,
SystemException
roleId - the primary key of the role
PortalException - if a role with the primary key could not be
found or if the user did not have permission to view the role
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
Role getRole(long companyId,
String name)
throws PortalException,
SystemException
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 - if a role with the name could not be found in
the company or if the user did not have permission to view the
role
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Role> getUserGroupGroupRoles(long userId,
long groupId)
throws PortalException,
SystemException
userId - the primary key of the usergroupId - the primary key of the group
PortalException - if a portal exception occurred
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Role> getUserGroupRoles(long userId,
long groupId)
throws PortalException,
SystemException
userId - the primary key of the usergroupId - the primary key of the group
PortalException - if a portal exception occurred
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Role> getUserRelatedRoles(long userId,
List<Group> groups)
throws PortalException,
SystemException
userId - the primary key of the usergroups - the groups (optionally null)
PortalException - if a portal exception occurred
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Role> getUserRoles(long userId)
throws PortalException,
SystemException
userId - the primary key of the user
PortalException - if a portal exception occurred
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
boolean hasUserRole(long userId,
long companyId,
String name,
boolean inherited)
throws PortalException,
SystemException
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 - if a role with the name could not be found in
the company or if a default user for the company could not be
found
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
boolean hasUserRoles(long userId,
long companyId,
String[] names,
boolean inherited)
throws PortalException,
SystemException
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 - if any one of the roles with the names could not
be found in the company or if the default user for the company
could not be found
SystemException - if a system exception occurred
void unsetUserRoles(long userId,
long[] roleIds)
throws PortalException,
SystemException
userId - the primary key of the userroleIds - the primary keys of the roles
PortalException - if a user with the primary key could not be
found, if the user did not have permission to remove members
from a role, or if a role with any one of the primary keys could
not be found
SystemException - if a system exception occurred
Role updateRole(long roleId,
String name,
Map<Locale,String> titleMap,
Map<Locale,String> descriptionMap,
String subtype)
throws PortalException,
SystemException
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)
PortalException - if the user did not have permission to update
the role, if a role with the primary could not be found, or if
the role's name was invalid
SystemException - if a system exception occurred
|
Liferay 6.1.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||