com.liferay.portal.kernel.service

Class ResourceBlockPermissionLocalServiceUtil

Object

com.liferay.portal.kernel.service.ResourceBlockPermissionLocalServiceUtil

@ProviderType
public class ResourceBlockPermissionLocalServiceUtil
extends Object

Provides the local service utility for ResourceBlockPermission. This utility wraps ResourceBlockPermissionLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server. 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:

ResourceBlockPermissionLocalService, ResourceBlockPermissionLocalServiceBaseImpl, ResourceBlockPermissionLocalServiceImpl

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
ResourceBlockPermissionLocalServiceUtil()

Method Summary

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

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ResourceBlockPermissionLocalServiceUtil

public ResourceBlockPermissionLocalServiceUtil()

Method Detail

addResourceBlockPermission

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

public static void addResourceBlockPermissions(long resourceBlockId,
                                               ResourceBlockPermissionsContainer resourceBlockPermissionsContainer)

createResourceBlockPermission

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

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

deleteResourceBlockPermission

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

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

public static void deleteResourceBlockPermissions(long resourceBlockId)

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

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

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

public static ResourceBlockPermission fetchResourceBlockPermission(long resourceBlockPermissionId)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getAvailableResourceBlockPermissionActionIds

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

public static Map<Long,Set<String>> getAvailableResourceBlockPermissionActionIds(String name,
                                                                                 long primKey,
                                                                                 List<String> actionIds)
                                                                          throws PortalException

Throws:

PortalException

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

getResourceBlockPermission

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

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

public static ResourceBlockPermissionsContainer getResourceBlockPermissionsContainer(long resourceBlockId)

getResourceBlockPermissionsCount

public static int getResourceBlockPermissionsCount()

Returns the number of resource block permissions.

Returns:

the number of resource block permissions

getResourceBlockPermissionsCount

public static int getResourceBlockPermissionsCount(long resourceBlockId,
                                                   long roleId)

updateResourceBlockPermission

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

updateResourceBlockPermission

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

getService

public static ResourceBlockPermissionLocalService getService()