Liferay 7.0-ce-b4

com.liferay.portal.service
Interface ResourcePermissionLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
ResourcePermissionLocalServiceBaseImpl, ResourcePermissionLocalServiceImpl, ResourcePermissionLocalServiceWrapper

@ProviderType
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface ResourcePermissionLocalService
extends BaseLocalService, PersistedModelLocalService

Provides the local service interface for ResourcePermission. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

See Also:
ResourcePermissionLocalServiceUtil, ResourcePermissionLocalServiceBaseImpl, ResourcePermissionLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 void addResourcePermission(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.
 ResourcePermission addResourcePermission(ResourcePermission resourcePermission)
          Adds the resource permission to the database.
 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.
 ResourcePermission createResourcePermission(long resourcePermissionId)
          Creates a new resource permission with the primary key.
 PersistedModel deletePersistedModel(PersistedModel persistedModel)
           
 ResourcePermission deleteResourcePermission(long resourcePermissionId)
          Deletes the resource permission with the primary key from the database.
 ResourcePermission deleteResourcePermission(ResourcePermission resourcePermission)
          Deletes the resource permission from the database.
 void deleteResourcePermissions(long companyId, String name, int scope, long primKey)
          Deletes all resource permissions at the scope to resources of the type.
 void deleteResourcePermissions(long companyId, String name, int scope, String primKey)
          Deletes all resource permissions at the scope to resources of the type.
 DynamicQuery dynamicQuery()
           
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
<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.
<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.
 long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows matching the dynamic query.
 long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows matching the dynamic query.
 ResourcePermission fetchResourcePermission(long resourcePermissionId)
           
 ResourcePermission fetchResourcePermission(long companyId, String name, int scope, String primKey, long roleId)
           
 ActionableDynamicQuery getActionableDynamicQuery()
           
 Map<Long,Set<String>> getAvailableResourcePermissionActionIds(long companyId, String name, int scope, String primKey, Collection<String> actionIds)
           
 Map<Long,Set<String>> getAvailableResourcePermissionActionIds(long companyId, String name, int scope, String primKey, long[] roleIds, Collection<String> actionIds)
          Deprecated. As of 7.0.0, replaced by getAvailableResourcePermissionActionIds(long, String, int, String, Collection)
 List<String> getAvailableResourcePermissionActionIds(long companyId, String name, int scope, String primKey, long roleId, Collection<String> actionIds)
          Returns the intersection of action IDs the role has permission at the scope to perform on resources of the type.
 IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
           
 String getOSGiServiceIdentifier()
          Returns the OSGi service identifier.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 ResourcePermission getResourcePermission(long resourcePermissionId)
          Returns the resource permission with the primary key.
 ResourcePermission getResourcePermission(long companyId, String name, int scope, String primKey, long roleId)
          Returns the resource permission for the role at the scope to perform the actions on resources of the type.
 List<ResourcePermission> getResourcePermissions(int start, int end)
          Returns a range of all the resource permissions.
 List<ResourcePermission> getResourcePermissions(long companyId, String name, int scope, String primKey)
          Returns all the resource permissions at the scope of the type.
 int getResourcePermissionsCount()
          Returns the number of resource permissions.
 int getResourcePermissionsCount(long companyId, String name, int scope, String primKey)
          Returns the number of resource permissions at the scope of the type.
 List<ResourcePermission> getResourceResourcePermissions(long companyId, long groupId, String name, String primKey)
          Returns the resource permissions that apply to the resource.
 List<ResourcePermission> getRoleResourcePermissions(long roleId)
          Returns all the resource permissions for the role.
 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.
 List<Role> getRoles(long companyId, String name, int scope, String primKey, String actionId)
           
 List<ResourcePermission> getScopeResourcePermissions(int[] scopes)
          Returns all the resource permissions where scope = any ?.
 boolean hasActionId(ResourcePermission resourcePermission, ResourceAction resourceAction)
          Returns true if the resource permission grants permission to perform the resource action.
 boolean hasResourcePermission(List<Resource> resources, long[] roleIds, String actionId)
          Returns true if the roles have permission at the scope to perform the action on the resources.
 boolean hasResourcePermission(long companyId, String name, int scope, String primKey, long[] roleIds, String actionId)
          Returns true if the roles have permission at the scope to perform the action on resources of the type.
 boolean hasResourcePermission(long companyId, String name, int scope, String primKey, long roleId, String actionId)
          Returns true if the role has permission at the scope to perform the action on resources of the type.
 boolean[] hasResourcePermissions(long companyId, String name, int scope, String primKey, long[] roleIds, String actionId)
          Deprecated. As of 7.0.0, replaced by #getRoles(long, String, int, String, String
 boolean hasScopeResourcePermission(long companyId, String name, int scope, long roleId, String actionId)
          Returns true if the role has permission at the scope to perform the action on the resource.
 void mergePermissions(long fromRoleId, long toRoleId)
          Reassigns all the resource permissions from the source role to the destination role, and deletes the source role.
 void reassignPermissions(long resourcePermissionId, long toRoleId)
          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.
 void removeResourcePermission(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 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 setOwnerResourcePermissions(long companyId, String name, int scope, String primKey, long roleId, long ownerId, String[] actionIds)
          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.
 void setResourcePermissions(long companyId, String name, int scope, 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 setResourcePermissions(long companyId, String name, int scope, 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.
 ResourcePermission updateResourcePermission(ResourcePermission resourcePermission)
          Updates the resource permission in the database or adds it if it does not yet exist.
 

Method Detail

addResourcePermission

@Retry(acceptor=ExceptionRetryAcceptor.class,
       properties=@Property(name="EXCEPTION_NAME",value="org.springframework.dao.DataIntegrityViolationException"))
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.

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

@Indexable(type=REINDEX)
ResourcePermission addResourcePermission(ResourcePermission resourcePermission)
Adds the resource permission to the database. Also notifies the appropriate model listeners.

Parameters:
resourcePermission - the resource permission
Returns:
the resource permission that was added

addResourcePermissions

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.

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

createResourcePermission

ResourcePermission createResourcePermission(long resourcePermissionId)
Creates a new resource permission with the primary key. Does not add the resource permission to the database.

Parameters:
resourcePermissionId - the primary key for the new resource permission
Returns:
the new resource permission

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                    throws PortalException
Specified by:
deletePersistedModel in interface PersistedModelLocalService
Throws:
PortalException

deleteResourcePermission

@Indexable(type=DELETE)
ResourcePermission deleteResourcePermission(ResourcePermission resourcePermission)
Deletes the resource permission from the database. Also notifies the appropriate model listeners.

Parameters:
resourcePermission - the resource permission
Returns:
the resource permission that was removed

deleteResourcePermission

@Indexable(type=DELETE)
ResourcePermission deleteResourcePermission(long resourcePermissionId)
                                            throws PortalException
Deletes the resource permission with the primary key from the database. Also notifies the appropriate model listeners.

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

deleteResourcePermissions

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.

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

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.

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

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

<T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows

dynamicQuery

<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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ResourcePermissionModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

<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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ResourcePermissionModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

long dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows matching the dynamic query

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                       Projection projection)
Returns the number of rows matching the dynamic query.

Parameters:
dynamicQuery - the dynamic query
projection - the projection to apply to the query
Returns:
the number of rows matching the dynamic query

fetchResourcePermission

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ResourcePermission fetchResourcePermission(long companyId,
                                                                                    String name,
                                                                                    int scope,
                                                                                    String primKey,
                                                                                    long roleId)

fetchResourcePermission

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ResourcePermission fetchResourcePermission(long resourcePermissionId)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getAvailableResourcePermissionActionIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Map<Long,Set<String>> getAvailableResourcePermissionActionIds(long companyId,
                                                                                                       String name,
                                                                                                       int scope,
                                                                                                       String primKey,
                                                                                                       Collection<String> actionIds)

getAvailableResourcePermissionActionIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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.

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

getAvailableResourcePermissionActionIds

@Deprecated
@Transactional(propagation=SUPPORTS,
               readOnly=true)
Map<Long,Set<String>> getAvailableResourcePermissionActionIds(long companyId,
                                                                                                                  String name,
                                                                                                                  int scope,
                                                                                                                  String primKey,
                                                                                                                  long[] roleIds,
                                                                                                                  Collection<String> actionIds)
Deprecated. As of 7.0.0, replaced by getAvailableResourcePermissionActionIds(long, String, int, String, Collection)


getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()
Returns the OSGi service identifier.

Returns:
the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException

getResourcePermission

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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.

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

getResourcePermission

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ResourcePermission getResourcePermission(long resourcePermissionId)
                                         throws PortalException
Returns the resource permission with the primary key.

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

getResourcePermissions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ResourcePermission> getResourcePermissions(long companyId,
                                                                                         String name,
                                                                                         int scope,
                                                                                         String primKey)
Returns all the resource permissions at the scope of the type.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ResourcePermissionModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

getResourcePermissionsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getResourcePermissionsCount()
Returns the number of resource permissions.

Returns:
the number of resource permissions

getResourcePermissionsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getResourcePermissionsCount(long companyId,
                                                                         String name,
                                                                         int scope,
                                                                         String primKey)
Returns the number of resource permissions at the scope of the type.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ResourcePermission> getResourceResourcePermissions(long companyId,
                                                                                                 long groupId,
                                                                                                 String name,
                                                                                                 String primKey)
Returns the resource permissions that apply to the resource.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ResourcePermission> getRoleResourcePermissions(long roleId)
Returns all the resource permissions for the role.

Parameters:
roleId - the primary key of the role
Returns:
the resource permissions for the role

getRoleResourcePermissions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Role> getRoles(long companyId,
                                                             String name,
                                                             int scope,
                                                             String primKey,
                                                             String actionId)
                    throws PortalException
Throws:
PortalException

getScopeResourcePermissions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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.

Parameters:
scopes - the scopes
Returns:
the resource permissions where scope = any ?

hasActionId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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.

Parameters:
resourcePermission - the resource permission
resourceAction - the resource action
Returns:
true if the resource permission grants permission to perform the resource action

hasResourcePermission

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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.

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

hasResourcePermission

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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.

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

hasResourcePermissions

@Deprecated
@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean[] hasResourcePermissions(long companyId,
                                                                                     String name,
                                                                                     int scope,
                                                                                     String primKey,
                                                                                     long[] roleIds,
                                                                                     String actionId)
                                 throws PortalException
Deprecated. As of 7.0.0, replaced by #getRoles(long, String, int, String, String

Throws:
PortalException

hasScopeResourcePermission

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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.

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

mergePermissions

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.

Parameters:
fromRoleId - the primary key of the source role
toRoleId - the primary key of the destination role
Throws:
PortalException

reassignPermissions

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.

Parameters:
resourcePermissionId - the primary key of the resource permission
toRoleId - the primary key of the role
Throws:
PortalException

removeResourcePermission

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.

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

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.

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

@Retry(acceptor=ExceptionRetryAcceptor.class,
       properties=@Property(name="EXCEPTION_NAME",value="org.springframework.dao.DataIntegrityViolationException"))
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.

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

@Retry(acceptor=ExceptionRetryAcceptor.class,
       properties=@Property(name="EXCEPTION_NAME",value="org.springframework.dao.DataIntegrityViolationException"))
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.

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

@Retry(acceptor=ExceptionRetryAcceptor.class,
       properties=@Property(name="EXCEPTION_NAME",value="org.springframework.dao.DataIntegrityViolationException"))
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.

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

updateResourcePermission

@Indexable(type=REINDEX)
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.

Parameters:
resourcePermission - the resource permission
Returns:
the resource permission that was updated

Liferay 7.0-ce-b4