@AccessControlled @JSONWebService @ProviderType @Transactional(isolation=PORTAL, rollbackFor={PortalException.class,SystemException.class}) public interface ResourcePermissionService extends BaseService
ResourcePermissionServiceUtil,
ResourcePermissionServiceBaseImpl,
com.liferay.portal.service.impl.ResourcePermissionServiceImpl| Modifier and Type | Method and Description |
|---|---|
void |
addResourcePermission(long groupId,
long companyId,
java.lang.String name,
int scope,
java.lang.String primKey,
long roleId,
java.lang.String actionId)
Grants the role permission at the scope to perform the action on
resources of the type.
|
java.lang.String |
getBeanIdentifier()
Returns the Spring bean ID for this bean.
|
void |
removeResourcePermission(long groupId,
long companyId,
java.lang.String name,
int scope,
java.lang.String primKey,
long roleId,
java.lang.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,
java.lang.String name,
int scope,
long roleId,
java.lang.String actionId)
Revokes all permissions at the scope from the role to perform the action
on resources of the type.
|
void |
setBeanIdentifier(java.lang.String beanIdentifier)
Sets the Spring bean ID for this bean.
|
void |
setIndividualResourcePermissions(long groupId,
long companyId,
java.lang.String name,
java.lang.String primKey,
long roleId,
java.lang.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,
java.lang.String name,
java.lang.String primKey,
java.util.Map<java.lang.Long,java.lang.String[]> roleIdsToActionIds)
Updates the role's permissions at the scope, setting the actions that can
be performed on resources of the type.
|
void addResourcePermission(long groupId,
long companyId,
java.lang.String name,
int scope,
java.lang.String primKey,
long roleId,
java.lang.String actionId)
throws PortalException
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.
groupId - the primary key of the groupcompanyId - the primary key of the companyname - the resource's name, which can be either a class name or a
portlet IDscope - the scope. This method only supports company, group, and
group-template scope.primKey - the primary keyroleId - the primary key of the roleactionId - the action IDPortalException - 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 foundjava.lang.String getBeanIdentifier()
void removeResourcePermission(long groupId,
long companyId,
java.lang.String name,
int scope,
java.lang.String primKey,
long roleId,
java.lang.String actionId)
throws PortalException
Depending on the scope, the value of primKey will have
different meanings. For more information, see ResourcePermissionImpl.
groupId - the primary key of the groupcompanyId - the primary key of the companyname - the resource's name, which can be either a class name or a
portlet IDscope - the scopeprimKey - the primary keyroleId - the primary key of the roleactionId - the action IDPortalException - 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 foundvoid removeResourcePermissions(long groupId,
long companyId,
java.lang.String name,
int scope,
long roleId,
java.lang.String actionId)
throws PortalException
groupId - the primary key of the groupcompanyId - the primary key of the companyname - the resource's name, which can be either a class name or a
portlet IDscope - the scoperoleId - the primary key of the roleactionId - the action IDPortalException - 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 foundvoid setBeanIdentifier(java.lang.String beanIdentifier)
beanIdentifier - the Spring bean ID for this beanvoid setIndividualResourcePermissions(long groupId,
long companyId,
java.lang.String name,
java.lang.String primKey,
long roleId,
java.lang.String[] actionIds)
throws PortalException
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.
groupId - the primary key of the groupcompanyId - the primary key of the companyname - the resource's name, which can be either a class name or a
portlet IDprimKey - the primary keyroleId - the primary key of the roleactionIds - the action IDs of the actionsPortalException - 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 foundvoid setIndividualResourcePermissions(long groupId,
long companyId,
java.lang.String name,
java.lang.String primKey,
java.util.Map<java.lang.Long,java.lang.String[]> roleIdsToActionIds)
throws PortalException
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.
groupId - the primary key of the groupcompanyId - the primary key of the companyname - the resource's name, which can be either a class name or a
portlet IDprimKey - the primary keyroleIdsToActionIds - a map of role IDs to action IDs of the actionsPortalException - 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