com.liferay.portal.service.base.LayoutLocalServiceBaseImpl Maven / Gradle / Ivy
/**
* Copyright (c) 2000-present Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.portal.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.StagedModelDataHandler;
import com.liferay.exportimport.kernel.lar.StagedModelDataHandlerRegistryUtil;
import com.liferay.exportimport.kernel.lar.StagedModelDataHandlerUtil;
import com.liferay.exportimport.kernel.lar.StagedModelType;
import com.liferay.petra.function.UnsafeFunction;
import com.liferay.petra.sql.dsl.query.DSLQuery;
import com.liferay.portal.kernel.bean.BeanReference;
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.Conjunction;
import com.liferay.portal.kernel.dao.orm.Criterion;
import com.liferay.portal.kernel.dao.orm.DefaultActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.Disjunction;
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.dao.orm.Property;
import com.liferay.portal.kernel.dao.orm.PropertyFactoryUtil;
import com.liferay.portal.kernel.dao.orm.RestrictionsFactoryUtil;
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.Layout;
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.LayoutLocalService;
import com.liferay.portal.kernel.service.LayoutLocalServiceUtil;
import com.liferay.portal.kernel.service.PersistedModelLocalServiceRegistry;
import com.liferay.portal.kernel.service.persistence.BasePersistence;
import com.liferay.portal.kernel.service.persistence.LayoutFinder;
import com.liferay.portal.kernel.service.persistence.LayoutPersistence;
import com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence;
import com.liferay.portal.kernel.transaction.Transactional;
import com.liferay.portal.kernel.util.OrderByComparator;
import com.liferay.portal.kernel.util.PortalUtil;
import com.liferay.portal.kernel.workflow.WorkflowConstants;
import java.io.Serializable;
import java.lang.reflect.Field;
import java.util.List;
import javax.sql.DataSource;
/**
* Provides the base implementation for the 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.portal.service.impl.LayoutLocalServiceImpl}.
*
*
* @author Brian Wing Shun Chan
* @see com.liferay.portal.service.impl.LayoutLocalServiceImpl
* @generated
*/
public abstract class LayoutLocalServiceBaseImpl
extends BaseLocalServiceImpl
implements IdentifiableOSGiService, LayoutLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this class directly. Use LayoutLocalService via injection or a org.osgi.util.tracker.ServiceTracker or use LayoutLocalServiceUtil.
*/
/**
* Adds the layout to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect LayoutLocalServiceImpl 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 layout the layout
* @return the layout that was added
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public Layout addLayout(Layout layout) {
layout.setNew(true);
return layoutPersistence.update(layout);
}
/**
* Creates a new layout with the primary key. Does not add the layout to the database.
*
* @param plid the primary key for the new layout
* @return the new layout
*/
@Override
@Transactional(enabled = false)
public Layout createLayout(long plid) {
return layoutPersistence.create(plid);
}
/**
* Deletes the layout with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect LayoutLocalServiceImpl 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 plid the primary key of the layout
* @return the layout that was removed
* @throws PortalException if a layout with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
@Override
public Layout deleteLayout(long plid) throws PortalException {
return layoutPersistence.remove(plid);
}
/**
* Deletes the layout from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect LayoutLocalServiceImpl 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 layout the layout
* @return the layout that was removed
* @throws PortalException
*/
@Indexable(type = IndexableType.DELETE)
@Override
public Layout deleteLayout(Layout layout) throws PortalException {
return layoutPersistence.remove(layout);
}
@Override
public T dslQuery(DSLQuery dslQuery) {
return layoutPersistence.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(
Layout.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 layoutPersistence.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.portal.model.impl.LayoutModelImpl.
*
*
* @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 layoutPersistence.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.portal.model.impl.LayoutModelImpl.
*
*
* @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 layoutPersistence.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 layoutPersistence.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 layoutPersistence.countWithDynamicQuery(
dynamicQuery, projection);
}
@Override
public Layout fetchLayout(long plid) {
return layoutPersistence.fetchByPrimaryKey(plid);
}
/**
* Returns the layout matching the UUID, group, and privacy.
*
* @param uuid the layout's UUID
* @param groupId the primary key of the group
* @param privateLayout whether the layout is private to the group
* @return the matching layout, or null if a matching layout could not be found
*/
@Override
public Layout fetchLayoutByUuidAndGroupId(
String uuid, long groupId, boolean privateLayout) {
return layoutPersistence.fetchByUUID_G_P(uuid, groupId, privateLayout);
}
/**
* Returns the layout with the primary key.
*
* @param plid the primary key of the layout
* @return the layout
* @throws PortalException if a layout with the primary key could not be found
*/
@Override
public Layout getLayout(long plid) throws PortalException {
return layoutPersistence.findByPrimaryKey(plid);
}
@Override
public ActionableDynamicQuery getActionableDynamicQuery() {
ActionableDynamicQuery actionableDynamicQuery =
new DefaultActionableDynamicQuery();
actionableDynamicQuery.setBaseLocalService(layoutLocalService);
actionableDynamicQuery.setClassLoader(getClassLoader());
actionableDynamicQuery.setModelClass(Layout.class);
actionableDynamicQuery.setPrimaryKeyPropertyName("plid");
return actionableDynamicQuery;
}
@Override
public IndexableActionableDynamicQuery
getIndexableActionableDynamicQuery() {
IndexableActionableDynamicQuery indexableActionableDynamicQuery =
new IndexableActionableDynamicQuery();
indexableActionableDynamicQuery.setBaseLocalService(layoutLocalService);
indexableActionableDynamicQuery.setClassLoader(getClassLoader());
indexableActionableDynamicQuery.setModelClass(Layout.class);
indexableActionableDynamicQuery.setPrimaryKeyPropertyName("plid");
return indexableActionableDynamicQuery;
}
protected void initActionableDynamicQuery(
ActionableDynamicQuery actionableDynamicQuery) {
actionableDynamicQuery.setBaseLocalService(layoutLocalService);
actionableDynamicQuery.setClassLoader(getClassLoader());
actionableDynamicQuery.setModelClass(Layout.class);
actionableDynamicQuery.setPrimaryKeyPropertyName("plid");
}
@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) {
Criterion modifiedDateCriterion =
portletDataContext.getDateRangeCriteria("modifiedDate");
if (modifiedDateCriterion != null) {
Conjunction conjunction =
RestrictionsFactoryUtil.conjunction();
conjunction.add(modifiedDateCriterion);
Disjunction disjunction =
RestrictionsFactoryUtil.disjunction();
disjunction.add(
RestrictionsFactoryUtil.gtProperty(
"modifiedDate", "lastPublishDate"));
Property lastPublishDateProperty =
PropertyFactoryUtil.forName("lastPublishDate");
disjunction.add(lastPublishDateProperty.isNull());
conjunction.add(disjunction);
modifiedDateCriterion = conjunction;
}
Criterion statusDateCriterion =
portletDataContext.getDateRangeCriteria("statusDate");
if ((modifiedDateCriterion != null) &&
(statusDateCriterion != null)) {
Disjunction disjunction =
RestrictionsFactoryUtil.disjunction();
disjunction.add(modifiedDateCriterion);
disjunction.add(statusDateCriterion);
dynamicQuery.add(disjunction);
}
StagedModelType stagedModelType =
exportActionableDynamicQuery.getStagedModelType();
long referrerClassNameId =
stagedModelType.getReferrerClassNameId();
Property classNameIdProperty = PropertyFactoryUtil.forName(
"classNameId");
if ((referrerClassNameId !=
StagedModelType.REFERRER_CLASS_NAME_ID_ALL) &&
(referrerClassNameId !=
StagedModelType.REFERRER_CLASS_NAME_ID_ANY)) {
dynamicQuery.add(
classNameIdProperty.eq(
stagedModelType.getReferrerClassNameId()));
}
else if (referrerClassNameId ==
StagedModelType.REFERRER_CLASS_NAME_ID_ANY) {
dynamicQuery.add(classNameIdProperty.isNotNull());
}
Property workflowStatusProperty =
PropertyFactoryUtil.forName("status");
if (portletDataContext.isInitialPublication()) {
dynamicQuery.add(
workflowStatusProperty.ne(
WorkflowConstants.STATUS_IN_TRASH));
}
else {
StagedModelDataHandler stagedModelDataHandler =
StagedModelDataHandlerRegistryUtil.
getStagedModelDataHandler(
Layout.class.getName());
dynamicQuery.add(
workflowStatusProperty.in(
stagedModelDataHandler.
getExportableStatuses()));
}
}
});
exportActionableDynamicQuery.setCompanyId(
portletDataContext.getCompanyId());
exportActionableDynamicQuery.setGroupId(
portletDataContext.getScopeGroupId());
exportActionableDynamicQuery.setPerformActionMethod(
new ActionableDynamicQuery.PerformActionMethod() {
@Override
public void performAction(Layout layout)
throws PortalException {
StagedModelDataHandlerUtil.exportStagedModel(
portletDataContext, layout);
}
});
exportActionableDynamicQuery.setStagedModelType(
new StagedModelType(
PortalUtil.getClassNameId(Layout.class.getName()),
StagedModelType.REFERRER_CLASS_NAME_ID_ALL));
return exportActionableDynamicQuery;
}
/**
* @throws PortalException
*/
@Override
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException {
return layoutPersistence.create(((Long)primaryKeyObj).longValue());
}
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException {
if (_log.isWarnEnabled()) {
_log.warn(
"Implement LayoutLocalServiceImpl#deleteLayout(Layout) to avoid orphaned data");
}
return layoutLocalService.deleteLayout((Layout)persistedModel);
}
@Override
public BasePersistence getBasePersistence() {
return layoutPersistence;
}
/**
* @throws PortalException
*/
@Override
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException {
return layoutPersistence.findByPrimaryKey(primaryKeyObj);
}
/**
* Returns all the layouts matching the UUID and company.
*
* @param uuid the UUID of the layouts
* @param companyId the primary key of the company
* @return the matching layouts, or an empty list if no matches were found
*/
@Override
public List getLayoutsByUuidAndCompanyId(
String uuid, long companyId) {
return layoutPersistence.findByUuid_C(uuid, companyId);
}
/**
* Returns a range of layouts matching the UUID and company.
*
* @param uuid the UUID of the layouts
* @param companyId the primary key of the company
* @param start the lower bound of the range of layouts
* @param end the upper bound of the range of layouts (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the range of matching layouts, or an empty list if no matches were found
*/
@Override
public List getLayoutsByUuidAndCompanyId(
String uuid, long companyId, int start, int end,
OrderByComparator orderByComparator) {
return layoutPersistence.findByUuid_C(
uuid, companyId, start, end, orderByComparator);
}
/**
* Returns the layout matching the UUID, group, and privacy.
*
* @param uuid the layout's UUID
* @param groupId the primary key of the group
* @param privateLayout whether the layout is private to the group
* @return the matching layout
* @throws PortalException if a matching layout could not be found
*/
@Override
public Layout getLayoutByUuidAndGroupId(
String uuid, long groupId, boolean privateLayout)
throws PortalException {
return layoutPersistence.findByUUID_G_P(uuid, groupId, privateLayout);
}
/**
* Returns a range of all the 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.portal.model.impl.LayoutModelImpl.
*
*
* @param start the lower bound of the range of layouts
* @param end the upper bound of the range of layouts (not inclusive)
* @return the range of layouts
*/
@Override
public List getLayouts(int start, int end) {
return layoutPersistence.findAll(start, end);
}
/**
* Returns the number of layouts.
*
* @return the number of layouts
*/
@Override
public int getLayoutsCount() {
return layoutPersistence.countAll();
}
/**
* Updates the layout in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect LayoutLocalServiceImpl 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 layout the layout
* @return the layout that was updated
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public Layout updateLayout(Layout layout) {
return layoutPersistence.update(layout);
}
/**
* Returns the layout local service.
*
* @return the layout local service
*/
public LayoutLocalService getLayoutLocalService() {
return layoutLocalService;
}
/**
* Sets the layout local service.
*
* @param layoutLocalService the layout local service
*/
public void setLayoutLocalService(LayoutLocalService layoutLocalService) {
this.layoutLocalService = layoutLocalService;
}
/**
* Returns the layout persistence.
*
* @return the layout persistence
*/
public LayoutPersistence getLayoutPersistence() {
return layoutPersistence;
}
/**
* Sets the layout persistence.
*
* @param layoutPersistence the layout persistence
*/
public void setLayoutPersistence(LayoutPersistence layoutPersistence) {
this.layoutPersistence = layoutPersistence;
}
/**
* Returns the layout finder.
*
* @return the layout finder
*/
public LayoutFinder getLayoutFinder() {
return layoutFinder;
}
/**
* Sets the layout finder.
*
* @param layoutFinder the layout finder
*/
public void setLayoutFinder(LayoutFinder layoutFinder) {
this.layoutFinder = layoutFinder;
}
/**
* Returns the counter local service.
*
* @return the counter local service
*/
public com.liferay.counter.kernel.service.CounterLocalService
getCounterLocalService() {
return counterLocalService;
}
/**
* Sets the counter local service.
*
* @param counterLocalService the counter local service
*/
public void setCounterLocalService(
com.liferay.counter.kernel.service.CounterLocalService
counterLocalService) {
this.counterLocalService = counterLocalService;
}
public void afterPropertiesSet() {
persistedModelLocalServiceRegistry.register(
"com.liferay.portal.kernel.model.Layout", layoutLocalService);
_setLocalServiceUtilService(layoutLocalService);
}
public void destroy() {
persistedModelLocalServiceRegistry.unregister(
"com.liferay.portal.kernel.model.Layout");
_setLocalServiceUtilService(null);
}
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
@Override
public String getOSGiServiceIdentifier() {
return LayoutLocalService.class.getName();
}
@Override
public CTPersistence getCTPersistence() {
return layoutPersistence;
}
@Override
public Class getModelClass() {
return Layout.class;
}
@Override
public R updateWithUnsafeFunction(
UnsafeFunction, R, E> updateUnsafeFunction)
throws E {
return updateUnsafeFunction.apply(layoutPersistence);
}
protected String getModelClassName() {
return Layout.class.getName();
}
/**
* Performs a SQL query.
*
* @param sql the sql query
*/
protected void runSQL(String sql) {
try {
DataSource dataSource = layoutPersistence.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);
}
}
private void _setLocalServiceUtilService(
LayoutLocalService layoutLocalService) {
try {
Field field = LayoutLocalServiceUtil.class.getDeclaredField(
"_service");
field.setAccessible(true);
field.set(null, layoutLocalService);
}
catch (ReflectiveOperationException reflectiveOperationException) {
throw new RuntimeException(reflectiveOperationException);
}
}
@BeanReference(type = LayoutLocalService.class)
protected LayoutLocalService layoutLocalService;
@BeanReference(type = LayoutPersistence.class)
protected LayoutPersistence layoutPersistence;
@BeanReference(type = LayoutFinder.class)
protected LayoutFinder layoutFinder;
@BeanReference(
type = com.liferay.counter.kernel.service.CounterLocalService.class
)
protected com.liferay.counter.kernel.service.CounterLocalService
counterLocalService;
private static final Log _log = LogFactoryUtil.getLog(
LayoutLocalServiceBaseImpl.class);
@BeanReference(type = PersistedModelLocalServiceRegistry.class)
protected PersistedModelLocalServiceRegistry
persistedModelLocalServiceRegistry;
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy