Liferay 6.1.2-ce-ga3

com.liferay.portal.service
Class PermissionLocalServiceUtil

java.lang.Object
  extended by com.liferay.portal.service.PermissionLocalServiceUtil

public class PermissionLocalServiceUtil
extends Object

The utility for the permission local service. This utility wraps PermissionLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

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

Constructor Summary
PermissionLocalServiceUtil()
           
 
Method Summary
static void addGroupPermission(long groupId, long permissionId)
           
static void addGroupPermission(long groupId, Permission permission)
           
static void addGroupPermissions(long groupId, List<Permission> Permissions)
           
static void addGroupPermissions(long groupId, long[] permissionIds)
           
static Permission addPermission(long companyId, String actionId, long resourceId)
          Adds a permission to perform the action on the resource.
static Permission addPermission(Permission permission)
          Adds the permission to the database.
static List<Permission> addPermissions(long companyId, List<String> actionIds, long resourceId)
          Adds permissions to perform the actions on the resource.
static 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.
static void addRolePermission(long roleId, long permissionId)
           
static void addRolePermission(long roleId, Permission permission)
           
static void addRolePermissions(long roleId, List<Permission> Permissions)
           
static void addRolePermissions(long roleId, long[] permissionIds)
           
static void addUserPermission(long userId, long permissionId)
           
static void addUserPermission(long userId, Permission permission)
           
static void addUserPermissions(long userId, List<Permission> Permissions)
           
static void addUserPermissions(long userId, long[] permissionIds)
           
static void addUserPermissions(long userId, String[] actionIds, long resourceId)
          Adds user permissions to perform the actions on the resource.
static void checkPermissions(String name, List<String> actionIds)
          Checks to see if the actions are permitted on the named resource.
static void clearGroupPermissions(long groupId)
           
static void clearRolePermissions(long roleId)
           
static void clearUserPermissions(long userId)
           
static Permission createPermission(long permissionId)
          Creates a new permission with the primary key.
static void deleteGroupPermission(long groupId, long permissionId)
           
static void deleteGroupPermission(long groupId, Permission permission)
           
static void deleteGroupPermissions(long groupId, List<Permission> Permissions)
           
static void deleteGroupPermissions(long groupId, long[] permissionIds)
           
static Permission deletePermission(long permissionId)
          Deletes the permission with the primary key from the database.
static Permission deletePermission(Permission permission)
          Deletes the permission from the database.
static void deleteRolePermission(long roleId, long permissionId)
           
static void deleteRolePermission(long roleId, Permission permission)
           
static void deleteRolePermissions(long roleId, List<Permission> Permissions)
           
static void deleteRolePermissions(long roleId, long[] permissionIds)
           
static void deleteUserPermission(long userId, long permissionId)
           
static void deleteUserPermission(long userId, Permission permission)
           
static void deleteUserPermissions(long userId, List<Permission> Permissions)
           
static void deleteUserPermissions(long userId, long[] permissionIds)
           
static DynamicQuery dynamicQuery()
           
static List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
static 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.
static long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows that match the dynamic query.
static Permission fetchPermission(long permissionId)
           
static List<String> getActions(List<Permission> permissions)
          Returns the IDs of all the actions belonging to the permissions.
static String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
static List<Permission> getGroupPermissions(long groupId)
           
static List<Permission> getGroupPermissions(long groupId, int start, int end)
           
static List<Permission> getGroupPermissions(long groupId, int start, int end, OrderByComparator orderByComparator)
           
static List<Permission> getGroupPermissions(long groupId, long resourceId)
          Returns all the group's permissions on the resource.
static 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.
static int getGroupPermissionsCount(long groupId)
           
static long getLatestPermissionId()
          Returns the primary key of the latest permission created.
static List<Permission> getOrgGroupPermissions(long organizationId, long groupId, long resourceId)
          Returns all the permissions of the organization's group with respect to the resource.
static Permission getPermission(long permissionId)
          Returns the permission with the primary key.
static List<Permission> getPermissions(int start, int end)
          Returns a range of all the permissions.
static 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.
static int getPermissionsCount()
          Returns the number of permissions.
static PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
static List<Permission> getRolePermissions(long roleId)
           
static List<Permission> getRolePermissions(long roleId, int[] scopes)
           
static List<Permission> getRolePermissions(long roleId, int start, int end)
           
static List<Permission> getRolePermissions(long roleId, int start, int end, OrderByComparator orderByComparator)
           
static List<Permission> getRolePermissions(long roleId, long resourceId)
          Returns all the role's permissions on the resource.
static int getRolePermissionsCount(long roleId)
           
static PermissionLocalService getService()
           
static List<Permission> getUserPermissions(long userId)
           
static List<Permission> getUserPermissions(long userId, int start, int end)
           
static List<Permission> getUserPermissions(long userId, int start, int end, OrderByComparator orderByComparator)
           
static List<Permission> getUserPermissions(long userId, long resourceId)
          Returns all the user's permissions on the resource.
static 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.
static int getUserPermissionsCount(long userId)
           
static boolean hasGroupPermission(long groupId, long permissionId)
           
static boolean hasGroupPermission(long groupId, String actionId, long resourceId)
          Returns true if the group has permission to perform the action on the resource.
static boolean hasGroupPermissions(long groupId)
           
static boolean hasRolePermission(long roleId, long permissionId)
           
static 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.
static 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.
static boolean hasRolePermissions(long roleId)
           
static boolean hasUserPermission(long userId, long permissionId)
           
static boolean hasUserPermission(long userId, String actionId, long resourceId)
          Returns true if the user has permission to perform the action on the resource.
static boolean hasUserPermissions(long userId)
           
static 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.
static void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
static 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.
static void setGroupPermissions(long groupId, long[] permissionIds)
           
