com.liferay.object.service.base.ObjectLayoutLocalServiceBaseImpl 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.base;
import com.liferay.exportimport.kernel.lar.ExportImportHelperUtil;
import com.liferay.exportimport.kernel.lar.ManifestSummary;
import com.liferay.exportimport.kernel.lar.PortletDataContext;
import com.liferay.exportimport.kernel.lar.StagedModelDataHandlerUtil;
import com.liferay.exportimport.kernel.lar.StagedModelType;
import com.liferay.object.model.ObjectLayout;
import com.liferay.object.service.ObjectLayoutLocalService;
import com.liferay.object.service.persistence.ObjectLayoutPersistence;
import com.liferay.petra.sql.dsl.query.DSLQuery;
import com.liferay.portal.aop.AopService;
import com.liferay.portal.kernel.dao.db.DB;
import com.liferay.portal.kernel.dao.db.DBManagerUtil;
import com.liferay.portal.kernel.dao.jdbc.SqlUpdate;
import com.liferay.portal.kernel.dao.jdbc.SqlUpdateFactoryUtil;
import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.DefaultActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.DynamicQuery;
import com.liferay.portal.kernel.dao.orm.DynamicQueryFactoryUtil;
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.log.Log;
import com.liferay.portal.kernel.log.LogFactoryUtil;
import com.liferay.portal.kernel.model.PersistedModel;
import com.liferay.portal.kernel.module.framework.service.IdentifiableOSGiService;
import com.liferay.portal.kernel.search.Indexable;
import com.liferay.portal.kernel.search.IndexableType;
import com.liferay.portal.kernel.service.BaseLocalServiceImpl;
import com.liferay.portal.kernel.service.PersistedModelLocalService;
import com.liferay.portal.kernel.service.persistence.BasePersistence;
import com.liferay.portal.kernel.transaction.Transactional;
import com.liferay.portal.kernel.util.OrderByComparator;
import com.liferay.portal.kernel.util.PortalUtil;
import java.io.Serializable;
import java.util.List;
import javax.sql.DataSource;
import org.osgi.service.component.annotations.Deactivate;
import org.osgi.service.component.annotations.Reference;
/**
* Provides the base implementation for the object layout local service.
*
*
* This implementation exists only as a container for the default service methods generated by ServiceBuilder. All custom service methods should be put in {@link com.liferay.object.service.impl.ObjectLayoutLocalServiceImpl}.
*
*
* @author Marco Leo
* @see com.liferay.object.service.impl.ObjectLayoutLocalServiceImpl
* @generated
*/
public abstract class ObjectLayoutLocalServiceBaseImpl
extends BaseLocalServiceImpl
implements AopService, IdentifiableOSGiService, ObjectLayoutLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this class directly. Use ObjectLayoutLocalService
via injection or a org.osgi.util.tracker.ServiceTracker
or use com.liferay.object.service.ObjectLayoutLocalServiceUtil
.
*/
/**
* 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)
@Override
public ObjectLayout addObjectLayout(ObjectLayout objectLayout) {
objectLayout.setNew(true);
return objectLayoutPersistence.update(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
*/
@Override
@Transactional(enabled = false)
public ObjectLayout createObjectLayout(long objectLayoutId) {
return objectLayoutPersistence.create(objectLayoutId);
}
/**
* 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)
@Override
public ObjectLayout deleteObjectLayout(long objectLayoutId)
throws PortalException {
return objectLayoutPersistence.remove(objectLayoutId);
}
/**
* 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)
@Override
public ObjectLayout deleteObjectLayout(ObjectLayout objectLayout)
throws PortalException {
return objectLayoutPersistence.remove(objectLayout);
}
@Override
public T dslQuery(DSLQuery dslQuery) {
return objectLayoutPersistence.dslQuery(dslQuery);
}
@Override
public int dslQueryCount(DSLQuery dslQuery) {
Long count = dslQuery(dslQuery);
return count.intValue();
}
@Override
public DynamicQuery dynamicQuery() {
Class> clazz = getClass();
return DynamicQueryFactoryUtil.forClass(
ObjectLayout.class, clazz.getClassLoader());
}
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
*/
@Override
public List dynamicQuery(DynamicQuery dynamicQuery) {
return objectLayoutPersistence.findWithDynamicQuery(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
*/
@Override
public List dynamicQuery(
DynamicQuery dynamicQuery, int start, int end) {
return objectLayoutPersistence.findWithDynamicQuery(
dynamicQuery, start, 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
*/
@Override
public List dynamicQuery(
DynamicQuery dynamicQuery, int start, int end,
OrderByComparator orderByComparator) {
return objectLayoutPersistence.findWithDynamicQuery(
dynamicQuery, start, end, orderByComparator);
}
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @return the number of rows matching the dynamic query
*/
@Override
public long dynamicQueryCount(DynamicQuery dynamicQuery) {
return objectLayoutPersistence.countWithDynamicQuery(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
*/
@Override
public long dynamicQueryCount(
DynamicQuery dynamicQuery, Projection projection) {
return objectLayoutPersistence.countWithDynamicQuery(
dynamicQuery, projection);
}
@Override
public ObjectLayout fetchObjectLayout(long objectLayoutId) {
return objectLayoutPersistence.fetchByPrimaryKey(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
*/
@Override
public ObjectLayout fetchObjectLayoutByUuidAndCompanyId(
String uuid, long companyId) {
return objectLayoutPersistence.fetchByUuid_C_First(
uuid, companyId, null);
}
/**
* 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
*/
@Override
public ObjectLayout getObjectLayout(long objectLayoutId)
throws PortalException {
return objectLayoutPersistence.findByPrimaryKey(objectLayoutId);
}
@Override
public ActionableDynamicQuery getActionableDynamicQuery() {
ActionableDynamicQuery actionableDynamicQuery =
new DefaultActionableDynamicQuery();
actionableDynamicQuery.setBaseLocalService(objectLayoutLocalService);
actionableDynamicQuery.setClassLoader(getClassLoader());
actionableDynamicQuery.setModelClass(ObjectLayout.class);
actionableDynamicQuery.setPrimaryKeyPropertyName("objectLayoutId");
return actionableDynamicQuery;
}
@Override
public IndexableActionableDynamicQuery
getIndexableActionableDynamicQuery() {
IndexableActionableDynamicQuery indexableActionableDynamicQuery =
new IndexableActionableDynamicQuery();
indexableActionableDynamicQuery.setBaseLocalService(
objectLayoutLocalService);
indexableActionableDynamicQuery.setClassLoader(getClassLoader());
indexableActionableDynamicQuery.setModelClass(ObjectLayout.class);
indexableActionableDynamicQuery.setPrimaryKeyPropertyName(
"objectLayoutId");
return indexableActionableDynamicQuery;
}
protected void initActionableDynamicQuery(
ActionableDynamicQuery actionableDynamicQuery) {
actionableDynamicQuery.setBaseLocalService(objectLayoutLocalService);
actionableDynamicQuery.setClassLoader(getClassLoader());
actionableDynamicQuery.setModelClass(ObjectLayout.class);
actionableDynamicQuery.setPrimaryKeyPropertyName("objectLayoutId");
}
@Override
public ExportActionableDynamicQuery getExportActionableDynamicQuery(
final PortletDataContext portletDataContext) {
final ExportActionableDynamicQuery exportActionableDynamicQuery =
new ExportActionableDynamicQuery() {
@Override
public long performCount() throws PortalException {
ManifestSummary manifestSummary =
portletDataContext.getManifestSummary();
StagedModelType stagedModelType = getStagedModelType();
long modelAdditionCount = super.performCount();
manifestSummary.addModelAdditionCount(
stagedModelType, modelAdditionCount);
long modelDeletionCount =
ExportImportHelperUtil.getModelDeletionCount(
portletDataContext, stagedModelType);
manifestSummary.addModelDeletionCount(
stagedModelType, modelDeletionCount);
return modelAdditionCount;
}
};
initActionableDynamicQuery(exportActionableDynamicQuery);
exportActionableDynamicQuery.setAddCriteriaMethod(
new ActionableDynamicQuery.AddCriteriaMethod() {
@Override
public void addCriteria(DynamicQuery dynamicQuery) {
portletDataContext.addDateRangeCriteria(
dynamicQuery, "modifiedDate");
}
});
exportActionableDynamicQuery.setCompanyId(
portletDataContext.getCompanyId());
exportActionableDynamicQuery.setPerformActionMethod(
new ActionableDynamicQuery.PerformActionMethod() {
@Override
public void performAction(ObjectLayout objectLayout)
throws PortalException {
StagedModelDataHandlerUtil.exportStagedModel(
portletDataContext, objectLayout);
}
});
exportActionableDynamicQuery.setStagedModelType(
new StagedModelType(
PortalUtil.getClassNameId(ObjectLayout.class.getName())));
return exportActionableDynamicQuery;
}
/**
* @throws PortalException
*/
@Override
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException {
return objectLayoutPersistence.create(
((Long)primaryKeyObj).longValue());
}
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException {
if (_log.isWarnEnabled()) {
_log.warn(
"Implement ObjectLayoutLocalServiceImpl#deleteObjectLayout(ObjectLayout) to avoid orphaned data");
}
return objectLayoutLocalService.deleteObjectLayout(
(ObjectLayout)persistedModel);
}
@Override
public BasePersistence getBasePersistence() {
return objectLayoutPersistence;
}
/**
* @throws PortalException
*/
@Override
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException {
return objectLayoutPersistence.findByPrimaryKey(primaryKeyObj);
}
/**
* 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
*/
@Override
public ObjectLayout getObjectLayoutByUuidAndCompanyId(
String uuid, long companyId)
throws PortalException {
return objectLayoutPersistence.findByUuid_C_First(
uuid, companyId, null);
}
/**
* 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
*/
@Override
public List getObjectLayouts(int start, int end) {
return objectLayoutPersistence.findAll(start, end);
}
/**
* Returns the number of object layouts.
*
* @return the number of object layouts
*/
@Override
public int getObjectLayoutsCount() {
return objectLayoutPersistence.countAll();
}
/**
* 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)
@Override
public ObjectLayout updateObjectLayout(ObjectLayout objectLayout) {
return objectLayoutPersistence.update(objectLayout);
}
@Deactivate
protected void deactivate() {
}
@Override
public Class>[] getAopInterfaces() {
return new Class>[] {
ObjectLayoutLocalService.class, IdentifiableOSGiService.class,
PersistedModelLocalService.class
};
}
@Override
public void setAopProxy(Object aopProxy) {
objectLayoutLocalService = (ObjectLayoutLocalService)aopProxy;
}
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
@Override
public String getOSGiServiceIdentifier() {
return ObjectLayoutLocalService.class.getName();
}
protected Class> getModelClass() {
return ObjectLayout.class;
}
protected String getModelClassName() {
return ObjectLayout.class.getName();
}
/**
* Performs a SQL query.
*
* @param sql the sql query
*/
protected void runSQL(String sql) {
try {
DataSource dataSource = objectLayoutPersistence.getDataSource();
DB db = DBManagerUtil.getDB();
sql = db.buildSQL(sql);
sql = PortalUtil.transformSQL(sql);
SqlUpdate sqlUpdate = SqlUpdateFactoryUtil.getSqlUpdate(
dataSource, sql);
sqlUpdate.update();
}
catch (Exception exception) {
throw new SystemException(exception);
}
}
protected ObjectLayoutLocalService objectLayoutLocalService;
@Reference
protected ObjectLayoutPersistence objectLayoutPersistence;
@Reference
protected com.liferay.counter.kernel.service.CounterLocalService
counterLocalService;
private static final Log _log = LogFactoryUtil.getLog(
ObjectLayoutLocalServiceBaseImpl.class);
}