Class ResourcePermissionLocalServiceWrapper

Object
com.liferay.portal.kernel.service.ResourcePermissionLocalServiceWrapper
All Implemented Interfaces:
BaseLocalService, CTService<ResourcePermission>, PersistedModelLocalService, ResourcePermissionLocalService, ServiceWrapper<ResourcePermissionLocalService>

public class ResourcePermissionLocalServiceWrapper extends Object implements ResourcePermissionLocalService, ServiceWrapper<ResourcePermissionLocalService>
Provides a wrapper for ResourcePermissionLocalService.
Author:
Brian Wing Shun Chan
See Also:
{$generated.description}
  • Constructor Details

    • ResourcePermissionLocalServiceWrapper

      public ResourcePermissionLocalServiceWrapper()
    • ResourcePermissionLocalServiceWrapper

      public ResourcePermissionLocalServiceWrapper(ResourcePermissionLocalService resourcePermissionLocalService)
  • Method Details

    • addModelResourcePermissions

      public void addModelResourcePermissions(AuditedModel auditedModel, ServiceContext serviceContext) throws PortalException
      Specified by:
      addModelResourcePermissions in interface ResourcePermissionLocalService
      Throws:
      PortalException
    • addModelResourcePermissions

      public void addModelResourcePermissions(long companyId, long groupId, long userId, String name, String primKey, ModelPermissions modelPermissions) throws PortalException
      Specified by:
      addModelResourcePermissions in interface ResourcePermissionLocalService
      Throws:
      PortalException
    • addModelResourcePermissions

      public void addModelResourcePermissions(long companyId, long groupId, long userId, String name, String primKey, String[] groupPermissions, String[] guestPermissions) throws PortalException
      Adds resources for the model with the name and primary key string, always creating a resource at the individual scope and only creating resources at the group, group template, and company scope if such resources don't already exist.
      Specified by:
      addModelResourcePermissions in interface ResourcePermissionLocalService
      Parameters:
      companyId - the primary key of the portal instance
      groupId - the primary key of the group
      userId - the primary key of the user adding the resources
      name - a name for the resource, typically the model's class name
      primKey - the primary key string of the model instance, optionally an empty string if no instance exists
      groupPermissions - the group permissions to be applied
      guestPermissions - the guest permissions to be applied
      Throws:
      PortalException
    • addResourcePermission

      public void addResourcePermission(long companyId, String name, int scope, String primKey, long roleId, String actionId) throws PortalException
      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 ResourcePermissionLocalService
      Parameters:
      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
    • addResourcePermission

      public ResourcePermission addResourcePermission(ResourcePermission resourcePermission)
      Adds the resource permission to the database. Also notifies the appropriate model listeners.

      Important: Inspect ResourcePermissionLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Specified by:
      addResourcePermission in interface ResourcePermissionLocalService
      Parameters:
      resourcePermission - the resource permission
      Returns:
      the resource permission that was added
    • addResourcePermissions

      public void addResourcePermissions(long companyId, long groupId, long userId, String name, String primKey, boolean portletActions, ServiceContext serviceContext) throws PortalException
      Adds resources for the entity with the name and primary key string, always creating a resource at the individual scope and only creating resources at the group, group template, and company scope if such resources don't already exist.
      Specified by:
      addResourcePermissions in interface ResourcePermissionLocalService
      Parameters:
      companyId - the primary key of the portal instance
      groupId - the primary key of the group
      userId - the primary key of the user adding the resources
      name - a name for the resource, which should be a portlet ID if the resource is a portlet or the resource's class name otherwise
      primKey - the primary key string of the resource instance, optionally an empty string if no instance exists
      portletActions - whether to associate portlet actions with the resource
      Throws:
      PortalException
    • addResourcePermissions

      public void addResourcePermissions(long companyId, long groupId, long userId, String name, String[] primKeys, boolean portletActions, ServiceContext serviceContext) throws PortalException
      Specified by:
      addResourcePermissions in interface ResourcePermissionLocalService
      Throws:
      PortalException
    • addResourcePermissions

      public void addResourcePermissions(String resourceName, String roleName, int scope, long resourceActionBitwiseValue)
      Grants the role permissions at the scope to perform the actions on all resources of the type. Existing actions are retained.

      This method should only be used to add default permissions to existing resources en masse during upgrades or while verifying permissions. For example, this method could be used to grant site members individual scope permissions to view all blog posts.

      Specified by:
      addResourcePermissions in interface ResourcePermissionLocalService
      Parameters:
      resourceName - the resource's name, which can be either a class name or a portlet ID
      roleName - the role's name
      scope - the scope
      resourceActionBitwiseValue - the bitwise IDs of the actions
    • copyModelResourcePermissions

      public void copyModelResourcePermissions(long companyId, String name, long sourcePrimKey, long targetPrimKey) throws PortalException
      Specified by:
      copyModelResourcePermissions in interface ResourcePermissionLocalService
      Throws:
      PortalException
    • createPersistedModel

      public PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
      Specified by:
      createPersistedModel in interface PersistedModelLocalService
      Specified by:
      createPersistedModel in interface ResourcePermissionLocalService
      Throws:
      PortalException
      PortalException
    • createResourcePermission

      public ResourcePermission createResourcePermission(long resourcePermissionId)
      Creates a new resource permission with the primary key. Does not add the resource permission to the database.
      Specified by:
      createResourcePermission in interface ResourcePermissionLocalService
      Parameters:
      resourcePermissionId - the primary key for the new resource permission
      Returns:
      the new resource permission
    • deletePersistedModel

      public PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
      Specified by:
      deletePersistedModel in interface PersistedModelLocalService
      Specified by:
      deletePersistedModel in interface ResourcePermissionLocalService
      Throws:
      PortalException
      PortalException
    • deleteResourcePermission

      public ResourcePermission deleteResourcePermission(long resourcePermissionId) throws PortalException
      Deletes the resource permission with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect ResourcePermissionLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Specified by:
      deleteResourcePermission in interface ResourcePermissionLocalService
      Parameters:
      resourcePermissionId - the primary key of the resource permission
      Returns:
      the resource permission that was removed
      Throws:
      PortalException - if a resource permission with the primary key could not be found
      PortalException
    • deleteResourcePermission

      public ResourcePermission deleteResourcePermission(ResourcePermission resourcePermission)
      Deletes the resource permission from the database. Also notifies the appropriate model listeners.

      Important: Inspect ResourcePermissionLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Specified by:
      deleteResourcePermission in interface ResourcePermissionLocalService
      Parameters:
      resourcePermission - the resource permission
      Returns:
      the resource permission that was removed
    • deleteResourcePermissions

      public void deleteResourcePermissions(long companyId, String name, int scope) throws PortalException
      Specified by:
      deleteResourcePermissions in interface ResourcePermissionLocalService
      Throws:
      PortalException
    • deleteResourcePermissions

      public void deleteResourcePermissions(long companyId, String name, int scope, long primKey) throws PortalException
      Deletes all resource permissions at the scope to resources of the type. This method should not be confused with any of the removeResourcePermission methods, as its purpose is very different. This method should only be used for deleting resource permissions that refer to a resource when that resource is deleted. For example this method could be used to delete all individual scope permissions to a blog post when it is deleted.

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

      Specified by:
      deleteResourcePermissions in interface ResourcePermissionLocalService
      Parameters:
      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
      Throws:
      PortalException
    • deleteResourcePermissions

      public void deleteResourcePermissions(long companyId, String name, int scope, String primKey) throws PortalException
      Deletes all resource permissions at the scope to resources of the type. This method should not be confused with any of the removeResourcePermission methods, as its purpose is very different. This method should only be used for deleting resource permissions that refer to a resource when that resource is deleted. For example this method could be used to delete all individual scope permissions to a blog post when it is deleted.

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

      Specified by:
      deleteResourcePermissions in interface ResourcePermissionLocalService
      Parameters:
      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
      Throws:
      PortalException
    • deleteResourcePermissions

      public void deleteResourcePermissions(String name)
      Specified by:
      deleteResourcePermissions in interface ResourcePermissionLocalService
    • dslQuery

      public <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQuery in interface PersistedModelLocalService
      Specified by:
      dslQuery in interface ResourcePermissionLocalService
    • dslQueryCount

      public int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQueryCount in interface PersistedModelLocalService
      Specified by:
      dslQueryCount in interface ResourcePermissionLocalService
    • dynamicQuery

      public DynamicQuery dynamicQuery()
      Specified by:
      dynamicQuery in interface ResourcePermissionLocalService
    • dynamicQuery

      public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
      Performs a dynamic query on the database and returns the matching rows.
      Specified by:
      dynamicQuery in interface ResourcePermissionLocalService
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the matching rows
    • dynamicQuery

      public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
      Performs a dynamic query on the database and returns a range of the matching rows.

      Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.ResourcePermissionModelImpl.

      Specified by:
      dynamicQuery in interface ResourcePermissionLocalService
      Parameters:
      dynamicQuery - the dynamic query
      start - the lower bound of the range of model instances
      end - the upper bound of the range of model instances (not inclusive)
      Returns:
      the range of matching rows
    • dynamicQuery

      public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator)
      Performs a dynamic query on the database and returns an ordered range of the matching rows.

      Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.ResourcePermissionModelImpl.

      Specified by:
      dynamicQuery in interface ResourcePermissionLocalService
      Parameters:
      dynamicQuery - the dynamic query
      start - the lower bound of the range of model instances
      end - the upper bound of the range of model instances (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the ordered range of matching rows
    • dynamicQueryCount

      public long dynamicQueryCount(DynamicQuery dynamicQuery)
      Returns the number of rows matching the dynamic query.
      Specified by:
      dynamicQueryCount in interface ResourcePermissionLocalService
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the number of rows matching the dynamic query
    • dynamicQueryCount

      public long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
      Returns the number of rows matching the dynamic query.
      Specified by:
      dynamicQueryCount in interface ResourcePermissionLocalService
      Parameters:
      dynamicQuery - the dynamic query
      projection - the projection to apply to the query
      Returns:
      the number of rows matching the dynamic query
    • fetchResourcePermission

      public ResourcePermission fetchResourcePermission(long resourcePermissionId)
      Specified by:
      fetchResourcePermission in interface ResourcePermissionLocalService
    • fetchResourcePermission

      public ResourcePermission fetchResourcePermission(long companyId, String name, int scope, String primKey, long roleId)
      Specified by:
      fetchResourcePermission in interface ResourcePermissionLocalService
    • getActionableDynamicQuery

      public ActionableDynamicQuery getActionableDynamicQuery()
      Specified by:
      getActionableDynamicQuery in interface ResourcePermissionLocalService
    • getAvailableResourcePermissionActionIds

      public Map<Long,Set<String>> getAvailableResourcePermissionActionIds(long companyId, String name, int scope, String primKey, Collection<String> actionIds)
      Specified by:
      getAvailableResourcePermissionActionIds in interface ResourcePermissionLocalService
    • getAvailableResourcePermissionActionIds

      public List<String> getAvailableResourcePermissionActionIds(long companyId, String name, int scope, String primKey, long roleId, Collection<String> actionIds) throws PortalException
      Returns the intersection of action IDs the role has permission at the scope to perform on resources of the type.
      Specified by:
      getAvailableResourcePermissionActionIds in interface ResourcePermissionLocalService
      Parameters:
      companyId - he 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
      actionIds - the action IDs
      Returns:
      the intersection of action IDs the role has permission at the scope to perform on resources of the type
      Throws:
      PortalException
    • getIndexableActionableDynamicQuery

      public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
      Specified by:
      getIndexableActionableDynamicQuery in interface ResourcePermissionLocalService
    • getIndividualPortletResourcePermissions

      public Map<String,List<ResourcePermission>> getIndividualPortletResourcePermissions(long companyId)
      Specified by:
      getIndividualPortletResourcePermissions in interface ResourcePermissionLocalService
    • getOSGiServiceIdentifier

      public String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Specified by:
      getOSGiServiceIdentifier in interface ResourcePermissionLocalService
      Returns:
      the OSGi service identifier
    • getPersistedModel

      public PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
      Specified by:
      getPersistedModel in interface PersistedModelLocalService
      Specified by:
      getPersistedModel in interface ResourcePermissionLocalService
      Throws:
      PortalException
      PortalException
    • getResourcePermission

      public ResourcePermission getResourcePermission(long resourcePermissionId) throws PortalException
      Returns the resource permission with the primary key.
      Specified by:
      getResourcePermission in interface ResourcePermissionLocalService
      Parameters:
      resourcePermissionId - the primary key of the resource permission
      Returns:
      the resource permission
      Throws:
      PortalException - if a resource permission with the primary key could not be found
      PortalException
    • getResourcePermission

      public ResourcePermission getResourcePermission(long companyId, String name, int scope, String primKey, long roleId) throws PortalException
      Returns the resource permission for the role at the scope to perform the actions on resources of the type.
      Specified by:
      getResourcePermission in interface ResourcePermissionLocalService
      Parameters:
      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
      Returns:
      the resource permission for the role at the scope to perform the actions on resources of the type
      Throws:
      PortalException
    • getResourcePermissions

      public List<ResourcePermission> getResourcePermissions(int start, int end)
      Returns a range of all the resource permissions.

      Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.ResourcePermissionModelImpl.

      Specified by:
      getResourcePermissions in interface ResourcePermissionLocalService
      Parameters:
      start - the lower bound of the range of resource permissions
      end - the upper bound of the range of resource permissions (not inclusive)
      Returns:
      the range of resource permissions
    • getResourcePermissions

      public List<ResourcePermission> getResourcePermissions(long companyId, String name, int scope, long roleId, boolean viewActionId)
      Specified by:
      getResourcePermissions in interface ResourcePermissionLocalService
    • getResourcePermissions

      public List<ResourcePermission> getResourcePermissions(long companyId, String name, int scope, String primKey)
      Returns all the resource permissions at the scope of the type.
      Specified by:
      getResourcePermissions in interface ResourcePermissionLocalService
      Parameters:
      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
      Returns:
      the resource permissions at the scope of the type
    • getResourcePermissions

      public List<ResourcePermission> getResourcePermissions(String name)
      Specified by:
      getResourcePermissions in interface ResourcePermissionLocalService
    • getResourcePermissionsCount

      public int getResourcePermissionsCount()
      Returns the number of resource permissions.
      Specified by:
      getResourcePermissionsCount in interface ResourcePermissionLocalService
      Returns:
      the number of resource permissions
    • getResourcePermissionsCount

      public int getResourcePermissionsCount(long companyId, String name, int scope, String primKey)
      Returns the number of resource permissions at the scope of the type.
      Specified by:
      getResourcePermissionsCount in interface ResourcePermissionLocalService
      Parameters:
      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
      Returns:
      the number of resource permissions at the scope of the type
    • getResourceResourcePermissions

      public List<ResourcePermission> getResourceResourcePermissions(long companyId, long groupId, String name, String primKey)
      Returns the resource permissions that apply to the resource.
      Specified by:
      getResourceResourcePermissions in interface ResourcePermissionLocalService
      Parameters:
      companyId - the primary key of the resource's company
      groupId - the primary key of the resource's group
      name - the resource's name, which can be either a class name or a portlet ID
      primKey - the primary key of the resource
      Returns:
      the resource permissions associated with the resource
    • getRoleResourcePermissions

      public List<ResourcePermission> getRoleResourcePermissions(long roleId)
      Returns all the resource permissions for the role.
      Specified by:
      getRoleResourcePermissions in interface ResourcePermissionLocalService
      Parameters:
      roleId - the primary key of the role
      Returns:
      the resource permissions for the role
    • getRoleResourcePermissions

      public List<ResourcePermission> getRoleResourcePermissions(long roleId, int[] scopes, int start, int end)
      Returns a range of all the resource permissions for the role at the scopes.

      Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

      Specified by:
      getRoleResourcePermissions in interface ResourcePermissionLocalService
      Parameters:
      roleId - the primary key of the role
      scopes - the scopes
      start - the lower bound of the range of results
      end - the upper bound of the range of results (not inclusive)
      Returns:
      the range of resource permissions for the role at the scopes
    • getRoles

      public List<Role> getRoles(long companyId, String name, int scope, String primKey, String actionId) throws PortalException
      Specified by:
      getRoles in interface ResourcePermissionLocalService
      Throws:
      PortalException
    • getScopeResourcePermissions

      public List<ResourcePermission> getScopeResourcePermissions(int[] scopes)
      Returns all the resource permissions where scope = any ?.

      Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

      Specified by:
      getScopeResourcePermissions in interface ResourcePermissionLocalService
      Parameters:
      scopes - the scopes
      Returns:
      the resource permissions where scope = any ?
    • hasActionId

      public boolean hasActionId(ResourcePermission resourcePermission, ResourceAction resourceAction)
      Returns true if the resource permission grants permission to perform the resource action. Note that this method does not ensure that the resource permission refers to the same type of resource as the resource action.
      Specified by:
      hasActionId in interface ResourcePermissionLocalService
      Parameters:
      resourcePermission - the resource permission
      resourceAction - the resource action
      Returns:
      true if the resource permission grants permission to perform the resource action
    • hasResourcePermission

      public boolean hasResourcePermission(List<Resource> resources, long[] roleIds, String actionId) throws PortalException
      Returns true if the roles have permission at the scope to perform the action on the resources.

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

      Specified by:
      hasResourcePermission in interface ResourcePermissionLocalService
      Parameters:
      resources - the resources
      roleIds - the primary keys of the roles
      actionId - the action ID
      Returns:
      true if any one of the roles has permission to perform the action on any one of the resources; false otherwise
      Throws:
      PortalException
    • hasResourcePermission

      public boolean hasResourcePermission(long companyId, String name, int scope, String primKey, long roleId, String actionId) throws PortalException
      Returns true if the role has permission at the scope to perform the action on resources of the type.

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

      Specified by:
      hasResourcePermission in interface ResourcePermissionLocalService
      Parameters:
      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
      Returns:
      true if the role has permission to perform the action on the resource; false otherwise
      Throws:
      PortalException
    • hasResourcePermission

      public boolean hasResourcePermission(long companyId, String name, int scope, String primKey, long[] roleIds, String actionId) throws PortalException
      Returns true if the roles have permission at the scope to perform the action on resources of the type.

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

      Specified by:
      hasResourcePermission in interface ResourcePermissionLocalService
      Parameters:
      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
      roleIds - the primary keys of the roles
      actionId - the action ID
      Returns:
      true if any one of the roles has permission to perform the action on the resource; false otherwise
      Throws:
      PortalException
    • hasScopeResourcePermission

      public boolean hasScopeResourcePermission(long companyId, String name, int scope, long roleId, String actionId) throws PortalException
      Returns true if the role has permission at the scope to perform the action on the resource.

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

      Specified by:
      hasScopeResourcePermission in interface ResourcePermissionLocalService
      Parameters:
      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
      Returns:
      true if the role has permission to perform the action on the resource; false otherwise
      Throws:
      PortalException
    • initDefaultModelResourcePermissions

      public void initDefaultModelResourcePermissions(long companyId, Collection<String> modelResources) throws PortalException
      Specified by:
      initDefaultModelResourcePermissions in interface ResourcePermissionLocalService
      Throws:
      PortalException
    • initPortletDefaultPermissions

      public void initPortletDefaultPermissions(Portlet portlet) throws PortalException
      Specified by:
      initPortletDefaultPermissions in interface ResourcePermissionLocalService
      Throws:
      PortalException
    • mergePermissions

      public void mergePermissions(long fromRoleId, long toRoleId) throws PortalException
      Reassigns all the resource permissions from the source role to the destination role, and deletes the source role.
      Specified by:
      mergePermissions in interface ResourcePermissionLocalService
      Parameters:
      fromRoleId - the primary key of the source role
      toRoleId - the primary key of the destination role
      Throws:
      PortalException
    • reassignPermissions

      public void reassignPermissions(long resourcePermissionId, long toRoleId) throws PortalException
      Grants the role default permissions to all the resources of the type and at the scope stored in the resource permission, deletes the resource permission, and deletes the resource permission's role if it has no permissions remaining.
      Specified by:
      reassignPermissions in interface ResourcePermissionLocalService
      Parameters:
      resourcePermissionId - the primary key of the resource permission
      toRoleId - the primary key of the role
      Throws:
      PortalException
    • removeResourcePermission

      public void removeResourcePermission(long companyId, String name, int scope, String primKey, long roleId, String actionId) throws PortalException
      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 ResourcePermissionLocalService
      Parameters:
      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
    • removeResourcePermissions

      public void removeResourcePermissions(long companyId, String name, int scope, long roleId, String actionId) throws PortalException
      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 ResourcePermissionLocalService
      Parameters:
      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
    • setOwnerResourcePermissions

      public void setOwnerResourcePermissions(long companyId, String name, int scope, String primKey, long roleId, long ownerId, String[] actionIds) throws PortalException
      Updates the role's permissions at the scope, setting the actions that can be performed on resources of the type, also setting the owner of any newly created resource permissions. 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:
      setOwnerResourcePermissions in interface ResourcePermissionLocalService
      Parameters:
      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
      ownerId - the primary key of the owner (generally the user that created the resource)
      actionIds - the action IDs of the actions
      Throws:
      PortalException
    • setResourcePermissions

      public void setResourcePermissions(long companyId, String name, int scope, String primKey, long roleId, String[] actionIds) throws PortalException
      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:
      setResourcePermissions in interface ResourcePermissionLocalService
      Parameters:
      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
      actionIds - the action IDs of the actions
      Throws:
      PortalException
    • setResourcePermissions

      public void setResourcePermissions(long companyId, String name, int scope, String primKey, Map<Long,String[]> roleIdsToActionIds) throws PortalException
      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:
      setResourcePermissions in interface ResourcePermissionLocalService
      Parameters:
      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
      roleIdsToActionIds - a map of role IDs to action IDs of the actions
      Throws:
      PortalException
    • updateModelResourcePermissions

      public void updateModelResourcePermissions(AuditedModel auditedModel, ServiceContext serviceContext) throws PortalException
      Updates the resources for the model, replacing their group and guest permissions with new ones from the service context.
      Specified by:
      updateModelResourcePermissions in interface ResourcePermissionLocalService
      Parameters:
      auditedModel - the model associated with the resources
      serviceContext - the service context to be applied. Can set group and guest permissions.
      Throws:
      PortalException
    • updateResourcePermission

      public ResourcePermission updateResourcePermission(ResourcePermission resourcePermission)
      Updates the resource permission in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect ResourcePermissionLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Specified by:
      updateResourcePermission in interface ResourcePermissionLocalService
      Parameters:
      resourcePermission - the resource permission
      Returns:
      the resource permission that was updated
    • updateResourcePermissions

      public void updateResourcePermissions(long companyId, long groupId, String name, long primKey, String[] groupPermissions, String[] guestPermissions) throws PortalException
      Updates resources matching the group, name, and primary key at the individual scope, setting new group and guest permissions.
      Specified by:
      updateResourcePermissions in interface ResourcePermissionLocalService
      Parameters:
      companyId - the primary key of the portal instance
      groupId - the primary key of the group
      name - the resource's name, which should be a portlet ID if the resource is a portlet or the resource's class name otherwise
      primKey - the primary key of the resource instance
      groupPermissions - the group permissions to be applied
      guestPermissions - the guest permissions to be applied
      Throws:
      PortalException
    • updateResourcePermissions

      public void updateResourcePermissions(long companyId, long groupId, String name, String primKey, ModelPermissions modelPermissions) throws PortalException
      Specified by:
      updateResourcePermissions in interface ResourcePermissionLocalService
      Throws:
      PortalException
    • updateResourcePermissions

      public void updateResourcePermissions(long companyId, long groupId, String name, String primKey, String[] groupPermissions, String[] guestPermissions) throws PortalException
      Specified by:
      updateResourcePermissions in interface ResourcePermissionLocalService
      Throws:
      PortalException
    • updateResourcePermissions

      public void updateResourcePermissions(long companyId, String name, int scope, String primKey, String newPrimKey)
      Specified by:
      updateResourcePermissions in interface ResourcePermissionLocalService
    • getBasePersistence

      public BasePersistence<?> getBasePersistence()
      Specified by:
      getBasePersistence in interface PersistedModelLocalService
    • getCTPersistence

      public CTPersistence<ResourcePermission> getCTPersistence()
      Specified by:
      getCTPersistence in interface CTService<ResourcePermission>
      Specified by:
      getCTPersistence in interface ResourcePermissionLocalService
    • getModelClass

      public Class<ResourcePermission> getModelClass()
      Specified by:
      getModelClass in interface CTService<ResourcePermission>
      Specified by:
      getModelClass in interface ResourcePermissionLocalService
    • updateWithUnsafeFunction

      public <R, E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<ResourcePermission>,R,E> updateUnsafeFunction) throws E
      Specified by:
      updateWithUnsafeFunction in interface CTService<ResourcePermission>
      Specified by:
      updateWithUnsafeFunction in interface ResourcePermissionLocalService
      Throws:
      E extends Throwable
    • getWrappedService

      public ResourcePermissionLocalService getWrappedService()
      Specified by:
      getWrappedService in interface ServiceWrapper<ResourcePermissionLocalService>
    • setWrappedService

      public void setWrappedService(ResourcePermissionLocalService resourcePermissionLocalService)
      Specified by:
      setWrappedService in interface ServiceWrapper<ResourcePermissionLocalService>