Liferay 6.1.2-ce-ga3

com.liferay.portal.service
Interface PermissionLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
PermissionLocalServiceBaseImpl, PermissionLocalServiceImpl, PermissionLocalServiceWrapper

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

The interface for the 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:
PermissionLocalServiceUtil, PermissionLocalServiceBaseImpl, PermissionLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 void addGroupPermission(long groupId, long permissionId)
           
 void addGroupPermission(long groupId, Permission permission)
           
 void addGroupPermissions(long groupId, List<Permission> Permissions)
           
 void addGroupPermissions(long groupId, long[] permissionIds)
           
 Permission addPermission(long companyId, String actionId, long resourceId)
          Adds a permission to perform the action on the resource.
 Permission addPermission(Permission permission)
          Adds the permission to the database.
 List<Permission> addPermissions(long companyId, List<String> actionIds, long resourceId)
          Adds permissions to perform the actions on the resource.
 List<Permission> addPermissions(long companyId, String name, long resourceId, boolean portletActions)
          Adds permissions to perform either the portlet resource actions or model resource actions on the resource.
 void addRolePermission(long roleId, long permissionId)
           
 void addRolePermission(long roleId, Permission permission)
           
 void addRolePermissions(long roleId, List<Permission> Permissions)
           
 void addRolePermissions(long roleId, long[] permissionIds)
           
 void addUserPermission(long userId, long permissionId)
           
 void addUserPermission(long userId, Permission permission)
           
 void addUserPermissions(long userId, List<Permission> Permissions)
           
 void addUserPermissions(long userId, long[] permissionIds)
           
 void addUserPermissions(long userId, String[] actionIds, long resourceId)
          Adds user permissions to perform the actions on the resource.
 void checkPermissions(String name, List<String> actionIds)
          Checks to see if the actions are permitted on the named resource.
 void clearGroupPermissions(long groupId)
           
 void clearRolePermissions(long roleId)
           
 void clearUserPermissions(long userId)
           
 Permission createPermission(long permissionId)
          Creates a new permission with the primary key.
 void deleteGroupPermission(long groupId, long permissionId)
           
 void deleteGroupPermission(long groupId, Permission permission)
           
 void deleteGroupPermissions(long groupId, List<Permission> Permissions)
           
 void deleteGroupPermissions(long groupId, long[] permissionIds)
           
 Permission deletePermission(long permissionId)
          Deletes the permission with the primary key from the database.
 Permission deletePermission(Permission permission)
          Deletes the permission from the database.
 void deleteRolePermission(long roleId, long permissionId)
           
 void deleteRolePermission(long roleId, Permission permission)
           
 void deleteRolePermissions(long roleId, List<Permission> Permissions)
           
 void deleteRolePermissions(long roleId, long[] permissionIds)
           
 void deleteUserPermission(long userId, long permissionId)
           
 void deleteUserPermission(long userId, Permission permission)
           
 void deleteUserPermissions(long userId, List<Permission> Permissions)
           
 void deleteUserPermissions(long userId, long[] permissionIds)
           
 DynamicQuery dynamicQuery()
           
 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.
 Permission fetchPermission(long permissionId)
           
 List<String> getActions(List<Permission> permissions)
          Returns the IDs of all the actions belonging to the permissions.
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 List<Permission> getGroupPermissions(long groupId)
           
 List<Permission> getGroupPermissions(long groupId, int start, int end)
           
 List<Permission> getGroupPermissions(long groupId, int start, int end, OrderByComparator orderByComparator)
           
 List<Permission> getGroupPermissions(long groupId, long resourceId)
          Returns all the group's permissions on the resource.
 List<Permission> getGroupPermissions(long groupId, long companyId, String name, int scope, String primKey)
          Returns all the group's permissions on the named resource with the scope and primKey.
 int getGroupPermissionsCount(long groupId)
           
 long getLatestPermissionId()
          Returns the primary key of the latest permission created.
 List<Permission> getOrgGroupPermissions(long organizationId, long groupId, long resourceId)
          Returns all the permissions of the organization's group with respect to the resource.
 Permission getPermission(long permissionId)
          Returns the permission with the primary key.
 List<Permission> getPermissions(int start, int end)
          Returns a range of all the permissions.
 List<Permission> getPermissions(long companyId, String[] actionIds, long resourceId)
          Returns all the permissions to perform the actions on the resource, creating new permissions for any permissions not found.
 int getPermissionsCount()
          Returns the number of permissions.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 List<Permission> getRolePermissions(long roleId)
           
 List<Permission> getRolePermissions(long roleId, int[] scopes)
           
 List<Permission> getRolePermissions(long roleId, int start, int end)
           
 List<Permission> getRolePermissions(long roleId, int start, int end, OrderByComparator orderByComparator)
           
 List<Permission> getRolePermissions(long roleId, long resourceId)
          Returns all the role's permissions on the resource.
 int getRolePermissionsCount(long roleId)
           
 List<Permission> getUserPermissions(long userId)
           
 List<Permission> getUserPermissions(long userId, int start, int end)
           
 List<Permission> getUserPermissions(long userId, int start, int end, OrderByComparator orderByComparator)
           
 List<Permission> getUserPermissions(long userId, long resourceId)
          Returns all the user's permissions on the resource.
 List<Permission> getUserPermissions(long userId, long companyId, String name, int scope, String primKey)
          Returns all the user's permissions on the named resource with the scope and primKey.
 int getUserPermissionsCount(long userId)
           
 boolean hasGroupPermission(long groupId, long permissionId)
           
 boolean hasGroupPermission(long groupId, String actionId, long resourceId)
          Returns true if the group has permission to perform the action on the resource.
 boolean hasGroupPermissions(long groupId)
           
 boolean hasRolePermission(long roleId, long permissionId)
           
 boolean hasRolePermission(long roleId, long companyId, String name, int scope, String actionId)
          Returns true if the role has permission to perform the action on the named resource with the scope.
 boolean hasRolePermission(long roleId, long companyId, String name, int scope, String primKey, String actionId)
          Returns true if the role has permission to perform the action on the named resource with the scope and primKey.
 boolean hasRolePermissions(long roleId)
           
 boolean hasUserPermission(long userId, long permissionId)
           
 boolean hasUserPermission(long userId, String actionId, long resourceId)
          Returns true if the user has permission to perform the action on the resource.
 boolean hasUserPermissions(long userId)
           
 boolean hasUserPermissions(long userId, long groupId, List<Resource> resources, String actionId, PermissionCheckerBag permissionCheckerBag)
          Returns true if the user has permission to perform the action on the resources.
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setContainerResourcePermissions(String name, String roleName, String actionId)
          Sets the container wide permissions of either the role or the default user of each company to perform the actions on the named resource.
 void setGroupPermissions(long groupId, long[] permissionIds)
           
 void setGroupPermissions(long groupId, String[] actionIds, long resourceId)
          Sets the group's permissions to perform the actions on the resource, replacing the group's existing permissions on the resource.
 void setGroupPermissions(String className, String classPK, long groupId, String[] actionIds, long resourceId)
          Sets the entity's group permissions to perform the actions on the resource, replacing the entity's existing group permissions on the resource.
 void setOrgGroupPermissions(long organizationId, long groupId, String[] actionIds, long resourceId)
          Sets the organization's group permissions to perform the actions on the resource, replacing the organization's existing group permissions on the resource.
 void setRolePermission(long roleId, long companyId, String name, int scope, String primKey, String actionId)
          Sets the role's permissions to perform the action on the named resource, replacing the role's existing permissions on the resource.
 void setRolePermissions(long roleId, long[] permissionIds)
           
 void setRolePermissions(long roleId, long companyId, String name, int scope, String primKey, String[] actionIds)
          Sets the role's permissions to perform the actions on the named resource, replacing the role's existing permission for each of these actions on the resource.
 void setRolePermissions(long roleId, String[] actionIds, long resourceId)
          Sets the role's permissions to perform the actions on the resource, replacing the role's existing permissions on the resource.
 void setRolesPermissions(long companyId, Map<Long,String[]> roleIdsToActionIds, long resourceId)
          Sets the permissions of each role to perform respective actions on the resource, replacing the existing permissions of each role on the resource.
 void setRolesPermissions(long companyId, Map<Long,String[]> roleIdsToActionIds, String name, int scope, String primKey)
          Sets the permissions of each role to perform respective actions on the named resource, replacing the existing permissions of each role on the resource.
 void setUserPermissions(long userId, long[] permissionIds)
           
 void setUserPermissions(long userId, String[] actionIds, long resourceId)
          Sets the user's permissions to perform the actions on the resource, replacing the user's existing permissions on the resource.
 void unsetRolePermission(long roleId, long permissionId)
          Removes the permission from the role.
 void unsetRolePermission(long roleId, long companyId, String name, int scope, String primKey, String actionId)
          Removes the role's permissions to perform the action on the named resource with the scope and primKey.
 void unsetRolePermissions(long roleId, long companyId, String name, int scope, String actionId)
          Removes the role's permissions to perform the action on the named resource.
 void unsetUserPermissions(long userId, String[] actionIds, long resourceId)
          Removes the user's permissions to perform the actions on the resource.
 Permission updatePermission(Permission permission)
          Updates the permission in the database or adds it if it does not yet exist.
 Permission updatePermission(Permission permission, boolean merge)
          Updates the permission in the database or adds it if it does not yet exist.
 

