com.liferay.object.service.ObjectActionLocalServiceUtil Maven / Gradle / Ivy
/**
* SPDX-FileCopyrightText: (c) 2000 Liferay, Inc. https://liferay.com
* SPDX-License-Identifier: LGPL-2.1-or-later OR LicenseRef-Liferay-DXP-EULA-2.0.0-2023-06
*/
package com.liferay.object.service;
import com.liferay.object.model.ObjectAction;
import com.liferay.petra.sql.dsl.query.DSLQuery;
import com.liferay.portal.kernel.dao.orm.DynamicQuery;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.model.PersistedModel;
import com.liferay.portal.kernel.module.service.Snapshot;
import com.liferay.portal.kernel.util.OrderByComparator;
import java.io.Serializable;
import java.util.List;
import java.util.Map;
/**
* Provides the local service utility for ObjectAction. This utility wraps
* com.liferay.object.service.impl.ObjectActionLocalServiceImpl and
* is an 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 Marco Leo
* @see ObjectActionLocalService
* @generated
*/
public class ObjectActionLocalServiceUtil {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this class directly. Add custom service methods to com.liferay.object.service.impl.ObjectActionLocalServiceImpl and rerun ServiceBuilder to regenerate this class.
*/
/**
* Adds the object action to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectActionLocalServiceImpl 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.
*
*
* @param objectAction the object action
* @return the object action that was added
*/
public static ObjectAction addObjectAction(ObjectAction objectAction) {
return getService().addObjectAction(objectAction);
}
public static ObjectAction addObjectAction(
String externalReferenceCode, long userId, long objectDefinitionId,
boolean active, String conditionExpression, String description,
Map errorMessageMap,
Map labelMap, String name,
String objectActionExecutorKey, String objectActionTriggerKey,
com.liferay.portal.kernel.util.UnicodeProperties
parametersUnicodeProperties,
boolean system)
throws PortalException {
return getService().addObjectAction(
externalReferenceCode, userId, objectDefinitionId, active,
conditionExpression, description, errorMessageMap, labelMap, name,
objectActionExecutorKey, objectActionTriggerKey,
parametersUnicodeProperties, system);
}
public static ObjectAction addOrUpdateObjectAction(
String externalReferenceCode, long objectActionId, long userId,
long objectDefinitionId, boolean active, String conditionExpression,
String description, Map errorMessageMap,
Map labelMap, String name,
String objectActionExecutorKey, String objectActionTriggerKey,
com.liferay.portal.kernel.util.UnicodeProperties
parametersUnicodeProperties,
boolean system)
throws PortalException {
return getService().addOrUpdateObjectAction(
externalReferenceCode, objectActionId, userId, objectDefinitionId,
active, conditionExpression, description, errorMessageMap, labelMap,
name, objectActionExecutorKey, objectActionTriggerKey,
parametersUnicodeProperties, system);
}
/**
* Creates a new object action with the primary key. Does not add the object action to the database.
*
* @param objectActionId the primary key for the new object action
* @return the new object action
*/
public static ObjectAction createObjectAction(long objectActionId) {
return getService().createObjectAction(objectActionId);
}
/**
* @throws PortalException
*/
public static PersistedModel createPersistedModel(
Serializable primaryKeyObj)
throws PortalException {
return getService().createPersistedModel(primaryKeyObj);
}
/**
* Deletes the object action with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectActionLocalServiceImpl 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.
*
*
* @param objectActionId the primary key of the object action
* @return the object action that was removed
* @throws PortalException if a object action with the primary key could not be found
*/
public static ObjectAction deleteObjectAction(long objectActionId)
throws PortalException {
return getService().deleteObjectAction(objectActionId);
}
/**
* Deletes the object action from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectActionLocalServiceImpl 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.
*
*
* @param objectAction the object action
* @return the object action that was removed
* @throws PortalException
*/
public static ObjectAction deleteObjectAction(ObjectAction objectAction)
throws PortalException {
return getService().deleteObjectAction(objectAction);
}
public static void deleteObjectActions(long objectDefinitionId)
throws PortalException {
getService().deleteObjectActions(objectDefinitionId);
}
/**
* @throws PortalException
*/
public static PersistedModel deletePersistedModel(
PersistedModel persistedModel)
throws PortalException {
return getService().deletePersistedModel(persistedModel);
}
public static T dslQuery(DSLQuery dslQuery) {
return getService().dslQuery(dslQuery);
}
public static int dslQueryCount(DSLQuery dslQuery) {
return getService().dslQueryCount(dslQuery);
}
public static DynamicQuery dynamicQuery() {
return getService().dynamicQuery();
}
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
*/
public static List dynamicQuery(DynamicQuery dynamicQuery) {
return getService().dynamicQuery(dynamicQuery);
}
/**
* 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.object.model.impl.ObjectActionModelImpl.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @return the range of matching rows
*/
public static List dynamicQuery(
DynamicQuery dynamicQuery, int start, int end) {
return getService().dynamicQuery(dynamicQuery, start, end);
}
/**
* 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.object.model.impl.ObjectActionModelImpl.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of matching rows
*/
public static List dynamicQuery(
DynamicQuery dynamicQuery, int start, int end,
OrderByComparator orderByComparator) {
return getService().dynamicQuery(
dynamicQuery, start, end, orderByComparator);
}
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @return the number of rows matching the dynamic query
*/
public static long dynamicQueryCount(DynamicQuery dynamicQuery) {
return getService().dynamicQueryCount(dynamicQuery);
}
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @param projection the projection to apply to the query
* @return the number of rows matching the dynamic query
*/
public static long dynamicQueryCount(
DynamicQuery dynamicQuery,
com.liferay.portal.kernel.dao.orm.Projection projection) {
return getService().dynamicQueryCount(dynamicQuery, projection);
}
public static ObjectAction fetchObjectAction(long objectActionId) {
return getService().fetchObjectAction(objectActionId);
}
public static ObjectAction fetchObjectAction(
String externalReferenceCode, long objectDefinitionId) {
return getService().fetchObjectAction(
externalReferenceCode, objectDefinitionId);
}
/**
* Returns the object action with the matching UUID and company.
*
* @param uuid the object action's UUID
* @param companyId the primary key of the company
* @return the matching object action, or null if a matching object action could not be found
*/
public static ObjectAction fetchObjectActionByUuidAndCompanyId(
String uuid, long companyId) {
return getService().fetchObjectActionByUuidAndCompanyId(
uuid, companyId);
}
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery
getActionableDynamicQuery() {
return getService().getActionableDynamicQuery();
}
public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery
getExportActionableDynamicQuery(
com.liferay.exportimport.kernel.lar.PortletDataContext
portletDataContext) {
return getService().getExportActionableDynamicQuery(portletDataContext);
}
public static
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery
getIndexableActionableDynamicQuery() {
return getService().getIndexableActionableDynamicQuery();
}
/**
* Returns the object action with the primary key.
*
* @param objectActionId the primary key of the object action
* @return the object action
* @throws PortalException if a object action with the primary key could not be found
*/
public static ObjectAction getObjectAction(long objectActionId)
throws PortalException {
return getService().getObjectAction(objectActionId);
}
public static ObjectAction getObjectAction(
long objectDefinitionId, String name, String objectActionTriggerKey)
throws PortalException {
return getService().getObjectAction(
objectDefinitionId, name, objectActionTriggerKey);
}
/**
* Returns the object action with the matching UUID and company.
*
* @param uuid the object action's UUID
* @param companyId the primary key of the company
* @return the matching object action
* @throws PortalException if a matching object action could not be found
*/
public static ObjectAction getObjectActionByUuidAndCompanyId(
String uuid, long companyId)
throws PortalException {
return getService().getObjectActionByUuidAndCompanyId(uuid, companyId);
}
public static List getObjectActions(
boolean active, String objectActionExecutorKey) {
return getService().getObjectActions(active, objectActionExecutorKey);
}
/**
* Returns a range of all the object 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.object.model.impl.ObjectActionModelImpl.
*
*
* @param start the lower bound of the range of object actions
* @param end the upper bound of the range of object actions (not inclusive)
* @return the range of object actions
*/
public static List getObjectActions(int start, int end) {
return getService().getObjectActions(start, end);
}
public static List getObjectActions(long objectDefinitionId) {
return getService().getObjectActions(objectDefinitionId);
}
public static List getObjectActions(
long objectDefinitionId, String objectActionTriggerKey) {
return getService().getObjectActions(
objectDefinitionId, objectActionTriggerKey);
}
/**
* Returns the number of object actions.
*
* @return the number of object actions
*/
public static int getObjectActionsCount() {
return getService().getObjectActionsCount();
}
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
public static String getOSGiServiceIdentifier() {
return getService().getOSGiServiceIdentifier();
}
/**
* @throws PortalException
*/
public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException {
return getService().getPersistedModel(primaryKeyObj);
}
/**
* Updates the object action in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectActionLocalServiceImpl 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.
*
*
* @param objectAction the object action
* @return the object action that was updated
*/
public static ObjectAction updateObjectAction(ObjectAction objectAction) {
return getService().updateObjectAction(objectAction);
}
public static ObjectAction updateObjectAction(
String externalReferenceCode, long objectActionId, boolean active,
String conditionExpression, String description,
Map errorMessageMap,
Map labelMap, String name,
String objectActionExecutorKey, String objectActionTriggerKey,
com.liferay.portal.kernel.util.UnicodeProperties
parametersUnicodeProperties)
throws PortalException {
return getService().updateObjectAction(
externalReferenceCode, objectActionId, active, conditionExpression,
description, errorMessageMap, labelMap, name,
objectActionExecutorKey, objectActionTriggerKey,
parametersUnicodeProperties);
}
public static ObjectAction updateStatus(long objectActionId, int status)
throws PortalException {
return getService().updateStatus(objectActionId, status);
}
public static ObjectActionLocalService getService() {
return _serviceSnapshot.get();
}
private static final Snapshot _serviceSnapshot =
new Snapshot<>(
ObjectActionLocalServiceUtil.class, ObjectActionLocalService.class);
}