com.liferay.fragment.service.base.FragmentCompositionLocalServiceBaseImpl 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.fragment.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.fragment.model.FragmentComposition;
import com.liferay.fragment.service.FragmentCompositionLocalService;
import com.liferay.fragment.service.persistence.FragmentCompositionPersistence;
import com.liferay.petra.function.UnsafeFunction;
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.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.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.change.tracking.CTService;
import com.liferay.portal.kernel.service.persistence.BasePersistence;
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.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 fragment composition 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.fragment.service.impl.FragmentCompositionLocalServiceImpl}.
*
*
* @author Brian Wing Shun Chan
* @see com.liferay.fragment.service.impl.FragmentCompositionLocalServiceImpl
* @generated
*/
public abstract class FragmentCompositionLocalServiceBaseImpl
extends BaseLocalServiceImpl
implements AopService, FragmentCompositionLocalService,
IdentifiableOSGiService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this class directly. Use FragmentCompositionLocalService
via injection or a org.osgi.util.tracker.ServiceTracker
or use com.liferay.fragment.service.FragmentCompositionLocalServiceUtil
.
*/
/**
* Adds the fragment composition to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect FragmentCompositionLocalServiceImpl 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 fragmentComposition the fragment composition
* @return the fragment composition that was added
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public FragmentComposition addFragmentComposition(
FragmentComposition fragmentComposition) {
fragmentComposition.setNew(true);
return fragmentCompositionPersistence.update(fragmentComposition);
}
/**
* Creates a new fragment composition with the primary key. Does not add the fragment composition to the database.
*
* @param fragmentCompositionId the primary key for the new fragment composition
* @return the new fragment composition
*/
@Override
@Transactional(enabled = false)
public FragmentComposition createFragmentComposition(
long fragmentCompositionId) {
return fragmentCompositionPersistence.create(fragmentCompositionId);
}
/**
* Deletes the fragment composition with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect FragmentCompositionLocalServiceImpl 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 fragmentCompositionId the primary key of the fragment composition
* @return the fragment composition that was removed
* @throws PortalException if a fragment composition with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
@Override
public FragmentComposition deleteFragmentComposition(
long fragmentCompositionId)
throws PortalException {
return fragmentCompositionPersistence.remove(fragmentCompositionId);
}
/**
* Deletes the fragment composition from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect FragmentCompositionLocalServiceImpl 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 fragmentComposition the fragment composition
* @return the fragment composition that was removed
* @throws PortalException
*/
@Indexable(type = IndexableType.DELETE)
@Override
public FragmentComposition deleteFragmentComposition(
FragmentComposition fragmentComposition)
throws PortalException {
return fragmentCompositionPersistence.remove(fragmentComposition);
}
@Override
public T dslQuery(DSLQuery dslQuery) {
return fragmentCompositionPersistence.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(
FragmentComposition.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 fragmentCompositionPersistence.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.fragment.model.impl.FragmentCompositionModelImpl
.
*
*
* @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 fragmentCompositionPersistence.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.fragment.model.impl.FragmentCompositionModelImpl
.
*
*
* @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 fragmentCompositionPersistence.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 fragmentCompositionPersistence.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 fragmentCompositionPersistence.countWithDynamicQuery(
dynamicQuery, projection);
}
@Override
public FragmentComposition fetchFragmentComposition(
long fragmentCompositionId) {
return fragmentCompositionPersistence.fetchByPrimaryKey(
fragmentCompositionId);
}
/**
* Returns the fragment composition matching the UUID and group.
*
* @param uuid the fragment composition's UUID
* @param groupId the primary key of the group
* @return the matching fragment composition, or null
if a matching fragment composition could not be found
*/
@Override
public FragmentComposition fetchFragmentCompositionByUuidAndGroupId(
String uuid, long groupId) {
return fragmentCompositionPersistence.fetchByUUID_G(uuid, groupId);
}
@Override
public FragmentComposition fetchFragmentCompositionByExternalReferenceCode(
String externalReferenceCode, long groupId) {
return fragmentCompositionPersistence.fetchByERC_G(
externalReferenceCode, groupId);
}
@Override
public FragmentComposition getFragmentCompositionByExternalReferenceCode(
String externalReferenceCode, long groupId)
throws PortalException {
return fragmentCompositionPersistence.findByERC_G(
externalReferenceCode, groupId);
}
/**
* Returns the fragment composition with the primary key.
*
* @param fragmentCompositionId the primary key of the fragment composition
* @return the fragment composition
* @throws PortalException if a fragment composition with the primary key could not be found
*/
@Override
public FragmentComposition getFragmentComposition(
long fragmentCompositionId)
throws PortalException {
return fragmentCompositionPersistence.findByPrimaryKey(
fragmentCompositionId);
}
@Override
public ActionableDynamicQuery getActionableDynamicQuery() {
ActionableDynamicQuery actionableDynamicQuery =
new DefaultActionableDynamicQuery();
actionableDynamicQuery.setBaseLocalService(
fragmentCompositionLocalService);
actionableDynamicQuery.setClassLoader(getClassLoader());
actionableDynamicQuery.setModelClass(FragmentComposition.class);
actionableDynamicQuery.setPrimaryKeyPropertyName(
"fragmentCompositionId");
return actionableDynamicQuery;
}
@Override
public IndexableActionableDynamicQuery
getIndexableActionableDynamicQuery() {
IndexableActionableDynamicQuery indexableActionableDynamicQuery =
new IndexableActionableDynamicQuery();
indexableActionableDynamicQuery.setBaseLocalService(
fragmentCompositionLocalService);
indexableActionableDynamicQuery.setClassLoader(getClassLoader());
indexableActionableDynamicQuery.setModelClass(
FragmentComposition.class);
indexableActionableDynamicQuery.setPrimaryKeyPropertyName(
"fragmentCompositionId");
return indexableActionableDynamicQuery;
}
protected void initActionableDynamicQuery(
ActionableDynamicQuery actionableDynamicQuery) {
actionableDynamicQuery.setBaseLocalService(
fragmentCompositionLocalService);
actionableDynamicQuery.setClassLoader(getClassLoader());
actionableDynamicQuery.setModelClass(FragmentComposition.class);
actionableDynamicQuery.setPrimaryKeyPropertyName(
"fragmentCompositionId");
}
@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);
}
Property workflowStatusProperty =
PropertyFactoryUtil.forName("status");
if (portletDataContext.isInitialPublication()) {
dynamicQuery.add(
workflowStatusProperty.ne(
WorkflowConstants.STATUS_IN_TRASH));
}
else {
StagedModelDataHandler> stagedModelDataHandler =
StagedModelDataHandlerRegistryUtil.
getStagedModelDataHandler(
FragmentComposition.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(
FragmentComposition fragmentComposition)
throws PortalException {
StagedModelDataHandlerUtil.exportStagedModel(
portletDataContext, fragmentComposition);
}
});
exportActionableDynamicQuery.setStagedModelType(
new StagedModelType(
PortalUtil.getClassNameId(
FragmentComposition.class.getName())));
return exportActionableDynamicQuery;
}
/**
* @throws PortalException
*/
@Override
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException {
return fragmentCompositionPersistence.create(
((Long)primaryKeyObj).longValue());
}
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException {
if (_log.isWarnEnabled()) {
_log.warn(
"Implement FragmentCompositionLocalServiceImpl#deleteFragmentComposition(FragmentComposition) to avoid orphaned data");
}
return fragmentCompositionLocalService.deleteFragmentComposition(
(FragmentComposition)persistedModel);
}
@Override
public BasePersistence getBasePersistence() {
return fragmentCompositionPersistence;
}
/**
* @throws PortalException
*/
@Override
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException {
return fragmentCompositionPersistence.findByPrimaryKey(primaryKeyObj);
}
/**
* Returns all the fragment compositions matching the UUID and company.
*
* @param uuid the UUID of the fragment compositions
* @param companyId the primary key of the company
* @return the matching fragment compositions, or an empty list if no matches were found
*/
@Override
public List getFragmentCompositionsByUuidAndCompanyId(
String uuid, long companyId) {
return fragmentCompositionPersistence.findByUuid_C(uuid, companyId);
}
/**
* Returns a range of fragment compositions matching the UUID and company.
*
* @param uuid the UUID of the fragment compositions
* @param companyId the primary key of the company
* @param start the lower bound of the range of fragment compositions
* @param end the upper bound of the range of fragment compositions (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null
)
* @return the range of matching fragment compositions, or an empty list if no matches were found
*/
@Override
public List getFragmentCompositionsByUuidAndCompanyId(
String uuid, long companyId, int start, int end,
OrderByComparator orderByComparator) {
return fragmentCompositionPersistence.findByUuid_C(
uuid, companyId, start, end, orderByComparator);
}
/**
* Returns the fragment composition matching the UUID and group.
*
* @param uuid the fragment composition's UUID
* @param groupId the primary key of the group
* @return the matching fragment composition
* @throws PortalException if a matching fragment composition could not be found
*/
@Override
public FragmentComposition getFragmentCompositionByUuidAndGroupId(
String uuid, long groupId)
throws PortalException {
return fragmentCompositionPersistence.findByUUID_G(uuid, groupId);
}
/**
* Returns a range of all the fragment compositions.
*
*
* 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.fragment.model.impl.FragmentCompositionModelImpl
.
*
*
* @param start the lower bound of the range of fragment compositions
* @param end the upper bound of the range of fragment compositions (not inclusive)
* @return the range of fragment compositions
*/
@Override
public List getFragmentCompositions(
int start, int end) {
return fragmentCompositionPersistence.findAll(start, end);
}
/**
* Returns the number of fragment compositions.
*
* @return the number of fragment compositions
*/
@Override
public int getFragmentCompositionsCount() {
return fragmentCompositionPersistence.countAll();
}
/**
* Updates the fragment composition in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect FragmentCompositionLocalServiceImpl 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 fragmentComposition the fragment composition
* @return the fragment composition that was updated
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public FragmentComposition updateFragmentComposition(
FragmentComposition fragmentComposition) {
return fragmentCompositionPersistence.update(fragmentComposition);
}
@Deactivate
protected void deactivate() {
}
@Override
public Class>[] getAopInterfaces() {
return new Class>[] {
FragmentCompositionLocalService.class,
IdentifiableOSGiService.class, CTService.class,
PersistedModelLocalService.class
};
}
@Override
public void setAopProxy(Object aopProxy) {
fragmentCompositionLocalService =
(FragmentCompositionLocalService)aopProxy;
}
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
@Override
public String getOSGiServiceIdentifier() {
return FragmentCompositionLocalService.class.getName();
}
@Override
public CTPersistence getCTPersistence() {
return fragmentCompositionPersistence;
}
@Override
public Class getModelClass() {
return FragmentComposition.class;
}
@Override
public R updateWithUnsafeFunction(
UnsafeFunction, R, E>
updateUnsafeFunction)
throws E {
return updateUnsafeFunction.apply(fragmentCompositionPersistence);
}
protected String getModelClassName() {
return FragmentComposition.class.getName();
}
/**
* Performs a SQL query.
*
* @param sql the sql query
*/
protected void runSQL(String sql) {
try {
DataSource dataSource =
fragmentCompositionPersistence.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 FragmentCompositionLocalService fragmentCompositionLocalService;
@Reference
protected FragmentCompositionPersistence fragmentCompositionPersistence;
@Reference
protected com.liferay.counter.kernel.service.CounterLocalService
counterLocalService;
private static final Log _log = LogFactoryUtil.getLog(
FragmentCompositionLocalServiceBaseImpl.class);
}