com.liferay.object.service.ObjectActionLocalService 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.exportimport.kernel.lar.PortletDataContext;
import com.liferay.object.model.ObjectAction;
import com.liferay.petra.sql.dsl.query.DSLQuery;
import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.DynamicQuery;
import com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.Projection;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.kernel.model.PersistedModel;
import com.liferay.portal.kernel.model.SystemEventConstants;
import com.liferay.portal.kernel.search.Indexable;
import com.liferay.portal.kernel.search.IndexableType;
import com.liferay.portal.kernel.service.BaseLocalService;
import com.liferay.portal.kernel.service.PersistedModelLocalService;
import com.liferay.portal.kernel.systemevent.SystemEvent;
import com.liferay.portal.kernel.transaction.Isolation;
import com.liferay.portal.kernel.transaction.Propagation;
import com.liferay.portal.kernel.transaction.Transactional;
import com.liferay.portal.kernel.util.OrderByComparator;
import com.liferay.portal.kernel.util.UnicodeProperties;
import java.io.Serializable;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import org.osgi.annotation.versioning.ProviderType;
/**
* Provides the local service interface for ObjectAction. 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 ObjectActionLocalServiceUtil
* @generated
*/
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface ObjectActionLocalService
extends BaseLocalService, PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this interface directly. Add custom service methods to com.liferay.object.service.impl.ObjectActionLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface. Consume the object action local service via injection or a org.osgi.util.tracker.ServiceTracker. Use {@link ObjectActionLocalServiceUtil} if injection and service tracking are not available.
*/
/**
* 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
*/
@Indexable(type = IndexableType.REINDEX)
public ObjectAction addObjectAction(ObjectAction objectAction);
@Indexable(type = IndexableType.REINDEX)
public ObjectAction addObjectAction(
String externalReferenceCode, long userId, long objectDefinitionId,
boolean active, String conditionExpression, String description,
Map errorMessageMap, Map labelMap,
String name, String objectActionExecutorKey,
String objectActionTriggerKey,
UnicodeProperties parametersUnicodeProperties, boolean system)
throws PortalException;
@Indexable(type = IndexableType.REINDEX)
public 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,
UnicodeProperties parametersUnicodeProperties, boolean system)
throws PortalException;
/**
* 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
*/
@Transactional(enabled = false)
public ObjectAction createObjectAction(long objectActionId);
/**
* @throws PortalException
*/
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException;
/**
* 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
*/
@Indexable(type = IndexableType.DELETE)
public ObjectAction deleteObjectAction(long objectActionId)
throws PortalException;
/**
* 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
*/
@Indexable(type = IndexableType.DELETE)
@SystemEvent(type = SystemEventConstants.TYPE_DELETE)
public ObjectAction deleteObjectAction(ObjectAction objectAction)
throws PortalException;
public void deleteObjectActions(long objectDefinitionId)
throws PortalException;
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public T dslQuery(DSLQuery dslQuery);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int dslQueryCount(DSLQuery dslQuery);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public DynamicQuery dynamicQuery();
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(
DynamicQuery dynamicQuery, int start, int 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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(
DynamicQuery dynamicQuery, int start, int end,
OrderByComparator orderByComparator);
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @return the number of rows matching the dynamic query
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long dynamicQueryCount(DynamicQuery 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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long dynamicQueryCount(
DynamicQuery dynamicQuery, Projection projection);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectAction fetchObjectAction(long objectActionId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectAction fetchObjectAction(
String externalReferenceCode, long 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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectAction fetchObjectActionByUuidAndCompanyId(
String uuid, long companyId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ExportActionableDynamicQuery getExportActionableDynamicQuery(
PortletDataContext portletDataContext);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public IndexableActionableDynamicQuery 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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectAction getObjectAction(long objectActionId)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectAction getObjectAction(
long objectDefinitionId, String name, String objectActionTriggerKey)
throws PortalException;
/**
* 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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectAction getObjectActionByUuidAndCompanyId(
String uuid, long companyId)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getObjectActions(
boolean active, String 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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getObjectActions(int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getObjectActions(long objectDefinitionId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getObjectActions(
long objectDefinitionId, String objectActionTriggerKey);
/**
* Returns the number of object actions.
*
* @return the number of object actions
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getObjectActionsCount();
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
public String getOSGiServiceIdentifier();
/**
* @throws PortalException
*/
@Override
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException;
/**
* 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
*/
@Indexable(type = IndexableType.REINDEX)
public ObjectAction updateObjectAction(ObjectAction objectAction);
@Indexable(type = IndexableType.REINDEX)
public ObjectAction updateObjectAction(
String externalReferenceCode, long objectActionId, boolean active,
String conditionExpression, String description,
Map errorMessageMap, Map labelMap,
String name, String objectActionExecutorKey,
String objectActionTriggerKey,
UnicodeProperties parametersUnicodeProperties)
throws PortalException;
@Indexable(type = IndexableType.REINDEX)
public ObjectAction updateStatus(long objectActionId, int status)
throws PortalException;
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy