com.liferay.journal.service.base.JournalArticleLocalServiceBaseImpl 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.journal.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.journal.model.JournalArticle;
import com.liferay.journal.service.JournalArticleLocalService;
import com.liferay.journal.service.JournalArticleLocalServiceUtil;
import com.liferay.journal.service.persistence.JournalArticleFinder;
import com.liferay.journal.service.persistence.JournalArticlePersistence;
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.ProjectionFactoryUtil;
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 journal article 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.journal.service.impl.JournalArticleLocalServiceImpl}.
*
*
* @author Brian Wing Shun Chan
* @see com.liferay.journal.service.impl.JournalArticleLocalServiceImpl
* @generated
*/
public abstract class JournalArticleLocalServiceBaseImpl
extends BaseLocalServiceImpl
implements AopService, IdentifiableOSGiService, JournalArticleLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this class directly. Use JournalArticleLocalService
via injection or a org.osgi.util.tracker.ServiceTracker
or use JournalArticleLocalServiceUtil
.
*/
/**
* Adds the journal article to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect JournalArticleLocalServiceImpl 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 journalArticle the journal article
* @return the journal article that was added
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public JournalArticle addJournalArticle(JournalArticle journalArticle) {
journalArticle.setNew(true);
return journalArticlePersistence.update(journalArticle);
}
/**
* Creates a new journal article with the primary key. Does not add the journal article to the database.
*
* @param id the primary key for the new journal article
* @return the new journal article
*/
@Override
@Transactional(enabled = false)
public JournalArticle createJournalArticle(long id) {
return journalArticlePersistence.create(id);
}
/**
* Deletes the journal article with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect JournalArticleLocalServiceImpl 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 id the primary key of the journal article
* @return the journal article that was removed
* @throws PortalException if a journal article with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
@Override
public JournalArticle deleteJournalArticle(long id) throws PortalException {
return journalArticlePersistence.remove(id);
}
/**
* Deletes the journal article from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect JournalArticleLocalServiceImpl 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 journalArticle the journal article
* @return the journal article that was removed
*/
@Indexable(type = IndexableType.DELETE)
@Override
public JournalArticle deleteJournalArticle(JournalArticle journalArticle) {
return journalArticlePersistence.remove(journalArticle);
}
@Override
public T dslQuery(DSLQuery dslQuery) {
return journalArticlePersistence.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(
JournalArticle.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 journalArticlePersistence.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.journal.model.impl.JournalArticleModelImpl
.
*
*
* @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 journalArticlePersistence.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.journal.model.impl.JournalArticleModelImpl
.
*
*
* @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 journalArticlePersistence.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 journalArticlePersistence.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 journalArticlePersistence.countWithDynamicQuery(
dynamicQuery, projection);
}
@Override
public JournalArticle fetchJournalArticle(long id) {
return journalArticlePersistence.fetchByPrimaryKey(id);
}
/**
* Returns the journal article matching the UUID and group.
*
* @param uuid the journal article's UUID
* @param groupId the primary key of the group
* @return the matching journal article, or null
if a matching journal article could not be found
*/
@Override
public JournalArticle fetchJournalArticleByUuidAndGroupId(
String uuid, long groupId) {
return journalArticlePersistence.fetchByUUID_G(uuid, groupId);
}
/**
* Returns the journal article with the primary key.
*
* @param id the primary key of the journal article
* @return the journal article
* @throws PortalException if a journal article with the primary key could not be found
*/
@Override
public JournalArticle getJournalArticle(long id) throws PortalException {
return journalArticlePersistence.findByPrimaryKey(id);
}
@Override
public ActionableDynamicQuery getActionableDynamicQuery() {
ActionableDynamicQuery actionableDynamicQuery =
new DefaultActionableDynamicQuery();
actionableDynamicQuery.setBaseLocalService(journalArticleLocalService);
actionableDynamicQuery.setClassLoader(getClassLoader());
actionableDynamicQuery.setModelClass(JournalArticle.class);
actionableDynamicQuery.setPrimaryKeyPropertyName("id");
return actionableDynamicQuery;
}
@Override
public IndexableActionableDynamicQuery
getIndexableActionableDynamicQuery() {
IndexableActionableDynamicQuery indexableActionableDynamicQuery =
new IndexableActionableDynamicQuery();
indexableActionableDynamicQuery.setBaseLocalService(
journalArticleLocalService);
indexableActionableDynamicQuery.setClassLoader(getClassLoader());
indexableActionableDynamicQuery.setModelClass(JournalArticle.class);
indexableActionableDynamicQuery.setPrimaryKeyPropertyName("id");
return indexableActionableDynamicQuery;
}
protected void initActionableDynamicQuery(
ActionableDynamicQuery actionableDynamicQuery) {
actionableDynamicQuery.setBaseLocalService(journalArticleLocalService);
actionableDynamicQuery.setClassLoader(getClassLoader());
actionableDynamicQuery.setModelClass(JournalArticle.class);
actionableDynamicQuery.setPrimaryKeyPropertyName("id");
}
@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;
}
@Override
protected Projection getCountProjection() {
return ProjectionFactoryUtil.countDistinct(
"resourcePrimKey");
}
};
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(
JournalArticle.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(JournalArticle journalArticle)
throws PortalException {
StagedModelDataHandlerUtil.exportStagedModel(
portletDataContext, journalArticle);
}
});
exportActionableDynamicQuery.setStagedModelType(
new StagedModelType(
PortalUtil.getClassNameId(JournalArticle.class.getName()),
StagedModelType.REFERRER_CLASS_NAME_ID_ALL));
return exportActionableDynamicQuery;
}
/**
* @throws PortalException
*/
@Override
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException {
return journalArticlePersistence.create(
((Long)primaryKeyObj).longValue());
}
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException {
if (_log.isWarnEnabled()) {
_log.warn(
"Implement JournalArticleLocalServiceImpl#deleteJournalArticle(JournalArticle) to avoid orphaned data");
}
return journalArticleLocalService.deleteJournalArticle(
(JournalArticle)persistedModel);
}
@Override
public BasePersistence getBasePersistence() {
return journalArticlePersistence;
}
/**
* @throws PortalException
*/
@Override
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException {
return journalArticlePersistence.findByPrimaryKey(primaryKeyObj);
}
@Override
public List extends PersistedModel> getPersistedModel(
long resourcePrimKey)
throws PortalException {
return journalArticlePersistence.findByResourcePrimKey(resourcePrimKey);
}
/**
* Returns all the journal articles matching the UUID and company.
*
* @param uuid the UUID of the journal articles
* @param companyId the primary key of the company
* @return the matching journal articles, or an empty list if no matches were found
*/
@Override
public List getJournalArticlesByUuidAndCompanyId(
String uuid, long companyId) {
return journalArticlePersistence.findByUuid_C(uuid, companyId);
}
/**
* Returns a range of journal articles matching the UUID and company.
*
* @param uuid the UUID of the journal articles
* @param companyId the primary key of the company
* @param start the lower bound of the range of journal articles
* @param end the upper bound of the range of journal articles (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null
)
* @return the range of matching journal articles, or an empty list if no matches were found
*/
@Override
public List getJournalArticlesByUuidAndCompanyId(
String uuid, long companyId, int start, int end,
OrderByComparator orderByComparator) {
return journalArticlePersistence.findByUuid_C(
uuid, companyId, start, end, orderByComparator);
}
/**
* Returns the journal article matching the UUID and group.
*
* @param uuid the journal article's UUID
* @param groupId the primary key of the group
* @return the matching journal article
* @throws PortalException if a matching journal article could not be found
*/
@Override
public JournalArticle getJournalArticleByUuidAndGroupId(
String uuid, long groupId)
throws PortalException {
return journalArticlePersistence.findByUUID_G(uuid, groupId);
}
/**
* Returns a range of all the journal articles.
*
*
* 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.journal.model.impl.JournalArticleModelImpl
.
*
*
* @param start the lower bound of the range of journal articles
* @param end the upper bound of the range of journal articles (not inclusive)
* @return the range of journal articles
*/
@Override
public List getJournalArticles(int start, int end) {
return journalArticlePersistence.findAll(start, end);
}
/**
* Returns the number of journal articles.
*
* @return the number of journal articles
*/
@Override
public int getJournalArticlesCount() {
return journalArticlePersistence.countAll();
}
/**
* Updates the journal article in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect JournalArticleLocalServiceImpl 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 journalArticle the journal article
* @return the journal article that was updated
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public JournalArticle updateJournalArticle(JournalArticle journalArticle) {
return journalArticlePersistence.update(journalArticle);
}
@Deactivate
protected void deactivate() {
JournalArticleLocalServiceUtil.setService(null);
}
@Override
public Class>[] getAopInterfaces() {
return new Class>[] {
JournalArticleLocalService.class, IdentifiableOSGiService.class,
CTService.class, PersistedModelLocalService.class
};
}
@Override
public void setAopProxy(Object aopProxy) {
journalArticleLocalService = (JournalArticleLocalService)aopProxy;
JournalArticleLocalServiceUtil.setService(journalArticleLocalService);
}
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
@Override
public String getOSGiServiceIdentifier() {
return JournalArticleLocalService.class.getName();
}
@Override
public CTPersistence getCTPersistence() {
return journalArticlePersistence;
}
@Override
public Class getModelClass() {
return JournalArticle.class;
}
@Override
public R updateWithUnsafeFunction(
UnsafeFunction, R, E>
updateUnsafeFunction)
throws E {
return updateUnsafeFunction.apply(journalArticlePersistence);
}
protected String getModelClassName() {
return JournalArticle.class.getName();
}
/**
* Performs a SQL query.
*
* @param sql the sql query
*/
protected void runSQL(String sql) {
try {
DataSource dataSource = journalArticlePersistence.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 JournalArticleLocalService journalArticleLocalService;
@Reference
protected JournalArticlePersistence journalArticlePersistence;
@Reference
protected JournalArticleFinder journalArticleFinder;
@Reference
protected com.liferay.counter.kernel.service.CounterLocalService
counterLocalService;
private static final Log _log = LogFactoryUtil.getLog(
JournalArticleLocalServiceBaseImpl.class);
}