com.liferay.portal.kernel.service

Interface ResourceActionLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

ResourceActionLocalServiceWrapper

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

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

ResourceActionLocalServiceUtil, ResourceActionLocalServiceBaseImpl, ResourceActionLocalServiceImpl

{$generated.description}

Method Summary

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

Method Detail

addResourceAction

@Indexable(type=REINDEX)
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

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

checkResourceActions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
void checkResourceActions()

checkResourceActions

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

checkResourceActions

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

createResourceAction

@Transactional(enabled=false)
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

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteResourceAction

@Indexable(type=DELETE)
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

@Indexable(type=DELETE)
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

@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 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

@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 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

@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

fetchResourceAction

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ResourceAction fetchResourceAction(long resourceActionId)

fetchResourceAction

@Skip
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
ResourceAction fetchResourceAction(String name,
                                                                                                             String actionId)

getActionableDynamicQuery

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

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

getResourceAction

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Skip
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
ResourceAction getResourceAction(String name,
                                                                                                           String actionId)
                                                                                                    throws PortalException

Throws:

PortalException

getResourceActions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ResourceAction> getResourceActions(String name)

getResourceActionsCount

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

Returns the number of resource actions.

Returns:

the number of resource actions

getResourceActionsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getResourceActionsCount(String name)

updateResourceAction

@Indexable(type=REINDEX)
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