Liferay 6.0-ee-sp2

com.liferay.portal.service
Interface ResourcePermissionLocalService

All Superinterfaces:
PersistedModelLocalService
All Known Implementing Classes:
ResourcePermissionLocalServiceWrapper

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

The interface for the resource permission local service.

This is a local service. 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, com.liferay.portal.service.impl.ResourcePermissionLocalServiceImpl

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.
 void deleteResourcePermission(long resourcePermissionId)
          Deletes the resource permission with the primary key from the database.
 void 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.
 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator 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 that match the dynamic query.
 List<String> getAvailableResourcePermissionActionIds(long companyId, String name, int scope, String primKey, long roleId, List<String> actionIds)
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 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)
           
 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)
           
 int getResourcePermissionsCount()
          Returns the number of resource permissions.
 int getResourcePermissionsCount(long companyId, String name, int scope, String primKey)
           
 List<ResourcePermission> getRoleResourcePermissions(long roleId)
           
 List<ResourcePermission> getRoleResourcePermissions(long roleId, int[] scopes, int start, int end)
           
 boolean hasActionId(ResourcePermission resourcePermission, ResourceAction resourceAction)
          Returns true if the resource permission grants permission to perform the resource action.
 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 hasScopeResourcePermission(long companyId, String name, int scope, long roleId, String actionId)
           
 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 setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 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.
 ResourcePermission updateResourcePermission(ResourcePermission resourcePermission)
          Updates the resource permission in the database or adds it if it does not yet exist.
 ResourcePermission updateResourcePermission(ResourcePermission resourcePermission, boolean merge)
          Updates the resource permission in the database or adds it if it does not yet exist.
 

Method Detail

addResourcePermission

ResourcePermission addResourcePermission(ResourcePermission resourcePermission)
                                         throws SystemException
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
Throws:
SystemException - if a system exception occurred

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

deleteResourcePermission

void deleteResourcePermission(long resourcePermissionId)
                              throws PortalException,
                                     SystemException
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
Throws:
PortalException - if a resource permission with the primary key could not be found
SystemException - if a system exception occurred

deleteResourcePermission

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

Parameters:
resourcePermission - the resource permission
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws SystemException
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.

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

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws SystemException
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.

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

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

getResourcePermission

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ResourcePermission getResourcePermission(long resourcePermissionId)
                                         throws PortalException,
                                                SystemException
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
SystemException - if a system exception occurred

getPersistedModel

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

getResourcePermissions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ResourcePermission> getResourcePermissions(int start,
                                                                                         int end)
                                                throws SystemException
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.

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

getResourcePermissionsCount

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

Returns:
the number of resource permissions
Throws:
SystemException - if a system exception occurred

updateResourcePermission

ResourcePermission updateResourcePermission(ResourcePermission resourcePermission)
                                            throws SystemException
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
Throws:
SystemException - if a system exception occurred

updateResourcePermission

ResourcePermission updateResourcePermission(ResourcePermission resourcePermission,
                                            boolean merge)
                                            throws SystemException
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
merge - whether to merge the resource permission with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.
Returns:
the resource permission that was updated
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

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

Returns:
the Spring bean ID for this bean

setBeanIdentifier

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

Parameters:
beanIdentifier - the Spring bean ID for this bean

addResourcePermission

void addResourcePermission(long companyId,
                           String name,
                           int scope,
                           String primKey,
                           long roleId,
                           String actionId)
                           throws PortalException,
                                  SystemException
Grants the role permission at the scope to perform the action on resources of the type. Existing actions are retained.

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

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

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

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 - if scope was set to individual scope or if a role with the primary key or a resource action with the name and action ID could not be found
SystemException - if a system exception occurred

addResourcePermissions

void addResourcePermissions(String resourceName,
                            String roleName,
                            int scope,
                            long resourceActionBitwiseValue)
                            throws SystemException
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
Throws:
SystemException - if a system exception occurred

deleteResourcePermissions

void deleteResourcePermissions(long companyId,
                               String name,
                               int scope,
                               long primKey)
                               throws PortalException,
                                      SystemException
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 - if a portal exception occurred
SystemException - if a system exception occurred

deleteResourcePermissions

void deleteResourcePermissions(long companyId,
                               String name,
                               int scope,
                               String primKey)
                               throws PortalException,
                                      SystemException
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 - if a portal exception occurred
SystemException - if a system exception occurred

getAvailableResourcePermissionActionIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<String> getAvailableResourcePermissionActionIds(long companyId,
                                                                                              String name,
                                                                                              int scope,
                                                                                              String primKey,
                                                                                              long roleId,
                                                                                              List<String> actionIds)
                                                     throws PortalException,
                                                            SystemException
Throws:
PortalException
SystemException

getResourcePermission

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ResourcePermission getResourcePermission(long companyId,
                                                                                  String name,
                                                                                  int scope,
                                                                                  String primKey,
                                                                                  long roleId)
                                         throws PortalException,
                                                SystemException
Throws:
PortalException
SystemException

getResourcePermissions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ResourcePermission> getResourcePermissions(long companyId,
                                                                                         String name,
                                                                                         int scope,
                                                                                         String primKey)
                                                throws SystemException
Throws:
SystemException

getResourcePermissionsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getResourcePermissionsCount(long companyId,
                                                                         String name,
                                                                         int scope,
                                                                         String primKey)
                                throws SystemException
Throws:
SystemException

getRoleResourcePermissions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ResourcePermission> getRoleResourcePermissions(long roleId)
                                                    throws SystemException
Throws:
SystemException

getRoleResourcePermissions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ResourcePermission> getRoleResourcePermissions(long roleId,
                                                                                             int[] scopes,
                                                                                             int start,
                                                                                             int end)
                                                    throws SystemException
Throws:
SystemException

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,
                                     SystemException
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 - if a role with the primary key or a resource action with the name and action ID could not be found
SystemException - if a system exception occurred

hasScopeResourcePermission

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasScopeResourcePermission(long companyId,
                                                                            String name,
                                                                            int scope,
                                                                            long roleId,
                                                                            String actionId)
                                   throws PortalException,
                                          SystemException
Throws:
PortalException
SystemException

mergePermissions

void mergePermissions(long fromRoleId,
                      long toRoleId)
                      throws PortalException,
                             SystemException
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 - if a role with the primary key could not be found
SystemException - if a system exception occurred

reassignPermissions

void reassignPermissions(long resourcePermissionId,
                         long toRoleId)
                         throws PortalException,
                                SystemException
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 - if a resource permission or role with the primary key could not be found
SystemException - if a system exception occurred

removeResourcePermission

void removeResourcePermission(long companyId,
                              String name,
                              int scope,
                              String primKey,
                              long roleId,
                              String actionId)
                              throws PortalException,
                                     SystemException
Revokes permission at the scope from the role to perform the action on resources of the type. For example, this method could be used to revoke a group scope permission to edit blog posts.

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

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 - if a role with the primary key or a resource action with the name and action ID could not be found
SystemException - if a system exception occurred

removeResourcePermissions

void removeResourcePermissions(long companyId,
                               String name,
                               int scope,
                               long roleId,
                               String actionId)
                               throws PortalException,
                                      SystemException
Revokes all permissions at the scope from the role to perform the action on resources of the type. For example, this method could be used to revoke all individual scope permissions to edit blog posts from site members.

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 - if a role with the primary key or a resource action with the name and action ID could not be found
SystemException - if a system exception occurred

setOwnerResourcePermissions

void setOwnerResourcePermissions(long companyId,
                                 String name,
                                 int scope,
                                 String primKey,
                                 long roleId,
                                 long ownerId,
                                 String[] actionIds)
                                 throws PortalException,
                                        SystemException
Updates the role's permissions at the scope, setting the actions that can be performed on resources of the type, 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 - if a role with the primary key or a resource action with the name and action ID could not be found
SystemException - if a system exception occurred

setResourcePermissions

void setResourcePermissions(long companyId,
                            String name,
                            int scope,
                            String primKey,
                            long roleId,
                            String[] actionIds)
                            throws PortalException,
                                   SystemException
Updates the role's permissions at the scope, setting the actions that can be performed on resources of the type. Existing actions are replaced.

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

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

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 - if a role with the primary key or a resource action with the name and action ID could not be found
SystemException - if a system exception occurred

Liferay 6.0-ee-sp2