com.liferay.portal.kernel.service

Interface ResourceBlockPermissionLocalService

All Superinterfaces:

BaseLocalService, PermissionedModelLocalService, PersistedModelLocalService

All Known Implementing Classes:

ResourceBlockPermissionLocalServiceWrapper

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

Provides the local service interface for ResourceBlockPermission. 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.

Author:

Brian Wing Shun Chan

See Also:

ResourceBlockPermissionLocalServiceUtil, ResourceBlockPermissionLocalServiceBaseImpl, ResourceBlockPermissionLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
ResourceBlockPermission	addResourceBlockPermission(ResourceBlockPermission resourceBlockPermission) Adds the resource block permission to the database.
void	addResourceBlockPermissions(long resourceBlockId, ResourceBlockPermissionsContainer resourceBlockPermissionsContainer)
ResourceBlockPermission	createResourceBlockPermission(long resourceBlockPermissionId) Creates a new resource block permission with the primary key.
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
ResourceBlockPermission	deleteResourceBlockPermission(long resourceBlockPermissionId) Deletes the resource block permission with the primary key from the database.
ResourceBlockPermission	deleteResourceBlockPermission(ResourceBlockPermission resourceBlockPermission) Deletes the resource block permission from the database.
void	deleteResourceBlockPermissions(long resourceBlockId)
DynamicQuery	dynamicQuery()
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
ResourceBlockPermission	fetchResourceBlockPermission(long resourceBlockPermissionId)
ActionableDynamicQuery	getActionableDynamicQuery()
Map<Long,Set<String>>	getAvailableResourceBlockPermissionActionIds(long[] roleIds, String name, long primKey, List<String> actionIds) Deprecated. As of Wilberforce (7.0.x), replaced by getAvailableResourceBlockPermissionActionIds(String, long, List)
Map<Long,Set<String>>	getAvailableResourceBlockPermissionActionIds(String name, long primKey, List<String> actionIds)
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
ResourceBlockPermission	getResourceBlockPermission(long resourceBlockPermissionId) Returns the resource block permission with the primary key.
List<ResourceBlockPermission>	getResourceBlockPermissions(int start, int end) Returns a range of all the resource block permissions.
ResourceBlockPermissionsContainer	getResourceBlockPermissionsContainer(long resourceBlockId)
int	getResourceBlockPermissionsCount() Returns the number of resource block permissions.
int	getResourceBlockPermissionsCount(long resourceBlockId, long roleId)
void	updateResourceBlockPermission(long resourceBlockId, long roleId, long actionIdsLong, int operator)
ResourceBlockPermission	updateResourceBlockPermission(ResourceBlockPermission resourceBlockPermission) Updates the resource block permission in the database or adds it if it does not yet exist.

Method Detail

addResourceBlockPermission

@Indexable(type=REINDEX)
ResourceBlockPermission addResourceBlockPermission(ResourceBlockPermission resourceBlockPermission)

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

Parameters:

resourceBlockPermission - the resource block permission

Returns:

the resource block permission that was added

addResourceBlockPermissions

void addResourceBlockPermissions(long resourceBlockId,
                                 ResourceBlockPermissionsContainer resourceBlockPermissionsContainer)

createResourceBlockPermission

@Transactional(enabled=false)
ResourceBlockPermission createResourceBlockPermission(long resourceBlockPermissionId)

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

Parameters:

resourceBlockPermissionId - the primary key for the new resource block permission

Returns:

the new resource block permission

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteResourceBlockPermission

@Indexable(type=DELETE)
ResourceBlockPermission deleteResourceBlockPermission(long resourceBlockPermissionId)
                                                                       throws PortalException

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

Parameters:

resourceBlockPermissionId - the primary key of the resource block permission

Returns:

the resource block permission that was removed

Throws:

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

deleteResourceBlockPermission

@Indexable(type=DELETE)
ResourceBlockPermission deleteResourceBlockPermission(ResourceBlockPermission resourceBlockPermission)

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

Parameters:

resourceBlockPermission - the resource block permission

Returns:

the resource block permission that was removed

deleteResourceBlockPermissions

void deleteResourceBlockPermissions(long resourceBlockId)

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery)

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

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                                                            int start,
                                                                                            int end)

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

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ResourceBlockPermissionModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

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

Returns:

the range of matching rows

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                                                            int start,
                                                                                            int end,
                                                                                            OrderByComparator<T> orderByComparator)

Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ResourceBlockPermissionModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

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

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

dynamicQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(DynamicQuery dynamicQuery,
                                                                                          Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchResourceBlockPermission

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ResourceBlockPermission fetchResourceBlockPermission(long resourceBlockPermissionId)

getActionableDynamicQuery

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

getAvailableResourceBlockPermissionActionIds

@Deprecated
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
Map<Long,Set<String>> getAvailableResourceBlockPermissionActionIds(long[] roleIds,
                                                                                                                                                   String name,
                                                                                                                                                   long primKey,
                                                                                                                                                   List<String> actionIds)
                                                                                                                                            throws PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by getAvailableResourceBlockPermissionActionIds(String, long, List)

Throws:

PortalException

getAvailableResourceBlockPermissionActionIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Map<Long,Set<String>> getAvailableResourceBlockPermissionActionIds(String name,
                                                                                                                                      long primKey,
                                                                                                                                      List<String> actionIds)
                                                                                                                               throws PortalException

Throws:

PortalException

getIndexableActionableDynamicQuery

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

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                                                                             throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

getResourceBlockPermission

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ResourceBlockPermission getResourceBlockPermission(long resourceBlockPermissionId)
                                                                                                               throws PortalException

Returns the resource block permission with the primary key.

Parameters:

resourceBlockPermissionId - the primary key of the resource block permission

Returns:

the resource block permission

Throws:

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

getResourceBlockPermissions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ResourceBlockPermission> getResourceBlockPermissions(int start,
                                                                                                                             int end)

Returns a range of all the resource block permissions.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ResourceBlockPermissionModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

start - the lower bound of the range of resource block permissions

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

Returns:

the range of resource block permissions

getResourceBlockPermissionsContainer

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ResourceBlockPermissionsContainer getResourceBlockPermissionsContainer(long resourceBlockId)

getResourceBlockPermissionsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getResourceBlockPermissionsCount()

Returns the number of resource block permissions.

Returns:

the number of resource block permissions

getResourceBlockPermissionsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getResourceBlockPermissionsCount(long resourceBlockId,
                                                                                                        long roleId)

updateResourceBlockPermission

void updateResourceBlockPermission(long resourceBlockId,
                                   long roleId,
                                   long actionIdsLong,
                                   int operator)

updateResourceBlockPermission

@Indexable(type=REINDEX)
ResourceBlockPermission updateResourceBlockPermission(ResourceBlockPermission resourceBlockPermission)

Updates the resource block permission in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

resourceBlockPermission - the resource block permission

Returns:

the resource block permission that was updated