com.liferay.object.service.ObjectLayoutLocalService 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.object.service;
import com.liferay.exportimport.kernel.lar.PortletDataContext;
import com.liferay.object.model.ObjectLayout;
import com.liferay.object.model.ObjectLayoutTab;
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.SystemEventConstants;
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.systemevent.SystemEvent;
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.Locale;
import java.util.Map;
import org.osgi.annotation.versioning.ProviderType;
/**
* Provides the local service interface for ObjectLayout. 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 Marco Leo
* @see ObjectLayoutLocalServiceUtil
* @generated
*/
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface ObjectLayoutLocalService
extends BaseLocalService, PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this interface directly. Add custom service methods to com.liferay.object.service.impl.ObjectLayoutLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface. Consume the object layout local service via injection or a org.osgi.util.tracker.ServiceTracker. Use {@link ObjectLayoutLocalServiceUtil} if injection and service tracking are not available.
*/
@Indexable(type = IndexableType.REINDEX)
public ObjectLayout addObjectLayout(
long userId, long objectDefinitionId, boolean defaultObjectLayout,
Map nameMap, List objectLayoutTabs)
throws PortalException;
/**
* Adds the object layout to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectLayoutLocalServiceImpl 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 objectLayout the object layout
* @return the object layout that was added
*/
@Indexable(type = IndexableType.REINDEX)
public ObjectLayout addObjectLayout(ObjectLayout objectLayout);
/**
* Creates a new object layout with the primary key. Does not add the object layout to the database.
*
* @param objectLayoutId the primary key for the new object layout
* @return the new object layout
*/
@Transactional(enabled = false)
public ObjectLayout createObjectLayout(long objectLayoutId);
/**
* @throws PortalException
*/
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException;
/**
* Deletes the object layout with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectLayoutLocalServiceImpl 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 objectLayoutId the primary key of the object layout
* @return the object layout that was removed
* @throws PortalException if a object layout with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public ObjectLayout deleteObjectLayout(long objectLayoutId)
throws PortalException;
/**
* Deletes the object layout from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectLayoutLocalServiceImpl 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 objectLayout the object layout
* @return the object layout that was removed
* @throws PortalException
*/
@Indexable(type = IndexableType.DELETE)
@SystemEvent(type = SystemEventConstants.TYPE_DELETE)
public ObjectLayout deleteObjectLayout(ObjectLayout objectLayout)
throws PortalException;
public void deleteObjectLayouts(long objectDefinitionId)
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.object.model.impl.ObjectLayoutModelImpl.
*
*
* @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.object.model.impl.ObjectLayoutModelImpl.
*
*
* @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 ObjectLayout fetchDefaultObjectLayout(long objectDefinitionId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectLayout fetchObjectLayout(long objectLayoutId);
/**
* Returns the object layout with the matching UUID and company.
*
* @param uuid the object layout's UUID
* @param companyId the primary key of the company
* @return the matching object layout, or null if a matching object layout could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectLayout fetchObjectLayoutByUuidAndCompanyId(
String uuid, long companyId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectLayout getDefaultObjectLayout(long objectDefinitionId)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ExportActionableDynamicQuery getExportActionableDynamicQuery(
PortletDataContext portletDataContext);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
/**
* Returns the object layout with the primary key.
*
* @param objectLayoutId the primary key of the object layout
* @return the object layout
* @throws PortalException if a object layout with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectLayout getObjectLayout(long objectLayoutId)
throws PortalException;
/**
* Returns the object layout with the matching UUID and company.
*
* @param uuid the object layout's UUID
* @param companyId the primary key of the company
* @return the matching object layout
* @throws PortalException if a matching object layout could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectLayout getObjectLayoutByUuidAndCompanyId(
String uuid, long companyId)
throws PortalException;
/**
* Returns a range of all the object layouts.
*
*
* 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.object.model.impl.ObjectLayoutModelImpl.
*
*
* @param start the lower bound of the range of object layouts
* @param end the upper bound of the range of object layouts (not inclusive)
* @return the range of object layouts
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getObjectLayouts(int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getObjectLayouts(long objectDefinitionId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getObjectLayouts(
long objectDefinitionId, int start, int end);
/**
* Returns the number of object layouts.
*
* @return the number of object layouts
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getObjectLayoutsCount();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getObjectLayoutsCount(long objectDefinitionId);
/**
* 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;
@Indexable(type = IndexableType.REINDEX)
public ObjectLayout updateObjectLayout(
long objectLayoutId, boolean defaultObjectLayout,
Map nameMap, List objectLayoutTabs)
throws PortalException;
/**
* Updates the object layout in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectLayoutLocalServiceImpl 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 objectLayout the object layout
* @return the object layout that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public ObjectLayout updateObjectLayout(ObjectLayout objectLayout);
}