Method Detail

addPermission

Permission addPermission(Permission permission)
                         throws SystemException
Adds the permission to the database. Also notifies the appropriate model listeners.

Parameters:
permission - the permission
Returns:
the permission that was added
Throws:
SystemException - if a system exception occurred

createPermission

Permission createPermission(long permissionId)
Creates a new permission with the primary key. Does not add the permission to the database.

Parameters:
permissionId - the primary key for the new permission
Returns:
the new permission

deletePermission

Permission deletePermission(long permissionId)
                            throws PortalException,
                                   SystemException
Deletes the permission with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
permissionId - the primary key of the permission
Returns:
the permission that was removed
Throws:
PortalException - if a permission with the primary key could not be found
SystemException - if a system exception occurred

deletePermission

Permission deletePermission(Permission permission)
                            throws SystemException
Deletes the permission from the database. Also notifies the appropriate model listeners.

Parameters:
permission - the permission
Returns:
the permission that was removed
Throws:
SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

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

fetchPermission

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Permission fetchPermission(long permissionId)
                           throws SystemException
Throws:
SystemException

getPermission

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Permission getPermission(long permissionId)
                         throws PortalException,
                                SystemException
Returns the permission with the primary key.

Parameters:
permissionId - the primary key of the permission
Returns:
the permission
Throws:
PortalException - if a 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

getPermissions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Permission> getPermissions(int start,
                                                                         int end)
                                throws SystemException
Returns a range of all the 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 permissions
end - the upper bound of the range of permissions (not inclusive)
Returns:
the range of permissions
Throws:
SystemException - if a system exception occurred

getPermissionsCount

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

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

updatePermission

Permission updatePermission(Permission permission)
                            throws SystemException
Updates the permission in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
permission - the permission
Returns:
the permission that was updated
Throws:
SystemException - if a system exception occurred

updatePermission

Permission updatePermission(Permission permission,
                            boolean merge)
                            throws SystemException
Updates the permission in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
permission - the permission
merge - whether to merge the 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 permission that was updated
Throws:
SystemException - if a system exception occurred

addGroupPermission

void addGroupPermission(long groupId,
                        long permissionId)
                        throws SystemException
Throws:
SystemException - if a system exception occurred

addGroupPermission

void addGroupPermission(long groupId,
                        Permission permission)
                        throws SystemException
Throws:
SystemException - if a system exception occurred

addGroupPermissions

void addGroupPermissions(long groupId,
                         long[] permissionIds)
                         throws SystemException
Throws:
SystemException - if a system exception occurred

addGroupPermissions

void addGroupPermissions(long groupId,
                         List<Permission> Permissions)
                         throws SystemException
Throws:
SystemException - if a system exception occurred

clearGroupPermissions

void clearGroupPermissions(long groupId)
                           throws SystemException
Throws:
SystemException - if a system exception occurred

deleteGroupPermission

void deleteGroupPermission(long groupId,
                           long permissionId)
                           throws SystemException
Throws:
SystemException - if a system exception occurred

deleteGroupPermission

void deleteGroupPermission(long groupId,
                           Permission permission)
                           throws SystemException
Throws:
SystemException - if a system exception occurred

deleteGroupPermissions

void deleteGroupPermissions(long groupId,
                            long[] permissionIds)
                            throws SystemException
Throws:
SystemException - if a system exception occurred

deleteGroupPermissions

void deleteGroupPermissions(long groupId,
                            List<Permission> Permissions)
                            throws SystemException