static 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.
static 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.
static 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.
static 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.
static void setRolePermissions(long roleId, long[] permissionIds)
           
static 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.
static 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.
static 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.
static 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 setService(PermissionLocalService service)
          Deprecated.  
static void setUserPermissions(long userId, long[] permissionIds)
           
static 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.
static void unsetRolePermission(long roleId, long permissionId)
          Removes the permission from the role.
static 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.
static 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.
static void unsetUserPermissions(long userId, String[] actionIds, long resourceId)
          Removes the user's permissions to perform the actions on the resource.
static Permission updatePermission(Permission permission)
          Updates the permission in the database or adds it if it does not yet exist.
static Permission updatePermission(Permission permission, boolean merge)
          Updates the permission in the database or adds it if it does not yet exist.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PermissionLocalServiceUtil

public PermissionLocalServiceUtil()
Method Detail

addPermission

public static 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

public static 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

public static 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

public static 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

public static DynamicQuery dynamicQuery()

dynamicQuery

public static 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

public static 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

public static 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

public static 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

public static Permission fetchPermission(long permissionId)
                                  throws SystemException
Throws:
SystemException

getPermission

public static 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

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException
Throws:
PortalException
SystemException

getPermissions

public static 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

public static int getPermissionsCount()
                               throws SystemException
Returns the number of permissions.

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

updatePermission

public static 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

public static 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

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

addGroupPermission

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

addGroupPermissions

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

addGroupPermissions

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

clearGroupPermissions

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

deleteGroupPermission

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

deleteGroupPermission

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

deleteGroupPermissions

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

deleteGroupPermissions

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

getGroupPermissions

public static List<Permission> getGroupPermissions(long groupId)
                                            throws SystemException
Throws:
SystemException - if a system exception occurred

getGroupPermissions

public static List<Permission> getGroupPermissions(long groupId,
                                                   int start,
                                                   int end)
                                            throws SystemException
Throws:
SystemException - if a system exception occurred

getGroupPermissions

public static List<Permission> getGroupPermissions(long groupId,
                                                   int start,
                                                   int end,
                                                   OrderByComparator orderByComparator)
                                            throws SystemException
Throws:
SystemException - if a system exception occurred

getGroupPermissionsCount

public static int getGroupPermissionsCount(long groupId)
                                    throws SystemException
Throws:
SystemException - if a system exception occurred

hasGroupPermission

public static boolean hasGroupPermission(long groupId,
                                         long permissionId)
                                  throws SystemException
Throws:
SystemException - if a system exception occurred

hasGroupPermissions

public static boolean hasGroupPermissions(long groupId)
                                   throws SystemException
Throws:
SystemException - if a system exception occurred

setGroupPermissions

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

addRolePermission

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

addRolePermission

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

addRolePermissions

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

addRolePermissions

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

clearRolePermissions

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

deleteRolePermission

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

deleteRolePermission

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

deleteRolePermissions

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

deleteRolePermissions

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

getRolePermissions

public static List<Permission> getRolePermissions(long roleId)
                                           throws SystemException
Throws:
SystemException - if a system exception occurred

getRolePermissions

public static List<Permission> getRolePermissions(long roleId,
                                                  int start,
                                                  int end)
                                           throws SystemException
Throws:
SystemException - if a system exception occurred

getRolePermissions

public static List<Permission> getRolePermissions(long roleId,
                                                  int start,
                                                  int end,
                                                  OrderByComparator orderByComparator)
                                           throws SystemException
Throws:
SystemException - if a system exception occurred

getRolePermissionsCount

public static int getRolePermissionsCount(long roleId)
                                   throws SystemException
Throws:
SystemException - if a system exception occurred

hasRolePermission

public static boolean hasRolePermission(long roleId,
                                        long permissionId)
                                 throws SystemException
Throws:
SystemException - if a system exception occurred

hasRolePermissions

public static boolean hasRolePermissions(long roleId)
                                  throws SystemException
Throws:
SystemException - if a system exception occurred

setRolePermissions

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

addUserPermission

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

addUserPermission

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

addUserPermissions

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

addUserPermissions

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

clearUserPermissions

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

deleteUserPermission

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

deleteUserPermission

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

deleteUserPermissions

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

deleteUserPermissions

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

getUserPermissions

public static List<Permission> getUserPermissions(long userId)
                                           throws SystemException
Throws:
SystemException - if a system exception occurred

getUserPermissions

public static List<Permission> getUserPermissions(long userId,
                                                  int start,
                                                  int end)
                                           throws SystemException
Throws:
SystemException - if a system exception occurred

getUserPermissions

public static List<Permission> getUserPermissions(long userId,
                                                  int start,
                                                  int end,
                                                  OrderByComparator orderByComparator)
                                           throws SystemException
Throws:
SystemException - if a system exception occurred

getUserPermissionsCount

public static int getUserPermissionsCount(long userId)
                                   throws SystemException
Throws:
SystemException - if a system exception occurred

hasUserPermission

public static boolean hasUserPermission(long userId,
                                        long permissionId)
                                 throws SystemException
Throws:
SystemException - if a system exception occurred

hasUserPermissions

public static boolean hasUserPermissions(long userId)
                                  throws SystemException
Throws:
SystemException - if a system exception occurred

setUserPermissions

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

getBeanIdentifier

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

Returns:
the Spring bean ID for this bean

setBeanIdentifier

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

Parameters:
beanIdentifier - the Spring bean ID for this bean

addPermission

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static List<Permission> getRolePermissions(long roleId,
                                                  int[] scopes)
                                           throws SystemException
Throws:
SystemException

getRolePermissions

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

getService

public static PermissionLocalService getService()

setService

public void setService(PermissionLocalService service)
Deprecated. 


Liferay 6.1.2-ce-ga3