com.liferay.portal.service
Class ResourcePermissionServiceWrapper

java.lang.Object
  com.liferay.portal.service.ResourcePermissionServiceWrapper

All Implemented Interfaces:

BaseService, ResourcePermissionService, ServiceWrapper<ResourcePermissionService>

@ProviderType
public class ResourcePermissionServiceWrapper
extends Object
implements ResourcePermissionService, ServiceWrapper<ResourcePermissionService>

Provides a wrapper for ResourcePermissionService.

See Also:

ResourcePermissionService

Constructor Summary

ResourcePermissionServiceWrapper(ResourcePermissionService resourcePermissionService)

Method Summary

void	addResourcePermission(long groupId, long companyId, String name, int scope, String primKey, long roleId, String actionId) Grants the role permission at the scope to perform the action on resources of the type.
String	getBeanIdentifier() Returns the Spring bean ID for this bean.
ResourcePermissionService	getWrappedResourcePermissionService() Deprecated. As of 6.1.0, replaced by getWrappedService()
ResourcePermissionService	getWrappedService()
void	removeResourcePermission(long groupId, long companyId, String name, int scope, String primKey, long roleId, String actionId) Revokes permission at the scope from the role to perform the action on resources of the type.
void	removeResourcePermissions(long groupId, long companyId, String name, int scope, long roleId, String actionId) Revokes all permissions at the scope from the role to perform the action on resources of the type.
void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setIndividualResourcePermissions(long groupId, long companyId, String name, String primKey, long roleId, String[] actionIds) Updates the role's permissions at the scope, setting the actions that can be performed on resources of the type.
void	setIndividualResourcePermissions(long groupId, long companyId, String name, String primKey, Map<Long,String[]> roleIdsToActionIds) Updates the role's permissions at the scope, setting the actions that can be performed on resources of the type.
void	setWrappedResourcePermissionService(ResourcePermissionService resourcePermissionService) Deprecated. As of 6.1.0, replaced by setWrappedService(com.liferay.portal.service.ResourcePermissionService)
void	setWrappedService(ResourcePermissionService resourcePermissionService)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ResourcePermissionServiceWrapper

public ResourcePermissionServiceWrapper(ResourcePermissionService resourcePermissionService)

Method Detail

getBeanIdentifier

public String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Specified by:

getBeanIdentifier in interface ResourcePermissionService

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Specified by:

setBeanIdentifier in interface ResourcePermissionService

Parameters:

beanIdentifier - the Spring bean ID for this bean

addResourcePermission

public void addResourcePermission(long groupId,
                                  long companyId,
                                  String name,
                                  int scope,
                                  String primKey,
                                  long roleId,
                                  String actionId)
                           throws PortalException,
                                  SystemException

Grants the role permission at the scope to perform the action on resources of the type. Existing actions are retained.

This method cannot be used to grant individual scope permissions, but is only intended for adding permissions at the company, group, and group-template scopes. For example, this method could be used to grant a company scope permission to edit message board posts.

If a company scope permission is granted to resources that the role already had group scope permissions to, the group scope permissions are deleted. Likewise, if a group scope permission is granted to resources that the role already had company scope permissions to, the company scope permissions are deleted. Be aware that this latter behavior can result in an overall reduction in permissions for the role.

Depending on the scope, the value of primKey will have different meanings. For more information, see ResourcePermissionImpl.

Specified by:

addResourcePermission in interface ResourcePermissionService

Parameters:

groupId - the primary key of the group

companyId - the primary key of the company

name - the resource's name, which can be either a class name or a portlet ID

scope - the scope. This method only supports company, group, and group-template scope.

primKey - the primary key

roleId - the primary key of the role

actionId - the action ID

Throws:

PortalException - if the user did not have permission to add resource permissions, or if scope was set to individual scope or if a role with the primary key or a resource action with the name and action ID could not be found

SystemException - if a system exception occurred

removeResourcePermission

public void removeResourcePermission(long groupId,
                                     long companyId,
                                     String name,
                                     int scope,
                                     String primKey,
                                     long roleId,
                                     String actionId)
                              throws PortalException,
                                     SystemException

Revokes permission at the scope from the role to perform the action on resources of the type. For example, this method could be used to revoke a group scope permission to edit blog posts.