Throws:
SystemException - if a system exception occurred

getGroupPermissions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Permission> getGroupPermissions(long groupId)
                                     throws SystemException
Throws:
SystemException - if a system exception occurred

getGroupPermissions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Permission> getGroupPermissions(long groupId,
                                                                              int start,
                                                                              int end)
                                     throws SystemException
Throws:
SystemException - if a system exception occurred

getGroupPermissions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Permission> getGroupPermissions(long groupId,
                                                                              int start,
                                                                              int end,
                                                                              OrderByComparator orderByComparator)
                                     throws SystemException
Throws:
SystemException - if a system exception occurred

getGroupPermissionsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getGroupPermissionsCount(long groupId)
                             throws SystemException
Throws:
SystemException - if a system exception occurred

hasGroupPermission

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasGroupPermission(long groupId,
                                                                    long permissionId)
                           throws SystemException
Throws:
SystemException - if a system exception occurred

hasGroupPermissions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasGroupPermissions(long groupId)
                            throws SystemException
Throws:
SystemException - if a system exception occurred

setGroupPermissions

void setGroupPermissions(long groupId,
                         long[] permissionIds)
                         throws SystemException
Throws:
SystemException - if a system exception occurred

addRolePermission

void addRolePermission(long roleId,
                       long permissionId)
                       throws SystemException
Throws:
SystemException - if a system exception occurred

addRolePermission

void addRolePermission(long roleId,
                       Permission permission)
                       throws SystemException
Throws:
SystemException - if a system exception occurred

addRolePermissions

void addRolePermissions(long roleId,
                        long[] permissionIds)
                        throws SystemException
Throws:
SystemException - if a system exception occurred

addRolePermissions

void addRolePermissions(long roleId,
                        List<Permission> Permissions)
                        throws SystemException
Throws:
SystemException - if a system exception occurred

clearRolePermissions

void clearRolePermissions(long roleId)
                          throws SystemException
Throws:
SystemException - if a system exception occurred

deleteRolePermission

void deleteRolePermission(long roleId,
                          long permissionId)
                          throws SystemException
Throws:
SystemException - if a system exception occurred

deleteRolePermission

void deleteRolePermission(long roleId,
                          Permission permission)
                          throws SystemException
Throws:
SystemException - if a system exception occurred

deleteRolePermissions

void deleteRolePermissions(long roleId,
                           long[] permissionIds)
                           throws SystemException
Throws:
SystemException - if a system exception occurred

deleteRolePermissions

void deleteRolePermissions(long roleId,
                           List<Permission> Permissions)
                           throws SystemException
Throws:
SystemException - if a system exception occurred

getRolePermissions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Permission> getRolePermissions(long roleId)
                                    throws SystemException
Throws:
SystemException - if a system exception occurred

getRolePermissions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Permission> getRolePermissions(long roleId,
                                                                             int start,
                                                                             int end)
                                    throws SystemException
Throws:
SystemException - if a system exception occurred

getRolePermissions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Permission> getRolePermissions(long roleId,
                                                                             int start,
                                                                             int end,
                                                                             OrderByComparator orderByComparator)
                                    throws SystemException
Throws:
SystemException - if a system exception occurred

getRolePermissionsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getRolePermissionsCount(long roleId)
                            throws SystemException
Throws:
SystemException - if a system exception occurred

hasRolePermission

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasRolePermission(long roleId,
                                                                   long permissionId)
                          throws SystemException
Throws:
SystemException - if a system exception occurred

hasRolePermissions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasRolePermissions(long roleId)
                           throws SystemException
Throws:
SystemException - if a system exception occurred

setRolePermissions

void setRolePermissions(long roleId,
                        long[] permissionIds)
                        throws SystemException
Throws:
SystemException - if a system exception occurred

addUserPermission

void addUserPermission(long userId,
                       long permissionId)
                       throws SystemException
Throws:
SystemException - if a system exception occurred

addUserPermission

void addUserPermission(long userId,
                       Permission permission)
                       throws SystemException
Throws:
SystemException - if a system exception occurred

addUserPermissions

void addUserPermissions(long userId,
                        long[] permissionIds)
                        throws SystemException
Throws:
SystemException - if a system exception occurred

addUserPermissions

void addUserPermissions(long userId,
                        List<Permission> Permissions)
                        throws SystemException
Throws:
SystemException - if a system exception occurred

clearUserPermissions

void clearUserPermissions(long userId)
                          throws SystemException
Throws:
SystemException - if a system exception occurred

deleteUserPermission

void deleteUserPermission(long userId,
                          long permissionId)
                          throws SystemException
Throws:
SystemException - if a system exception occurred

deleteUserPermission

void deleteUserPermission(long userId,
                          Permission permission)
                          throws SystemException
Throws:
SystemException - if a system exception occurred

deleteUserPermissions

void deleteUserPermissions(long userId,
                           long[] permissionIds)
                           throws SystemException
Throws:
SystemException - if a system exception occurred

deleteUserPermissions

void deleteUserPermissions(long userId,
                           List<Permission> Permissions)
                           throws SystemException
Throws:
SystemException - if a system exception occurred

getUserPermissions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Permission> getUserPermissions(long userId)
                                    throws SystemException
Throws:
SystemException - if a system exception occurred

getUserPermissions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Permission> getUserPermissions(long userId,
                                                                             int start,
                                                                             int end)
                                    throws SystemException
Throws:
SystemException - if a system exception occurred

getUserPermissions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Permission> getUserPermissions(long userId,
                                                                             int start,
                                                                             int end,
                                                                             OrderByComparator orderByComparator)
                                    throws SystemException
Throws:
SystemException - if a system exception occurred

getUserPermissionsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getUserPermissionsCount(long userId)
                            throws SystemException
Throws:
SystemException - if a system exception occurred

hasUserPermission

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasUserPermission(long userId,
                                                                   long permissionId)
                          throws SystemException
Throws:
SystemException - if a system exception occurred

hasUserPermissions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasUserPermissions(long userId)
                           throws SystemException
Throws:
SystemException - if a system exception occurred

setUserPermissions

void setUserPermissions(long userId,
                        long[] permissionIds)
                        throws SystemException
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

addPermission

Permission addPermission(long companyId,
                         String actionId,
                         long resourceId)
                         throws SystemException
Adds a permission to perform the action on the resource.

This method will retrieve the permission of the company, action, and resource with the primary keys. The method creates the permission if it fails to retrieve it.

Parameters:
companyId - the primary key of the company
actionId - the action's ID
resourceId - the primary key of the resource
Returns:
the permission of the company, action, and resource with the primary keys
Throws:
SystemException - if a system exception occurred

addPermissions

List<Permission> addPermissions(long companyId,
                                List<String> actionIds,
                                long resourceId)
                                throws SystemException
Adds permissions to perform the actions on the resource.

This method will retrieve the permissions of the company, actions, and resource with the primary keys. The method creates any permissions it fails to retrieve.

Parameters:
companyId - the primary key of the company
actionIds - the primary keys of the actions
resourceId - the primary key of the resource
Returns:
the permissions to perform the actions on the resource
Throws:
SystemException - if a system exception occurred

addPermissions

List<Permission> addPermissions(long companyId,
                                String name,
                                long resourceId,
                                boolean portletActions)
                                throws SystemException
Adds permissions to perform either the portlet resource actions or model resource actions on the resource.

This method will retrieve the permissions of the company, actions, and resource with the primary keys. The method creates any permissions it fails to retrieve.

Parameters:
companyId - the primary key of the company
name - the resource name
resourceId - the primary key of the resource
portletActions - whether to retrieve the action primary keys from the portlet or the model resource
Returns:
the permissions to perform the actions on the resource
Throws:
SystemException - if a system exception occurred

addUserPermissions

void addUserPermissions(long userId,
                        String[] actionIds,
                        long resourceId)
                        throws PortalException,
                               SystemException
Adds user permissions to perform the actions on the resource.

Parameters:
userId - the primary key of the user
actionIds - the primary keys of the actions
resourceId - the primary key of the resource
Throws:
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred

checkPermissions

void checkPermissions(String name,
                      List<String> actionIds)
                      throws PortalException,
                             SystemException
Checks to see if the actions are permitted on the named resource.

Parameters:
name - the resource name
actionIds - the primary keys of the actions
Throws:
PortalException - if the resource company or name could not be found or were invalid
SystemException - if a system exception occurred

getActions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<String> getActions(List<Permission> permissions)
Returns the IDs of all the actions belonging to the permissions.

