Liferay 6.2-ce-ga5

com.liferay.portal.service
Interface RoleService

All Superinterfaces:
BaseService
All Known Implementing Classes:
RoleServiceWrapper

@ProviderType
@AccessControlled
@JSONWebService
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface RoleService
extends BaseService

Provides 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.

See Also:
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.
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 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 setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 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

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

addRole

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

Parameters:
className - the name of the class for which the role is created
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 the expando bridge attributes for the role.
Returns:
the role
Throws:
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

addRole

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

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

Parameters:
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 - 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

addUserRoles

void addUserRoles(long userId,
                  long[] roleIds)
                  throws PortalException,
                         SystemException
Adds the roles to the user. The user is reindexed after the roles are added.

Parameters:
userId - the primary key of the user
roleIds - the primary keys of the roles
Throws:
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

deleteRole

void deleteRole(long roleId)
                throws PortalException,
                       SystemException
Deletes the role with the primary key and its associated permissions.

Parameters:
roleId - the primary key of the role
Throws:
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

getGroupRoles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Role> getGroupRoles(long groupId)
                         throws PortalException,
                                SystemException
Returns all the roles associated with the group.

Parameters:
groupId - the primary key of the group
Returns:
the roles associated with the group
Throws:
PortalException - if a portal exception occurred
SystemException - if a system exception occurred

getRole

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Role getRole(long roleId)
             throws PortalException,
                    SystemException
Returns the role with the primary key.

Parameters:
roleId - the primary key of the role
Returns:
the role with the primary key
Throws:
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

getRole

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Role getRole(long companyId,
                                                      String name)
             throws PortalException,
                    SystemException
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.

Parameters:
companyId - the primary key of the company
name - the role's name
Returns:
the role with the name
Throws:
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

getUserGroupGroupRoles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Role> getUserGroupGroupRoles(long userId,
                                                                           long groupId)
                                  throws PortalException,
                                         SystemException
Returns all the user's roles within the user group.

Parameters:
userId - the primary key of the user
groupId - the primary key of the group
Returns:
the user's roles within the user group
Throws:
PortalException - if a portal exception occurred
SystemException - if a system exception occurred

getUserGroupRoles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Role> getUserGroupRoles(long userId,
                                                                      long groupId)
                             throws PortalException,
                                    SystemException
Returns all the user's roles within the user group.

Parameters:
userId - the primary key of the user
groupId - the primary key of the group
Returns:
the user's roles within the user group
Throws:
PortalException - if a portal exception occurred
SystemException - if a system exception occurred

getUserRelatedRoles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Role> getUserRelatedRoles(long userId,
                                                                        List<Group> groups)
                               throws PortalException,
                                      SystemException
Returns the union of all the user's roles within the groups.

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
Throws:
PortalException - if a portal exception occurred
SystemException - if a system exception occurred

getUserRoles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Role> getUserRoles(long userId)
                        throws PortalException,
                               SystemException
Returns all the roles associated with the user.

Parameters:
userId - the primary key of the user
Returns:
the roles associated with the user
Throws:
PortalException - if a portal exception occurred
SystemException - if a system exception occurred

hasUserRole

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasUserRole(long userId,
                                                             long companyId,
                                                             String name,
                                                             boolean inherited)
                    throws PortalException,
                           SystemException
Returns true if the user is associated with the named regular role.

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 - 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

hasUserRoles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasUserRoles(long userId,
                                                              long companyId,
                                                              String[] names,
                                                              boolean inherited)
                     throws PortalException,
                            SystemException
Returns true if the user has any one of the named regular roles.

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 - 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

unsetUserRoles

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

Parameters:
userId - the primary key of the user
roleIds - the primary keys of the roles
Throws:
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

updateRole

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

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 the expando bridge attributes for the role.
Returns:
the role with the primary key
Throws:
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.2-ce-ga5