Interface ResourceActionLocalService
- All Superinterfaces:
BaseLocalService
,PersistedModelLocalService
- All Known Implementing Classes:
ResourceActionLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddResourceAction
(ResourceAction resourceAction) Adds the resource action to the database.addResourceAction
(String name, String actionId, long bitwiseValue) void
void
checkResourceActions
(String name, List<String> actionIds) void
checkResourceActions
(String name, List<String> actionIds, boolean addDefaultActions) createPersistedModel
(Serializable primaryKeyObj) createResourceAction
(long resourceActionId) Creates a new resource action with the primary key.deletePersistedModel
(PersistedModel persistedModel) deleteResourceAction
(long resourceActionId) Deletes the resource action with the primary key from the database.deleteResourceAction
(ResourceAction resourceAction) Deletes the resource action from the database.<T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) <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.fetchResourceAction
(long resourceActionId) fetchResourceAction
(String name, String actionId) Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) getResourceAction
(long resourceActionId) Returns the resource action with the primary key.getResourceAction
(String name, String actionId) getResourceActions
(int start, int end) Returns a range of all the resource actions.getResourceActions
(String name) int
Returns the number of resource actions.int
updateResourceAction
(ResourceAction resourceAction) Updates the resource action in the database or adds it if it does not yet exist.Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addResourceAction
Adds the resource action to the database. Also notifies the appropriate model listeners.Important: Inspect ResourceActionLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
resourceAction
- the resource action- Returns:
- the resource action that was added
-
addResourceAction
-
checkResourceActions
-
checkResourceActions
-
checkResourceActions
-
createPersistedModel
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
createResourceAction
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
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- 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.Important: Inspect ResourceActionLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- 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
Deletes the resource action from the database. Also notifies the appropriate model listeners.Important: Inspect ResourceActionLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
resourceAction
- the resource action- Returns:
- the resource action that was removed
-
dslQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQuery
in interfacePersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfacePersistedModelLocalService
-
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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.ResourceActionModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.ResourceActionModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- 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 queryprojection
- 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
-
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 interfacePersistedModelLocalService
- 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
@Transactional(enabled=false) 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.ResourceActionModelImpl
.- Parameters:
start
- the lower bound of the range of resource actionsend
- 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
Returns the number of resource actions.- Returns:
- the number of resource actions
-
getResourceActionsCount
-
updateResourceAction
Updates the resource action in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect ResourceActionLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
resourceAction
- the resource action- Returns:
- the resource action that was updated
-