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