com.liferay.portal.kernel.service

Class ResourceActionLocalServiceUtil

Object

com.liferay.portal.kernel.service.ResourceActionLocalServiceUtil

@ProviderType
public class ResourceActionLocalServiceUtil
extends Object

Provides the local service utility for ResourceAction. This utility wraps ResourceActionLocalServiceImpl 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:

ResourceActionLocalService, ResourceActionLocalServiceBaseImpl, ResourceActionLocalServiceImpl

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
ResourceActionLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static ResourceAction	addResourceAction(ResourceAction resourceAction) Adds the resource action to the database.
static ResourceAction	addResourceAction(String name, String actionId, long bitwiseValue)
static void	checkResourceActions()
static void	checkResourceActions(String name, List<String> actionIds)
static void	checkResourceActions(String name, List<String> actionIds, boolean addDefaultActions)
static ResourceAction	createResourceAction(long resourceActionId) Creates a new resource action with the primary key.
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static ResourceAction	deleteResourceAction(long resourceActionId) Deletes the resource action with the primary key from the database.
static ResourceAction	deleteResourceAction(ResourceAction resourceAction) Deletes the resource action from the database.
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 ResourceAction	fetchResourceAction(long resourceActionId)
static ResourceAction	fetchResourceAction(String name, String actionId)
static ActionableDynamicQuery	getActionableDynamicQuery()
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static ResourceAction	getResourceAction(long resourceActionId) Returns the resource action with the primary key.
static ResourceAction	getResourceAction(String name, String actionId)
static List<ResourceAction>	getResourceActions(int start, int end) Returns a range of all the resource actions.
static List<ResourceAction>	getResourceActions(String name)
static int	getResourceActionsCount() Returns the number of resource actions.
static int	getResourceActionsCount(String name)
static ResourceActionLocalService	getService()
static ResourceAction	updateResourceAction(ResourceAction resourceAction) Updates the resource action 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

ResourceActionLocalServiceUtil

public ResourceActionLocalServiceUtil()

Method Detail

addResourceAction

public static ResourceAction addResourceAction(ResourceAction resourceAction)

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

Parameters:

resourceAction - the resource action

Returns:

the resource action that was added

addResourceAction

public static ResourceAction addResourceAction(String name,
                                               String actionId,
                                               long bitwiseValue)

checkResourceActions

public static void checkResourceActions()

checkResourceActions

public static void checkResourceActions(String name,
                                        List<String> actionIds)

checkResourceActions

public static void checkResourceActions(String name,
                                        List<String> actionIds,
                                        boolean addDefaultActions)

createResourceAction

public static ResourceAction createResourceAction(long resourceActionId)

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

Parameters:

resourceActionId - the primary key for the new resource action

Returns:

the new resource action

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

deleteResourceAction

public static ResourceAction deleteResourceAction(long resourceActionId)
                                           throws PortalException

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

Parameters:

resourceActionId - the primary key of the resource action

Returns:

the resource action that was removed

Throws:

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

deleteResourceAction

public static ResourceAction deleteResourceAction(ResourceAction resourceAction)

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

Parameters:

resourceAction - the resource action

Returns:

the resource action that was removed

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 ResourceActionModelImpl. 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 ResourceActionModelImpl. 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

fetchResourceAction

public static ResourceAction fetchResourceAction(long resourceActionId)

fetchResourceAction

public static ResourceAction fetchResourceAction(String name,
                                                 String actionId)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

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

getResourceAction

public static ResourceAction getResourceAction(long resourceActionId)
                                        throws PortalException

Returns the resource action with the primary key.

Parameters:

resourceActionId - the primary key of the resource action

Returns:

the resource action

Throws:

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

getResourceAction

public static ResourceAction getResourceAction(String name,
                                               String actionId)
                                        throws PortalException

Throws:

PortalException

getResourceActions

public static List<ResourceAction> getResourceActions(int start,
                                                      int end)

Returns a range of all the resource actions.

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 ResourceActionModelImpl. 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 actions

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

Returns:

the range of resource actions

getResourceActions

public static List<ResourceAction> getResourceActions(String name)

getResourceActionsCount

public static int getResourceActionsCount()

Returns the number of resource actions.

Returns:

the number of resource actions

getResourceActionsCount

public static int getResourceActionsCount(String name)

updateResourceAction

public static ResourceAction updateResourceAction(ResourceAction resourceAction)

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

Parameters:

resourceAction - the resource action

Returns:

the resource action that was updated

getService

public static ResourceActionLocalService getService()