com.liferay.change.tracking.service.CTSchemaVersionLocalService 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.CTSchemaVersion;
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.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 CTSchemaVersion. 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 CTSchemaVersionLocalServiceUtil
* @generated
*/
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface CTSchemaVersionLocalService
extends BaseLocalService, PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this interface directly. Add custom service methods to com.liferay.change.tracking.service.impl.CTSchemaVersionLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface. Consume the ct schema version local service via injection or a org.osgi.util.tracker.ServiceTracker. Use {@link CTSchemaVersionLocalServiceUtil} if injection and service tracking are not available.
*/
/**
* Adds the ct schema version to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect CTSchemaVersionLocalServiceImpl 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 ctSchemaVersion the ct schema version
* @return the ct schema version that was added
*/
@Indexable(type = IndexableType.REINDEX)
public CTSchemaVersion addCTSchemaVersion(CTSchemaVersion ctSchemaVersion);
public CTSchemaVersion addLatestCTSchemaVersion(long companyId);
/**
* Creates a new ct schema version with the primary key. Does not add the ct schema version to the database.
*
* @param schemaVersionId the primary key for the new ct schema version
* @return the new ct schema version
*/
@Transactional(enabled = false)
public CTSchemaVersion createCTSchemaVersion(long schemaVersionId);
/**
* @throws PortalException
*/
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException;
/**
* Deletes the ct schema version from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect CTSchemaVersionLocalServiceImpl 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 ctSchemaVersion the ct schema version
* @return the ct schema version that was removed
*/
@Indexable(type = IndexableType.DELETE)
public CTSchemaVersion deleteCTSchemaVersion(
CTSchemaVersion ctSchemaVersion);
/**
* Deletes the ct schema version with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect CTSchemaVersionLocalServiceImpl 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 schemaVersionId the primary key of the ct schema version
* @return the ct schema version that was removed
* @throws PortalException if a ct schema version with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public CTSchemaVersion deleteCTSchemaVersion(long schemaVersionId)
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.CTSchemaVersionModelImpl.
*
*
* @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.CTSchemaVersionModelImpl.
*
*
* @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 CTSchemaVersion fetchCTSchemaVersion(long schemaVersionId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
/**
* Returns the ct schema version with the primary key.
*
* @param schemaVersionId the primary key of the ct schema version
* @return the ct schema version
* @throws PortalException if a ct schema version with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public CTSchemaVersion getCTSchemaVersion(long schemaVersionId)
throws PortalException;
/**
* Returns a range of all the ct schema versions.
*
*
* 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.CTSchemaVersionModelImpl.
*
*
* @param start the lower bound of the range of ct schema versions
* @param end the upper bound of the range of ct schema versions (not inclusive)
* @return the range of ct schema versions
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getCTSchemaVersions(int start, int end);
/**
* Returns the number of ct schema versions.
*
* @return the number of ct schema versions
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getCTSchemaVersionsCount();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public CTSchemaVersion getLatestCTSchemaVersion(long companyId);
/**
* 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 isLatestCTSchemaVersion(
CTSchemaVersion ctSchemaVersion, boolean strict);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public boolean isLatestCTSchemaVersion(long ctSchemaVersionId);
/**
* Updates the ct schema version in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect CTSchemaVersionLocalServiceImpl 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 ctSchemaVersion the ct schema version
* @return the ct schema version that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public CTSchemaVersion updateCTSchemaVersion(
CTSchemaVersion ctSchemaVersion);
}