Depending on the scope, the value of primKey will have different meanings. For more information, see ResourcePermissionImpl.

Specified by:

removeResourcePermission in interface ResourcePermissionService

Parameters:

groupId - the primary key of the group

companyId - the primary key of the company

name - the resource's name, which can be either a class name or a portlet ID

scope - the scope

primKey - the primary key

roleId - the primary key of the role

actionId - the action ID

Throws:

PortalException - if the user did not have permission to remove resource permissions, or if a role with the primary key or a resource action with the name and action ID could not be found

SystemException - if a system exception occurred

removeResourcePermissions

public void removeResourcePermissions(long groupId,
                                      long companyId,
                                      String name,
                                      int scope,
                                      long roleId,
                                      String actionId)
                               throws PortalException,
                                      SystemException

Revokes all permissions at the scope from the role to perform the action on resources of the type. For example, this method could be used to revoke all individual scope permissions to edit blog posts from site members.

Specified by:

removeResourcePermissions in interface ResourcePermissionService

Parameters:

groupId - the primary key of the group

companyId - the primary key of the company

name - the resource's name, which can be either a class name or a portlet ID

scope - the scope

roleId - the primary key of the role

actionId - the action ID

Throws:

PortalException - if the user did not have permission to remove resource permissions, or if a role with the primary key or a resource action with the name and action ID could not be found

SystemException - if a system exception occurred

setIndividualResourcePermissions

public void setIndividualResourcePermissions(long groupId,
                                             long companyId,
                                             String name,
                                             String primKey,
                                             long roleId,
                                             String[] actionIds)
                                      throws PortalException,
                                             SystemException

Updates the role's permissions at the scope, setting the actions that can be performed on resources of the type. Existing actions are replaced.

This method can be used to set permissions at any scope, but it is generally only used at the individual scope. For example, it could be used to set the guest permissions on a blog post.

Depending on the scope, the value of primKey will have different meanings. For more information, see ResourcePermissionImpl.

Specified by:

setIndividualResourcePermissions in interface ResourcePermissionService

Parameters:

groupId - the primary key of the group

companyId - the primary key of the company

name - the resource's name, which can be either a class name or a portlet ID

primKey - the primary key

roleId - the primary key of the role

actionIds - the action IDs of the actions

Throws:

PortalException - if the user did not have permission to set resource permissions, or if a role with the primary key or a resource action with the name and action ID could not be found

SystemException - if a system exception occurred

setIndividualResourcePermissions

public void setIndividualResourcePermissions(long groupId,
                                             long companyId,
                                             String name,
                                             String primKey,
                                             Map<Long,String[]> roleIdsToActionIds)
                                      throws PortalException,
                                             SystemException

Updates the role's permissions at the scope, setting the actions that can be performed on resources of the type. Existing actions are replaced.

This method can be used to set permissions at any scope, but it is generally only used at the individual scope. For example, it could be used to set the guest permissions on a blog post.

Depending on the scope, the value of primKey will have different meanings. For more information, see ResourcePermissionImpl.

Specified by:

setIndividualResourcePermissions in interface ResourcePermissionService

Parameters:

groupId - the primary key of the group

companyId - the primary key of the company

name - the resource's name, which can be either a class name or a portlet ID

primKey - the primary key

roleIdsToActionIds - a map of role IDs to action IDs of the actions

Throws:

PortalException - if the user did not have permission to set resource permissions, or if a role with the primary key or a resource action with the name and action ID could not be found

SystemException - if a system exception occurred

getWrappedResourcePermissionService

public ResourcePermissionService getWrappedResourcePermissionService()

Deprecated. As of 6.1.0, replaced by getWrappedService()

setWrappedResourcePermissionService

public void setWrappedResourcePermissionService(ResourcePermissionService resourcePermissionService)

Deprecated. As of 6.1.0, replaced by setWrappedService(com.liferay.portal.service.ResourcePermissionService)

getWrappedService

public ResourcePermissionService getWrappedService()

Specified by:

getWrappedService in interface ServiceWrapper<ResourcePermissionService>

setWrappedService

public void setWrappedService(ResourcePermissionService resourcePermissionService)

Specified by:

setWrappedService in interface ServiceWrapper<ResourcePermissionService>