Parameters:
permissions - the permissions
Returns:
the IDs of all the actions belonging to the permissions

getGroupPermissions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Permission> getGroupPermissions(long groupId,
                                                                              long resourceId)
                                     throws SystemException
Returns all the group's permissions on the resource.

Parameters:
groupId - the primary key of the group
resourceId - the primary key of the resource
Returns:
the group's permissions on the resource
Throws:
SystemException - if a system exception occurred

getGroupPermissions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Permission> getGroupPermissions(long groupId,
                                                                              long companyId,
                                                                              String name,
                                                                              int scope,
                                                                              String primKey)
                                     throws SystemException
Returns all the group's permissions on the named resource with the scope and primKey.

Parameters:
groupId - the primary key of the group
companyId - the primary key of the company
name - the resource name
scope - the resource scope
primKey - the resource primKey
Returns:
the group's permissions on the named resource with the scope and primKey
Throws:
SystemException - if a system exception occurred

getLatestPermissionId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long getLatestPermissionId()
                           throws SystemException
Returns the primary key of the latest permission created.

Returns:
the primary key of the latest permission created
Throws:
SystemException - if a system exception occurred

getOrgGroupPermissions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Permission> getOrgGroupPermissions(long organizationId,
                                                                                 long groupId,
                                                                                 long resourceId)
                                        throws SystemException
Returns all the permissions of the organization's group with respect to the resource.

Parameters:
organizationId - the primary key of the organization
groupId - the primary key of the group
resourceId - the primary key of the resource
Returns:
the permissions of the organization's group with respect to the resource
Throws:
SystemException - if a system exception occurred

getPermissions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Permission> getPermissions(long companyId,
                                                                         String[] actionIds,
                                                                         long resourceId)
                                throws SystemException
Returns all the permissions to perform the actions on the resource, creating new permissions for any permissions not found.

Parameters:
companyId - the primary key of the company
actionIds - the primary keys of the actions
resourceId - the primary key of the resource
Returns:
the permissions to perform the actions on the resource
Throws:
SystemException - if a system exception occurred
See Also:
addPermission(long, String, long)

getRolePermissions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Permission> getRolePermissions(long roleId,
                                                                             int[] scopes)
                                    throws SystemException
Throws:
SystemException

getRolePermissions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Permission> getRolePermissions(long roleId,
                                                                             long resourceId)
                                    throws SystemException
Returns all the role's permissions on the resource.

Parameters:
roleId - the primary key of the role
resourceId - the primary key of the resource
Returns:
the role's permissions on the resource
Throws:
SystemException - if a system exception occurred

getUserPermissions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Permission> getUserPermissions(long userId,
                                                                             long resourceId)
                                    throws SystemException
Returns all the user's permissions on the resource.

Parameters:
userId - the primary key of the user
resourceId - the primary key of the resource
Returns:
the user's permissions on the resource
Throws:
SystemException - if a system exception occurred

getUserPermissions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Permission> getUserPermissions(long userId,
                                                                             long companyId,
                                                                             String name,
                                                                             int scope,
                                                                             String primKey)
                                    throws SystemException
Returns all the user's permissions on the named resource with the scope and primKey.

Parameters:
userId - the primary key of the user
companyId - the primary key of the company
name - the resource name
scope - the resource scope
primKey - the resource primKey
Returns:
the user permissions of the resource name, scope, and primKey
Throws:
SystemException - if a system exception occurred

hasGroupPermission

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasGroupPermission(long groupId,
                                                                    String actionId,
                                                                    long resourceId)
                           throws SystemException
Returns true if the group has permission to perform the action on the resource.

Parameters:
groupId - the primary key of the group
actionId - the action's ID
resourceId - the primary key of the resource
Returns:
true if the group has permission to perform the action on the resource; false otherwise
Throws:
SystemException - if a system exception occurred

hasRolePermission

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasRolePermission(long roleId,
                                                                   long companyId,
                                                                   String name,
                                                                   int scope,
                                                                   String actionId)
                          throws SystemException
Returns true if the role has permission to perform the action on the named resource with the scope.

Parameters:
roleId - the primary key of the role
companyId - the primary key of the company
name - the resource name
scope - the resource scope
actionId - the action's ID
Returns:
true if the role has permission to perform the action on the named resource with the scope; false otherwise
Throws:
SystemException - if a system exception occurred

hasRolePermission

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasRolePermission(long roleId,
                                                                   long companyId,
                                                                   String name,
                                                                   int scope,
                                                                   String primKey,
                                                                   String actionId)
                          throws SystemException
Returns true if the role has permission to perform the action on the named resource with the scope and primKey.

Parameters:
roleId - the primary key of the role
companyId - the primary key of the company
name - the resource name
scope - the resource scope
primKey - the resource primKey
actionId - the action's ID
Returns:
true if the role has permission to perform the action on the named resource with the scope and primKey; false otherwise
Throws:
SystemException - if a system exception occurred

hasUserPermission

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasUserPermission(long userId,
                                                                   String actionId,
                                                                   long resourceId)
                          throws SystemException
Returns true if the user has permission to perform the action on the resource.

Parameters:
userId - the primary key of the user
actionId - the action's ID
resourceId - the primary key of the resource
Returns:
true if the user has permission to perform the action on the resource; false otherwise
Throws:
SystemException - if a system exception occurred

hasUserPermissions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasUserPermissions(long userId,
                                                                    long groupId,
                                                                    List<Resource> resources,
                                                                    String actionId,
                                                                    PermissionCheckerBag permissionCheckerBag)
                           throws PortalException,
                                  SystemException
Returns true if the user has permission to perform the action on the resources.

This method does not support resources managed by the resource block system.

Parameters:
userId - the primary key of the user
groupId - the primary key of the group containing the resource
resources - representations of the resource at each scope level returned by AdvancedPermissionChecker.getResources( long, long, String, String, String)
actionId - the action's ID
permissionCheckerBag - the permission checker bag
Returns:
true if the user has permission to perform the action on the resources; false otherwise
Throws:
PortalException - if a resource action based on any one of the resources and the action ID could not be found
SystemException - if a system exception occurred

setContainerResourcePermissions

void setContainerResourcePermissions(String name,
                                     String roleName,
                                     String actionId)
                                     throws PortalException,
                                            SystemException
Sets the container wide permissions of either the role or the default user of each company to perform the actions on the named resource.

Parameters:
name - the resource name
roleName - the role name. Supported role names include RoleConstants.ORGANIZATION_USER, RoleConstants.OWNER, and RoleConstants.SITE_MEMBER.
actionId - the action's ID
Throws:
PortalException - if a matching role could not be found or if a default user for the company could not be found
SystemException - if a system exception occurred

setGroupPermissions

void setGroupPermissions(long groupId,
                         String[] actionIds,
                         long resourceId)
                         throws PortalException,
                                SystemException
Sets the group's permissions to perform the actions on the resource, replacing the group's existing permissions on the resource.

Parameters:
groupId - the primary key of the group
actionIds - the primary keys of the actions
resourceId - the primary key of the resource
Throws:
PortalException - if a group with the primary key could not be found
SystemException - if a system exception occurred

setGroupPermissions

void setGroupPermissions(String className,
                         String classPK,
                         long groupId,
                         String[] actionIds,
                         long resourceId)
                         throws PortalException,
                                SystemException
Sets the entity's group permissions to perform the actions on the resource, replacing the entity's existing group permissions on the resource. Only Organization and UserGroup class entities are supported.

Parameters:
className - the class name of an organization or user group
classPK - the primary key of the class
groupId - the primary key of the group
actionIds - the primary keys of the actions
resourceId - the primary key of the resource
Throws:
PortalException - if an entity with the class name and primary key could not be found or if the entity's associated group could not be found
SystemException - if a system exception occurred

setOrgGroupPermissions

void setOrgGroupPermissions(long organizationId,
                            long groupId,
                            String[] actionIds,
                            long resourceId)
                            throws PortalException,
                                   SystemException
Sets the organization's group permissions to perform the actions on the resource, replacing the organization's existing group permissions on the resource.

Parameters:
organizationId - the primary key of the organization
groupId - the primary key of the group in which to scope the permissions
actionIds - the primary keys of the actions
resourceId - the primary key of the resource
Throws:
PortalException - if an organization with the primary key could not be found
SystemException - if a system exception occurred

setRolePermission

void setRolePermission(long roleId,
                       long companyId,
                       String name,
                       int scope,
                       String primKey,
                       String actionId)
                       throws PortalException,
                              SystemException
Sets the role's permissions to perform the action on the named resource, replacing the role's existing permissions on the resource.

