com.liferay.change.tracking.service.CTCollectionLocalService 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.conflict.ConflictInfo;
import com.liferay.change.tracking.mapping.CTMappingTableInfo;
import com.liferay.change.tracking.model.CTCollection;
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.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.sql.SQLException;
import java.util.List;
import java.util.Map;
import org.osgi.annotation.versioning.ProviderType;
/**
* Provides the local service interface for CTCollection. 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 CTCollectionLocalServiceUtil
* @generated
*/
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface CTCollectionLocalService
extends BaseLocalService, PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this interface directly. Add custom service methods to com.liferay.change.tracking.service.impl.CTCollectionLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface. Consume the ct collection local service via injection or a org.osgi.util.tracker.ServiceTracker. Use {@link CTCollectionLocalServiceUtil} if injection and service tracking are not available.
*/
/**
* Adds the ct collection to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect CTCollectionLocalServiceImpl 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 ctCollection the ct collection
* @return the ct collection that was added
*/
@Indexable(type = IndexableType.REINDEX)
public CTCollection addCTCollection(CTCollection ctCollection);
@Indexable(type = IndexableType.REINDEX)
public CTCollection addCTCollection(
String externalReferenceCode, long companyId, long userId,
long ctRemoteId, String name, String description)
throws PortalException;
public Map> checkConflicts(
CTCollection ctCollection)
throws PortalException;
public Map> checkConflicts(
long companyId, List ctEntries, long fromCTCollectionId,
String fromCTCollectionName, long toCTCollectionId,
String toCTCollectionName)
throws PortalException;
public Map> checkConflicts(
long companyId, long[] ctEntryIds, long fromCTCollectionId,
String fromCTCollectionName, long toCTCollectionId,
String toCTCollectionName)
throws PortalException;
/**
* Creates a new ct collection with the primary key. Does not add the ct collection to the database.
*
* @param ctCollectionId the primary key for the new ct collection
* @return the new ct collection
*/
@Transactional(enabled = false)
public CTCollection createCTCollection(long ctCollectionId);
/**
* @throws PortalException
*/
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException;
public void deleteCompanyCTCollections(long companyId)
throws PortalException;
public void deleteCTAutoResolutionInfo(long ctAutoResolutionInfoId);
/**
* Deletes the ct collection from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect CTCollectionLocalServiceImpl 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 ctCollection the ct collection
* @return the ct collection that was removed
* @throws PortalException
*/
@Indexable(type = IndexableType.DELETE)
public CTCollection deleteCTCollection(CTCollection ctCollection)
throws PortalException;
/**
* Deletes the ct collection with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect CTCollectionLocalServiceImpl 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 ctCollectionId the primary key of the ct collection
* @return the ct collection that was removed
* @throws PortalException if a ct collection with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public CTCollection deleteCTCollection(long ctCollectionId)
throws PortalException;
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException;
public void discardCTEntry(
long ctCollectionId, long modelClassNameId, long modelClassPK,
boolean force)
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.CTCollectionModelImpl.
*
*
* @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.CTCollectionModelImpl.
*
*
* @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 CTCollection fetchCTCollection(long ctCollectionId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public CTCollection fetchCTCollectionByExternalReferenceCode(
String externalReferenceCode, long companyId);
/**
* Returns the ct collection with the matching UUID and company.
*
* @param uuid the ct collection's UUID
* @param companyId the primary key of the company
* @return the matching ct collection, or null if a matching ct collection could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public CTCollection fetchCTCollectionByUuidAndCompanyId(
String uuid, long companyId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
/**
* Returns the ct collection with the primary key.
*
* @param ctCollectionId the primary key of the ct collection
* @return the ct collection
* @throws PortalException if a ct collection with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public CTCollection getCTCollection(long ctCollectionId)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public CTCollection getCTCollectionByExternalReferenceCode(
String externalReferenceCode, long companyId)
throws PortalException;
/**
* Returns the ct collection with the matching UUID and company.
*
* @param uuid the ct collection's UUID
* @param companyId the primary key of the company
* @return the matching ct collection
* @throws PortalException if a matching ct collection could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public CTCollection getCTCollectionByUuidAndCompanyId(
String uuid, long companyId)
throws PortalException;
/**
* Returns a range of all the ct collections.
*
*
* 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.CTCollectionModelImpl.
*
*
* @param start the lower bound of the range of ct collections
* @param end the upper bound of the range of ct collections (not inclusive)
* @return the range of ct collections
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getCTCollections(int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getCTCollections(
long companyId, int status, int start, int end,
OrderByComparator orderByComparator);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getCTCollections(
long companyId, int[] statuses, int start, int end,
OrderByComparator orderByComparator);
/**
* Returns the number of ct collections.
*
* @return the number of ct collections
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getCTCollectionsCount();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getCTMappingTableInfos(long ctCollectionId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getExclusivePublishedCTCollections(
long modelClassNameId, long modelClassPK)
throws PortalException;
@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 List getRelatedCTEntries(
long ctCollectionId, long[] ctEntryIds)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public Map> getRelatedCTEntriesMap(
long ctCollectionId, long modelClassNameId, long modelClassPK)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public boolean hasUnapprovedChanges(long ctCollectionId)
throws SQLException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public boolean isCTEntryEnclosed(
long ctCollectionId, long modelClassNameId, long modelClassPK);
public void moveCTEntry(
long fromCTCollectionId, long toCTCollectionId,
long modelClassNameId, long modelClassPK)
throws PortalException;
public CTCollection undoCTCollection(
long ctCollectionId, long userId, String name, String description)
throws PortalException;
/**
* Updates the ct collection in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect CTCollectionLocalServiceImpl 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 ctCollection the ct collection
* @return the ct collection that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public CTCollection updateCTCollection(CTCollection ctCollection);
@Indexable(type = IndexableType.REINDEX)
public CTCollection updateCTCollection(
long userId, long ctCollectionId, String name, String description)
throws PortalException;
}