com.liferay.layout.service.LayoutLocalizationLocalService 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.layout.service;
import com.liferay.exportimport.kernel.lar.PortletDataContext;
import com.liferay.layout.model.LayoutLocalization;
import com.liferay.petra.function.UnsafeFunction;
import com.liferay.petra.sql.dsl.query.DSLQuery;
import com.liferay.portal.kernel.change.tracking.CTAware;
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.service.ServiceContext;
import com.liferay.portal.kernel.service.change.tracking.CTService;
import com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence;
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 LayoutLocalization. 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 LayoutLocalizationLocalServiceUtil
* @generated
*/
@CTAware
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface LayoutLocalizationLocalService
extends BaseLocalService, CTService,
PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this interface directly. Add custom service methods to com.liferay.layout.service.impl.LayoutLocalizationLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface. Consume the layout localization local service via injection or a org.osgi.util.tracker.ServiceTracker. Use {@link LayoutLocalizationLocalServiceUtil} if injection and service tracking are not available.
*/
/**
* Adds the layout localization to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect LayoutLocalizationLocalServiceImpl 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 layoutLocalization the layout localization
* @return the layout localization that was added
*/
@Indexable(type = IndexableType.REINDEX)
public LayoutLocalization addLayoutLocalization(
LayoutLocalization layoutLocalization);
public LayoutLocalization addLayoutLocalization(
long groupId, String content, String languageId, long plid,
ServiceContext serviceContext);
/**
* Creates a new layout localization with the primary key. Does not add the layout localization to the database.
*
* @param layoutLocalizationId the primary key for the new layout localization
* @return the new layout localization
*/
@Transactional(enabled = false)
public LayoutLocalization createLayoutLocalization(
long layoutLocalizationId);
/**
* @throws PortalException
*/
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException;
/**
* Deletes the layout localization from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect LayoutLocalizationLocalServiceImpl 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 layoutLocalization the layout localization
* @return the layout localization that was removed
*/
@Indexable(type = IndexableType.DELETE)
public LayoutLocalization deleteLayoutLocalization(
LayoutLocalization layoutLocalization);
/**
* Deletes the layout localization with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect LayoutLocalizationLocalServiceImpl 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 layoutLocalizationId the primary key of the layout localization
* @return the layout localization that was removed
* @throws PortalException if a layout localization with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public LayoutLocalization deleteLayoutLocalization(
long layoutLocalizationId)
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.layout.model.impl.LayoutLocalizationModelImpl.
*
*
* @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.layout.model.impl.LayoutLocalizationModelImpl.
*
*
* @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 LayoutLocalization fetchLayoutLocalization(
long layoutLocalizationId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public LayoutLocalization fetchLayoutLocalization(
long groupId, String languageId, long plid);
/**
* Returns the layout localization matching the UUID and group.
*
* @param uuid the layout localization's UUID
* @param groupId the primary key of the group
* @return the matching layout localization, or null if a matching layout localization could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public LayoutLocalization fetchLayoutLocalizationByUuidAndGroupId(
String uuid, long groupId);
@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 layout localization with the primary key.
*
* @param layoutLocalizationId the primary key of the layout localization
* @return the layout localization
* @throws PortalException if a layout localization with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public LayoutLocalization getLayoutLocalization(long layoutLocalizationId)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public LayoutLocalization getLayoutLocalization(
String languageId, long plid)
throws PortalException;
/**
* Returns the layout localization matching the UUID and group.
*
* @param uuid the layout localization's UUID
* @param groupId the primary key of the group
* @return the matching layout localization
* @throws PortalException if a matching layout localization could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public LayoutLocalization getLayoutLocalizationByUuidAndGroupId(
String uuid, long groupId)
throws PortalException;
/**
* Returns a range of all the layout localizations.
*
*
* 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.layout.model.impl.LayoutLocalizationModelImpl.
*
*
* @param start the lower bound of the range of layout localizations
* @param end the upper bound of the range of layout localizations (not inclusive)
* @return the range of layout localizations
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getLayoutLocalizations(int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getLayoutLocalizations(long plid);
/**
* Returns all the layout localizations matching the UUID and company.
*
* @param uuid the UUID of the layout localizations
* @param companyId the primary key of the company
* @return the matching layout localizations, or an empty list if no matches were found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getLayoutLocalizationsByUuidAndCompanyId(
String uuid, long companyId);
/**
* Returns a range of layout localizations matching the UUID and company.
*
* @param uuid the UUID of the layout localizations
* @param companyId the primary key of the company
* @param start the lower bound of the range of layout localizations
* @param end the upper bound of the range of layout localizations (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the range of matching layout localizations, or an empty list if no matches were found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getLayoutLocalizationsByUuidAndCompanyId(
String uuid, long companyId, int start, int end,
OrderByComparator orderByComparator);
/**
* Returns the number of layout localizations.
*
* @return the number of layout localizations
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getLayoutLocalizationsCount();
/**
* 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;
/**
* Updates the layout localization in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect LayoutLocalizationLocalServiceImpl 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 layoutLocalization the layout localization
* @return the layout localization that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public LayoutLocalization updateLayoutLocalization(
LayoutLocalization layoutLocalization);
public LayoutLocalization updateLayoutLocalization(
String content, String languageId, long plid,
ServiceContext serviceContext);
@Override
@Transactional(enabled = false)
public CTPersistence getCTPersistence();
@Override
@Transactional(enabled = false)
public Class getModelClass();
@Override
@Transactional(rollbackFor = Throwable.class)
public R updateWithUnsafeFunction(
UnsafeFunction, R, E>
updateUnsafeFunction)
throws E;
} © 2015 - 2024 Weber Informatics LLC | Privacy Policy