com.liferay.change.tracking.service.CTEntryLocalService 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.change.tracking.service;
import com.liferay.change.tracking.model.CTEntry;
import com.liferay.exportimport.kernel.lar.PortletDataContext;
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.change.tracking.CTModel;
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 CTEntry. 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 Brian Wing Shun Chan
* @see CTEntryLocalServiceUtil
* @generated
*/
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface CTEntryLocalService
extends BaseLocalService, PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this interface directly. Add custom service methods to com.liferay.change.tracking.service.impl.CTEntryLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface. Consume the ct entry local service via injection or a org.osgi.util.tracker.ServiceTracker. Use {@link CTEntryLocalServiceUtil} if injection and service tracking are not available.
*/
/**
* Adds the ct entry to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect CTEntryLocalServiceImpl 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 ctEntry the ct entry
* @return the ct entry that was added
*/
@Indexable(type = IndexableType.REINDEX)
public CTEntry addCTEntry(CTEntry ctEntry);
@Indexable(type = IndexableType.REINDEX)
public CTEntry addCTEntry(
String externalReferenceCode, long ctCollectionId,
long modelClassNameId, CTModel ctModel, long userId,
int changeType)
throws PortalException;
/**
* Creates a new ct entry with the primary key. Does not add the ct entry to the database.
*
* @param ctEntryId the primary key for the new ct entry
* @return the new ct entry
*/
@Transactional(enabled = false)
public CTEntry createCTEntry(long ctEntryId);
/**
* @throws PortalException
*/
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException;
/**
* Deletes the ct entry from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect CTEntryLocalServiceImpl 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 ctEntry the ct entry
* @return the ct entry that was removed
* @throws PortalException
*/
@Indexable(type = IndexableType.DELETE)
public CTEntry deleteCTEntry(CTEntry ctEntry) throws PortalException;
/**
* Deletes the ct entry with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect CTEntryLocalServiceImpl 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 ctEntryId the primary key of the ct entry
* @return the ct entry that was removed
* @throws PortalException if a ct entry with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public CTEntry deleteCTEntry(long ctEntryId) 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.change.tracking.model.impl.CTEntryModelImpl.
*
*
* @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.change.tracking.model.impl.CTEntryModelImpl.
*
*
* @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 CTEntry fetchCTEntry(long ctEntryId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public CTEntry fetchCTEntry(
long ctCollectionId, long modelClassNameId, long modelClassPK);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public CTEntry fetchCTEntryByExternalReferenceCode(
String externalReferenceCode, long companyId);
/**
* Returns the ct entry with the matching UUID and company.
*
* @param uuid the ct entry's UUID
* @param companyId the primary key of the company
* @return the matching ct entry, or null if a matching ct entry could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public CTEntry fetchCTEntryByUuidAndCompanyId(String uuid, long companyId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public CTEntry fetchTimelineCTEntry(
long ctCollectionId, long modelClassNameId, long modelClassPK);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getCTCollectionCTEntries(long ctCollectionId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getCTCollectionCTEntries(
long ctCollectionId, int start, int end,
OrderByComparator orderByComparator);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getCTCollectionCTEntriesCount(long ctCollectionId);
/**
* Returns a range of all the ct entries.
*
*
* 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.change.tracking.model.impl.CTEntryModelImpl.
*
*
* @param start the lower bound of the range of ct entries
* @param end the upper bound of the range of ct entries (not inclusive)
* @return the range of ct entries
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getCTEntries(int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getCTEntries(
long ctCollectionId, long modelClassNameId);
/**
* Returns the number of ct entries.
*
* @return the number of ct entries
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getCTEntriesCount();
/**
* Returns the ct entry with the primary key.
*
* @param ctEntryId the primary key of the ct entry
* @return the ct entry
* @throws PortalException if a ct entry with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public CTEntry getCTEntry(long ctEntryId) throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public CTEntry getCTEntryByExternalReferenceCode(
String externalReferenceCode, long companyId)
throws PortalException;
/**
* Returns the ct entry with the matching UUID and company.
*
* @param uuid the ct entry's UUID
* @param companyId the primary key of the company
* @return the matching ct entry
* @throws PortalException if a matching ct entry could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public CTEntry getCTEntryByUuidAndCompanyId(String uuid, long companyId)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long getCTRowCTCollectionId(CTEntry ctEntry) throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getExclusiveModelClassPKs(
long ctCollectionId, long modelClassNameId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ExportActionableDynamicQuery getExportActionableDynamicQuery(
PortletDataContext portletDataContext);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
/**
* 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;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public boolean hasCTEntries(long ctCollectionId, long modelClassNameId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public boolean hasCTEntry(
long ctCollectionId, long modelClassNameId, long modelClassPK);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public boolean hasUnpublishedCTEntries(
long modelClassNameId, long modelClassPK, int changeType);
/**
* Updates the ct entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect CTEntryLocalServiceImpl 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 ctEntry the ct entry
* @return the ct entry that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public CTEntry updateCTEntry(CTEntry ctEntry);
public CTEntry updateModelMvccVersion(
long ctEntryId, long modelMvccVersion);
}