com.liferay.object.service.ObjectStateTransitionLocalService 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.ObjectStateFlow;
import com.liferay.object.model.ObjectStateTransition;
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.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.transaction.Isolation;
import com.liferay.portal.kernel.transaction.Propagation;
import com.liferay.portal.kernel.transaction.Transactional;
import com.liferay.portal.kernel.util.OrderByComparator;
import java.io.Serializable;
import java.util.List;
import org.osgi.annotation.versioning.ProviderType;
/**
* Provides the local service interface for ObjectStateTransition. 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 ObjectStateTransitionLocalServiceUtil
* @generated
*/
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface ObjectStateTransitionLocalService
extends BaseLocalService, PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this interface directly. Add custom service methods to com.liferay.object.service.impl.ObjectStateTransitionLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface. Consume the object state transition local service via injection or a org.osgi.util.tracker.ServiceTracker. Use {@link ObjectStateTransitionLocalServiceUtil} if injection and service tracking are not available.
*/
public ObjectStateTransition addObjectStateTransition(
long userId, long objectStateFlowId, long sourceObjectStateId,
long targetObjectStateId)
throws PortalException;
/**
* Adds the object state transition to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectStateTransitionLocalServiceImpl 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 objectStateTransition the object state transition
* @return the object state transition that was added
*/
@Indexable(type = IndexableType.REINDEX)
public ObjectStateTransition addObjectStateTransition(
ObjectStateTransition objectStateTransition);
/**
* Creates a new object state transition with the primary key. Does not add the object state transition to the database.
*
* @param objectStateTransitionId the primary key for the new object state transition
* @return the new object state transition
*/
@Transactional(enabled = false)
public ObjectStateTransition createObjectStateTransition(
long objectStateTransitionId);
/**
* @throws PortalException
*/
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException;
public void deleteObjectStateFlowObjectStateTransitions(
long objectStateFlowId);
public void deleteObjectStateObjectStateTransitions(long objectStateId);
/**
* Deletes the object state transition with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectStateTransitionLocalServiceImpl 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 objectStateTransitionId the primary key of the object state transition
* @return the object state transition that was removed
* @throws PortalException if a object state transition with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public ObjectStateTransition deleteObjectStateTransition(
long objectStateTransitionId)
throws PortalException;
/**
* Deletes the object state transition from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectStateTransitionLocalServiceImpl 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 objectStateTransition the object state transition
* @return the object state transition that was removed
*/
@Indexable(type = IndexableType.DELETE)
public ObjectStateTransition deleteObjectStateTransition(
ObjectStateTransition objectStateTransition);
/**
* @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.ObjectStateTransitionModelImpl.
*
*
* @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.ObjectStateTransitionModelImpl.
*
*
* @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 ObjectStateTransition fetchObjectStateTransition(
long objectStateTransitionId);
/**
* Returns the object state transition with the matching UUID and company.
*
* @param uuid the object state transition's UUID
* @param companyId the primary key of the company
* @return the matching object state transition, or null if a matching object state transition could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectStateTransition fetchObjectStateTransitionByUuidAndCompanyId(
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();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getObjectStateFlowObjectStateTransitions(
long objectStateFlowId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getObjectStateObjectStateTransitions(
long objectStateId);
/**
* Returns the object state transition with the primary key.
*
* @param objectStateTransitionId the primary key of the object state transition
* @return the object state transition
* @throws PortalException if a object state transition with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectStateTransition getObjectStateTransition(
long objectStateTransitionId)
throws PortalException;
/**
* Returns the object state transition with the matching UUID and company.
*
* @param uuid the object state transition's UUID
* @param companyId the primary key of the company
* @return the matching object state transition
* @throws PortalException if a matching object state transition could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectStateTransition getObjectStateTransitionByUuidAndCompanyId(
String uuid, long companyId)
throws PortalException;
/**
* Returns a range of all the object state transitions.
*
*
* 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.ObjectStateTransitionModelImpl.
*
*
* @param start the lower bound of the range of object state transitions
* @param end the upper bound of the range of object state transitions (not inclusive)
* @return the range of object state transitions
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getObjectStateTransitions(
int start, int end);
/**
* Returns the number of object state transitions.
*
* @return the number of object state transitions
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getObjectStateTransitionsCount();
/**
* 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 state transition in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectStateTransitionLocalServiceImpl 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 objectStateTransition the object state transition
* @return the object state transition that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public ObjectStateTransition updateObjectStateTransition(
ObjectStateTransition objectStateTransition);
public void updateObjectStateTransitions(ObjectStateFlow objectStateFlow)
throws PortalException;
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy