com.liferay.portal.service
Interface ResourcePermissionLocalService

All Known Implementing Classes:

ResourcePermissionLocalServiceBaseImpl, ResourcePermissionLocalServiceImpl, ResourcePermissionLocalServiceWrapper

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

The interface for the resource permission local service.

Never modify or reference this interface directly. Always use ResourcePermissionLocalServiceUtil to access the resource permission local service. Add custom service methods to ResourcePermissionLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

See Also:

ResourcePermissionLocalServiceUtil, ResourcePermissionLocalServiceBaseImpl, ResourcePermissionLocalServiceImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary

void	addResourcePermission(long companyId, String name, int scope, String primKey, long roleId, String actionId)
ResourcePermission	addResourcePermission(ResourcePermission resourcePermission) Adds the resource permission to the database.
ResourcePermission	createResourcePermission(long resourcePermissionId) Creates a new resource permission with the primary key.
void	deleteResourcePermission(long resourcePermissionId) Deletes the resource permission with the primary key from the database.
void	deleteResourcePermission(ResourcePermission resourcePermission) Deletes the resource permission from the database.
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) Counts the number of rows that match the dynamic query.
List<String>	getAvailableResourcePermissionActionIds(long companyId, String name, int scope, String primKey, long roleId, List<String> actionIds)
ResourcePermission	getResourcePermission(long resourcePermissionId) Gets the resource permission with the primary key.
List<ResourcePermission>	getResourcePermissions(int start, int end) Gets a range of all the resource permissions.
List<ResourcePermission>	getResourcePermissions(long companyId, String name, int scope, String primKey)
int	getResourcePermissionsCount() Gets the number of resource permissions.
int	getResourcePermissionsCount(long companyId, String name, int scope, String primKey)
List<ResourcePermission>	getRoleResourcePermissions(long roleId)
List<ResourcePermission>	getRoleResourcePermissions(long roleId, int[] scopes, int start, int end)
boolean	hasActionId(ResourcePermission resourcePermission, ResourceAction resourceAction)
boolean	hasResourcePermission(long companyId, String name, int scope, String primKey, long roleId, String actionId)
boolean	hasScopeResourcePermission(long companyId, String name, int scope, long roleId, String actionId)
void	mergePermissions(long fromRoleId, long toRoleId)
void	reassignPermissions(long resourcePermissionId, long toRoleId)
void	removeResourcePermission(long companyId, String name, int scope, String primKey, long roleId, String actionId)
void	removeResourcePermissions(long companyId, String name, int scope, long roleId, String actionId)
void	setResourcePermissions(long companyId, String name, int scope, String primKey, long roleId, String[] actionIds)
ResourcePermission	updateResourcePermission(ResourcePermission resourcePermission) Updates the resource permission in the database.
ResourcePermission	updateResourcePermission(ResourcePermission resourcePermission, boolean merge) Updates the resource permission in the database.

Method Detail

addResourcePermission

ResourcePermission addResourcePermission(ResourcePermission resourcePermission)
                                         throws SystemException

Adds the resource permission to the database. Also notifies the appropriate model listeners.

Parameters:

resourcePermission - the resource permission to add

Returns:

the resource permission that was added

Throws:

SystemException - if a system exception occurred

createResourcePermission

ResourcePermission createResourcePermission(long resourcePermissionId)

Creates a new resource permission with the primary key. Does not add the resource permission to the database.

Parameters:

resourcePermissionId - the primary key for the new resource permission

Returns:

the new resource permission

deleteResourcePermission

void deleteResourcePermission(long resourcePermissionId)
                              throws PortalException,
                                     SystemException

Deletes the resource permission with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

resourcePermissionId - the primary key of the resource permission to delete

Throws:

PortalException - if a resource permission with the primary key could not be found

SystemException - if a system exception occurred

deleteResourcePermission

void deleteResourcePermission(ResourcePermission resourcePermission)
                              throws SystemException

Deletes the resource permission from the database. Also notifies the appropriate model listeners.

Parameters:

resourcePermission - the resource permission to delete

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query to search with

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 to search with

start - the lower bound of the range of model instances to return

end - the upper bound of the range of model instances to return (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 to search with

start - the lower bound of the range of model instances to return

end - the upper bound of the range of model instances to return (not inclusive)

orderByComparator - the comparator to order the results by

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException

Counts the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

getResourcePermission

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ResourcePermission getResourcePermission(long resourcePermissionId)
                                         throws PortalException,
                                                SystemException

Gets the resource permission with the primary key.

Parameters:

resourcePermissionId - the primary key of the resource permission to get

Returns:

the resource permission

Throws:

PortalException - if a resource permission with the primary key could not be found

SystemException - if a system exception occurred

getResourcePermissions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ResourcePermission> getResourcePermissions(int start,
                                                                                         int end)
                                                throws SystemException

Gets a range of all the resource permissions.

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

Parameters:

start - the lower bound of the range of resource permissions to return

end - the upper bound of the range of resource permissions to return (not inclusive)

Returns:

the range of resource permissions

Throws:

SystemException - if a system exception occurred

getResourcePermissionsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getResourcePermissionsCount()
                                throws SystemException

Gets the number of resource permissions.

Returns:

the number of resource permissions

Throws:

SystemException - if a system exception occurred

updateResourcePermission

ResourcePermission updateResourcePermission(ResourcePermission resourcePermission)
                                            throws SystemException

Updates the resource permission in the database. Also notifies the appropriate model listeners.

Parameters:

resourcePermission - the resource permission to update

Returns:

the resource permission that was updated

Throws:

SystemException - if a system exception occurred

updateResourcePermission

ResourcePermission updateResourcePermission(ResourcePermission resourcePermission,
                                            boolean merge)
                                            throws SystemException

Updates the resource permission in the database. Also notifies the appropriate model listeners.

Parameters:

resourcePermission - the resource permission to update

merge - whether to merge the resource permission with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.

Returns:

the resource permission that was updated

Throws:

SystemException - if a system exception occurred

addResourcePermission

void addResourcePermission(long companyId,
                           String name,
                           int scope,
                           String primKey,
                           long roleId,
                           String actionId)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

getAvailableResourcePermissionActionIds

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

Throws:

PortalException

SystemException

getResourcePermissions

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

Throws:

SystemException

getResourcePermissionsCount

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

Throws:

SystemException

getRoleResourcePermissions

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

Throws:

SystemException

getRoleResourcePermissions

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

Throws:

SystemException

hasActionId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasActionId(ResourcePermission resourcePermission,
                                                             ResourceAction resourceAction)

hasResourcePermission

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

Throws:

PortalException

SystemException

hasScopeResourcePermission

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

Throws:

PortalException

SystemException

mergePermissions

void mergePermissions(long fromRoleId,
                      long toRoleId)
                      throws PortalException,
                             SystemException

Throws:

PortalException

SystemException

reassignPermissions

void reassignPermissions(long resourcePermissionId,
                         long toRoleId)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

removeResourcePermission

void removeResourcePermission(long companyId,
                              String name,
                              int scope,
                              String primKey,
                              long roleId,
                              String actionId)
                              throws PortalException,
                                     SystemException

Throws:

PortalException

SystemException

removeResourcePermissions

void removeResourcePermissions(long companyId,
                               String name,
                               int scope,
                               long roleId,
                               String actionId)
                               throws PortalException,
                                      SystemException

Throws:

PortalException

SystemException

setResourcePermissions

void setResourcePermissions(long companyId,
                            String name,
                            int scope,
                            String primKey,
                            long roleId,
                            String[] actionIds)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException