com.liferay.object.service.ObjectStateFlowLocalService 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.ObjectField;
import com.liferay.object.model.ObjectState;
import com.liferay.object.model.ObjectStateFlow;
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 ObjectStateFlow. 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 ObjectStateFlowLocalServiceUtil
* @generated
*/
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface ObjectStateFlowLocalService
extends BaseLocalService, PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this interface directly. Add custom service methods to com.liferay.object.service.impl.ObjectStateFlowLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface. Consume the object state flow local service via injection or a org.osgi.util.tracker.ServiceTracker. Use {@link ObjectStateFlowLocalServiceUtil} if injection and service tracking are not available.
*/
public ObjectStateFlow addDefaultObjectStateFlow(ObjectField objectField)
throws PortalException;
public ObjectStateFlow addObjectStateFlow(
long userId, long objectFieldId, List objectStates)
throws PortalException;
/**
* Adds the object state flow to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectStateFlowLocalServiceImpl 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 objectStateFlow the object state flow
* @return the object state flow that was added
*/
@Indexable(type = IndexableType.REINDEX)
public ObjectStateFlow addObjectStateFlow(ObjectStateFlow objectStateFlow);
/**
* Creates a new object state flow with the primary key. Does not add the object state flow to the database.
*
* @param objectStateFlowId the primary key for the new object state flow
* @return the new object state flow
*/
@Transactional(enabled = false)
public ObjectStateFlow createObjectStateFlow(long objectStateFlowId);
/**
* @throws PortalException
*/
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException;
public void deleteObjectFieldObjectStateFlow(long objectFieldId)
throws PortalException;
/**
* Deletes the object state flow with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectStateFlowLocalServiceImpl 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 objectStateFlowId the primary key of the object state flow
* @return the object state flow that was removed
* @throws PortalException if a object state flow with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public ObjectStateFlow deleteObjectStateFlow(long objectStateFlowId)
throws PortalException;
/**
* Deletes the object state flow from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectStateFlowLocalServiceImpl 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 objectStateFlow the object state flow
* @return the object state flow that was removed
*/
@Indexable(type = IndexableType.DELETE)
public ObjectStateFlow deleteObjectStateFlow(
ObjectStateFlow objectStateFlow);
/**
* @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.ObjectStateFlowModelImpl.
*
*
* @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.ObjectStateFlowModelImpl.
*
*
* @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 ObjectStateFlow fetchObjectFieldObjectStateFlow(long objectFieldId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectStateFlow fetchObjectStateFlow(long objectStateFlowId);
/**
* Returns the object state flow with the matching UUID and company.
*
* @param uuid the object state flow's UUID
* @param companyId the primary key of the company
* @return the matching object state flow, or null if a matching object state flow could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectStateFlow fetchObjectStateFlowByUuidAndCompanyId(
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 state flow with the primary key.
*
* @param objectStateFlowId the primary key of the object state flow
* @return the object state flow
* @throws PortalException if a object state flow with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectStateFlow getObjectStateFlow(long objectStateFlowId)
throws PortalException;
/**
* Returns the object state flow with the matching UUID and company.
*
* @param uuid the object state flow's UUID
* @param companyId the primary key of the company
* @return the matching object state flow
* @throws PortalException if a matching object state flow could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectStateFlow getObjectStateFlowByUuidAndCompanyId(
String uuid, long companyId)
throws PortalException;
/**
* Returns a range of all the object state flows.
*
*
* 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.ObjectStateFlowModelImpl.
*
*
* @param start the lower bound of the range of object state flows
* @param end the upper bound of the range of object state flows (not inclusive)
* @return the range of object state flows
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getObjectStateFlows(int start, int end);
/**
* Returns the number of object state flows.
*
* @return the number of object state flows
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getObjectStateFlowsCount();
/**
* 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;
public ObjectStateFlow updateDefaultObjectStateFlow(
ObjectField newObjectField, ObjectField oldObjectField)
throws PortalException;
public void updateObjectStateFlow(
long userId, long objectStateFlowId, List objectStates)
throws PortalException;
/**
* Updates the object state flow in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectStateFlowLocalServiceImpl 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 objectStateFlow the object state flow
* @return the object state flow that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public ObjectStateFlow updateObjectStateFlow(
ObjectStateFlow objectStateFlow);
}