Parameters:
roleId - the primary key of the role
companyId - the primary key of the company
name - the resource name
scope - the resource scope
primKey - the resource primKey
actionId - the action's ID
Throws:
PortalException - if the scope was ResourceConstants.SCOPE_INDIVIDUAL
SystemException - if a system exception occurred

setRolePermissions

void setRolePermissions(long roleId,
                        long companyId,
                        String name,
                        int scope,
                        String primKey,
                        String[] actionIds)
                        throws PortalException,
                               SystemException
Sets the role's permissions to perform the actions on the named resource, replacing the role's existing permission for each of these actions on the resource.

Parameters:
roleId - the primary key of the role
companyId - the primary key of the company
name - the resource name
scope - the resource scope
primKey - the resource primKey
actionIds - the primary keys of the actions
Throws:
PortalException - if the scope was ResourceConstants.SCOPE_INDIVIDUAL
SystemException - if a system exception occurred

setRolePermissions

void setRolePermissions(long roleId,
                        String[] actionIds,
                        long resourceId)
                        throws PortalException,
                               SystemException
Sets the role's permissions to perform the actions on the resource, replacing the role's existing permissions on the resource.

Parameters:
roleId - the primary key of the role
actionIds - the primary keys of the actions
resourceId - the primary key of the resource
Throws:
PortalException - if a role with the primary key could not be found
SystemException - if a system exception occurred

setRolesPermissions

void setRolesPermissions(long companyId,
                         Map<Long,String[]> roleIdsToActionIds,
                         long resourceId)
                         throws SystemException
Sets the permissions of each role to perform respective actions on the resource, replacing the existing permissions of each role on the resource.

Parameters:
companyId - the primary key of the company
roleIdsToActionIds - the map of roles to their new actions on the resource
resourceId - the primary key of the resource
Throws:
SystemException - if a system exception occurred

setRolesPermissions

void setRolesPermissions(long companyId,
                         Map<Long,String[]> roleIdsToActionIds,
                         String name,
                         int scope,
                         String primKey)
                         throws SystemException
Sets the permissions of each role to perform respective actions on the named resource, replacing the existing permissions of each role on the resource.

Parameters:
companyId - the primary key of the company
roleIdsToActionIds - the map of roles to their new actions on the resource
name - the resource name
scope - the resource scope
primKey - the resource primKey
Throws:
SystemException - if a system exception occurred

setUserPermissions

void setUserPermissions(long userId,
                        String[] actionIds,
                        long resourceId)
                        throws PortalException,
                               SystemException
Sets the user's permissions to perform the actions on the resource, replacing the user's existing permissions on the resource.

Parameters:
userId - the primary key of the user
actionIds - the primary keys of the actions
resourceId - the primary key of the resource
Throws:
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred

unsetRolePermission

void unsetRolePermission(long roleId,
                         long permissionId)
                         throws SystemException
Removes the permission from the role.

Parameters:
roleId - the primary key of the role
permissionId - the primary key of the permission
Throws:
SystemException - if a system exception occurred

unsetRolePermission

void unsetRolePermission(long roleId,
                         long companyId,
                         String name,
                         int scope,
                         String primKey,
                         String actionId)
                         throws SystemException
Removes the role's permissions to perform the action on the named resource with the scope and primKey.

Parameters:
roleId - the primary key of the role
companyId - the primary key of the company
name - the resource name
scope - the resource scope
primKey - the resource primKey
actionId - the action's ID
Throws:
SystemException - if a system exception occurred

unsetRolePermissions

void unsetRolePermissions(long roleId,
                          long companyId,
                          String name,
                          int scope,
                          String actionId)
                          throws SystemException
Removes the role's permissions to perform the action on the named resource.

Parameters:
roleId - the primary key of the role
companyId - the primary key of the company
name - the resource name
scope - the resource scope
actionId - the action's ID
Throws:
SystemException - if a system exception occurred

unsetUserPermissions

void unsetUserPermissions(long userId,
                          String[] actionIds,
                          long resourceId)
                          throws SystemException
Removes the user's permissions to perform the actions on the resource.

Parameters:
userId - the primary key of the user
actionIds - the primary keys of the actions
resourceId - the primary key of the resource
Throws:
SystemException - if a system exception occurred

Liferay 6.1.2-ce-ga3