com.liferay.change.tracking.service.CTCollectionTemplateLocalService 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.CTCollectionTemplate;
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 java.util.Set;
import org.osgi.annotation.versioning.ProviderType;
/**
* Provides the local service interface for CTCollectionTemplate. 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 CTCollectionTemplateLocalServiceUtil
* @generated
*/
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface CTCollectionTemplateLocalService
extends BaseLocalService, PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this interface directly. Add custom service methods to com.liferay.change.tracking.service.impl.CTCollectionTemplateLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface. Consume the ct collection template local service via injection or a org.osgi.util.tracker.ServiceTracker. Use {@link CTCollectionTemplateLocalServiceUtil} if injection and service tracking are not available.
*/
/**
* Adds the ct collection template to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect CTCollectionTemplateLocalServiceImpl 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 ctCollectionTemplate the ct collection template
* @return the ct collection template that was added
*/
@Indexable(type = IndexableType.REINDEX)
public CTCollectionTemplate addCTCollectionTemplate(
CTCollectionTemplate ctCollectionTemplate);
public CTCollectionTemplate addCTCollectionTemplate(
long userId, String name, String description, String json)
throws PortalException;
/**
* Creates a new ct collection template with the primary key. Does not add the ct collection template to the database.
*
* @param ctCollectionTemplateId the primary key for the new ct collection template
* @return the new ct collection template
*/
@Transactional(enabled = false)
public CTCollectionTemplate createCTCollectionTemplate(
long ctCollectionTemplateId);
/**
* @throws PortalException
*/
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException;
/**
* Deletes the ct collection template from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect CTCollectionTemplateLocalServiceImpl 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 ctCollectionTemplate the ct collection template
* @return the ct collection template that was removed
*/
@Indexable(type = IndexableType.DELETE)
public CTCollectionTemplate deleteCTCollectionTemplate(
CTCollectionTemplate ctCollectionTemplate);
/**
* Deletes the ct collection template with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect CTCollectionTemplateLocalServiceImpl 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 ctCollectionTemplateId the primary key of the ct collection template
* @return the ct collection template that was removed
* @throws PortalException if a ct collection template with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public CTCollectionTemplate deleteCTCollectionTemplate(
long ctCollectionTemplateId)
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.CTCollectionTemplateModelImpl.
*
*
* @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.CTCollectionTemplateModelImpl.
*
*
* @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 CTCollectionTemplate fetchCTCollectionTemplate(
long ctCollectionTemplateId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
/**
* Returns the ct collection template with the primary key.
*
* @param ctCollectionTemplateId the primary key of the ct collection template
* @return the ct collection template
* @throws PortalException if a ct collection template with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public CTCollectionTemplate getCTCollectionTemplate(
long ctCollectionTemplateId)
throws PortalException;
/**
* Returns a range of all the ct collection templates.
*
*
* 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.CTCollectionTemplateModelImpl.
*
*
* @param start the lower bound of the range of ct collection templates
* @param end the upper bound of the range of ct collection templates (not inclusive)
* @return the range of ct collection templates
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getCTCollectionTemplates(
int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getCTCollectionTemplates(
long companyId, int start, int end);
/**
* Returns the number of ct collection templates.
*
* @return the number of ct collection templates
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getCTCollectionTemplatesCount();
@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 Set getTokens();
public String parseTokens(long ctCollectionTemplateId, String s);
/**
* Updates the ct collection template in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect CTCollectionTemplateLocalServiceImpl 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 ctCollectionTemplate the ct collection template
* @return the ct collection template that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public CTCollectionTemplate updateCTCollectionTemplate(
CTCollectionTemplate ctCollectionTemplate);
public CTCollectionTemplate updateCTCollectionTemplate(
long ctCollectionTemplateId, String name, String description,
String json)
throws PortalException;
}