com.liferay.notification.service.base.NotificationTemplateLocalServiceBaseImpl 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.notification.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.notification.model.NotificationTemplate;
import com.liferay.notification.service.NotificationTemplateLocalService;
import com.liferay.notification.service.persistence.NotificationTemplatePersistence;
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 notification template 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.notification.service.impl.NotificationTemplateLocalServiceImpl}.
*
*
* @author Gabriel Albuquerque
* @see com.liferay.notification.service.impl.NotificationTemplateLocalServiceImpl
* @generated
*/
public abstract class NotificationTemplateLocalServiceBaseImpl
extends BaseLocalServiceImpl
implements AopService, IdentifiableOSGiService,
NotificationTemplateLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this class directly. Use NotificationTemplateLocalService via injection or a org.osgi.util.tracker.ServiceTracker or use com.liferay.notification.service.NotificationTemplateLocalServiceUtil.
*/
/**
* Adds the notification template to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect NotificationTemplateLocalServiceImpl 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 notificationTemplate the notification template
* @return the notification template that was added
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public NotificationTemplate addNotificationTemplate(
NotificationTemplate notificationTemplate) {
notificationTemplate.setNew(true);
return notificationTemplatePersistence.update(notificationTemplate);
}
/**
* Creates a new notification template with the primary key. Does not add the notification template to the database.
*
* @param notificationTemplateId the primary key for the new notification template
* @return the new notification template
*/
@Override
@Transactional(enabled = false)
public NotificationTemplate createNotificationTemplate(
long notificationTemplateId) {
return notificationTemplatePersistence.create(notificationTemplateId);
}
/**
* Deletes the notification template with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect NotificationTemplateLocalServiceImpl 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 notificationTemplateId the primary key of the notification template
* @return the notification template that was removed
* @throws PortalException if a notification template with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
@Override
public NotificationTemplate deleteNotificationTemplate(
long notificationTemplateId)
throws PortalException {
return notificationTemplatePersistence.remove(notificationTemplateId);
}
/**
* Deletes the notification template from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect NotificationTemplateLocalServiceImpl 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 notificationTemplate the notification template
* @return the notification template that was removed
* @throws PortalException
*/
@Indexable(type = IndexableType.DELETE)
@Override
public NotificationTemplate deleteNotificationTemplate(
NotificationTemplate notificationTemplate)
throws PortalException {
return notificationTemplatePersistence.remove(notificationTemplate);
}
@Override
public T dslQuery(DSLQuery dslQuery) {
return notificationTemplatePersistence.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(
NotificationTemplate.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 notificationTemplatePersistence.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.notification.model.impl.NotificationTemplateModelImpl.
*
*
* @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 notificationTemplatePersistence.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.notification.model.impl.NotificationTemplateModelImpl.
*
*
* @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 notificationTemplatePersistence.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 notificationTemplatePersistence.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 notificationTemplatePersistence.countWithDynamicQuery(
dynamicQuery, projection);
}
@Override
public NotificationTemplate fetchNotificationTemplate(
long notificationTemplateId) {
return notificationTemplatePersistence.fetchByPrimaryKey(
notificationTemplateId);
}
/**
* Returns the notification template with the matching UUID and company.
*
* @param uuid the notification template's UUID
* @param companyId the primary key of the company
* @return the matching notification template, or null if a matching notification template could not be found
*/
@Override
public NotificationTemplate fetchNotificationTemplateByUuidAndCompanyId(
String uuid, long companyId) {
return notificationTemplatePersistence.fetchByUuid_C_First(
uuid, companyId, null);
}
@Override
public NotificationTemplate
fetchNotificationTemplateByExternalReferenceCode(
String externalReferenceCode, long companyId) {
return notificationTemplatePersistence.fetchByERC_C(
externalReferenceCode, companyId);
}
@Override
public NotificationTemplate getNotificationTemplateByExternalReferenceCode(
String externalReferenceCode, long companyId)
throws PortalException {
return notificationTemplatePersistence.findByERC_C(
externalReferenceCode, companyId);
}
/**
* Returns the notification template with the primary key.
*
* @param notificationTemplateId the primary key of the notification template
* @return the notification template
* @throws PortalException if a notification template with the primary key could not be found
*/
@Override
public NotificationTemplate getNotificationTemplate(
long notificationTemplateId)
throws PortalException {
return notificationTemplatePersistence.findByPrimaryKey(
notificationTemplateId);
}
@Override
public ActionableDynamicQuery getActionableDynamicQuery() {
ActionableDynamicQuery actionableDynamicQuery =
new DefaultActionableDynamicQuery();
actionableDynamicQuery.setBaseLocalService(
notificationTemplateLocalService);
actionableDynamicQuery.setClassLoader(getClassLoader());
actionableDynamicQuery.setModelClass(NotificationTemplate.class);
actionableDynamicQuery.setPrimaryKeyPropertyName(
"notificationTemplateId");
return actionableDynamicQuery;
}
@Override
public IndexableActionableDynamicQuery
getIndexableActionableDynamicQuery() {
IndexableActionableDynamicQuery indexableActionableDynamicQuery =
new IndexableActionableDynamicQuery();
indexableActionableDynamicQuery.setBaseLocalService(
notificationTemplateLocalService);
indexableActionableDynamicQuery.setClassLoader(getClassLoader());
indexableActionableDynamicQuery.setModelClass(
NotificationTemplate.class);
indexableActionableDynamicQuery.setPrimaryKeyPropertyName(
"notificationTemplateId");
return indexableActionableDynamicQuery;
}
protected void initActionableDynamicQuery(
ActionableDynamicQuery actionableDynamicQuery) {
actionableDynamicQuery.setBaseLocalService(
notificationTemplateLocalService);
actionableDynamicQuery.setClassLoader(getClassLoader());
actionableDynamicQuery.setModelClass(NotificationTemplate.class);
actionableDynamicQuery.setPrimaryKeyPropertyName(
"notificationTemplateId");
}
@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(
NotificationTemplate notificationTemplate)
throws PortalException {
StagedModelDataHandlerUtil.exportStagedModel(
portletDataContext, notificationTemplate);
}
});
exportActionableDynamicQuery.setStagedModelType(
new StagedModelType(
PortalUtil.getClassNameId(
NotificationTemplate.class.getName())));
return exportActionableDynamicQuery;
}
/**
* @throws PortalException
*/
@Override
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException {
return notificationTemplatePersistence.create(
((Long)primaryKeyObj).longValue());
}
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException {
if (_log.isWarnEnabled()) {
_log.warn(
"Implement NotificationTemplateLocalServiceImpl#deleteNotificationTemplate(NotificationTemplate) to avoid orphaned data");
}
return notificationTemplateLocalService.deleteNotificationTemplate(
(NotificationTemplate)persistedModel);
}
@Override
public BasePersistence getBasePersistence() {
return notificationTemplatePersistence;
}
/**
* @throws PortalException
*/
@Override
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException {
return notificationTemplatePersistence.findByPrimaryKey(primaryKeyObj);
}
/**
* Returns the notification template with the matching UUID and company.
*
* @param uuid the notification template's UUID
* @param companyId the primary key of the company
* @return the matching notification template
* @throws PortalException if a matching notification template could not be found
*/
@Override
public NotificationTemplate getNotificationTemplateByUuidAndCompanyId(
String uuid, long companyId)
throws PortalException {
return notificationTemplatePersistence.findByUuid_C_First(
uuid, companyId, null);
}
/**
* Returns a range of all the notification templates.
*
*
* 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.notification.model.impl.NotificationTemplateModelImpl.
*
*
* @param start the lower bound of the range of notification templates
* @param end the upper bound of the range of notification templates (not inclusive)
* @return the range of notification templates
*/
@Override
public List getNotificationTemplates(
int start, int end) {
return notificationTemplatePersistence.findAll(start, end);
}
/**
* Returns the number of notification templates.
*
* @return the number of notification templates
*/
@Override
public int getNotificationTemplatesCount() {
return notificationTemplatePersistence.countAll();
}
/**
* Updates the notification template in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect NotificationTemplateLocalServiceImpl 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 notificationTemplate the notification template
* @return the notification template that was updated
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public NotificationTemplate updateNotificationTemplate(
NotificationTemplate notificationTemplate) {
return notificationTemplatePersistence.update(notificationTemplate);
}
@Deactivate
protected void deactivate() {
}
@Override
public Class[] getAopInterfaces() {
return new Class[] {
NotificationTemplateLocalService.class,
IdentifiableOSGiService.class, PersistedModelLocalService.class
};
}
@Override
public void setAopProxy(Object aopProxy) {
notificationTemplateLocalService =
(NotificationTemplateLocalService)aopProxy;
}
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
@Override
public String getOSGiServiceIdentifier() {
return NotificationTemplateLocalService.class.getName();
}
protected Class getModelClass() {
return NotificationTemplate.class;
}
protected String getModelClassName() {
return NotificationTemplate.class.getName();
}
/**
* Performs a SQL query.
*
* @param sql the sql query
*/
protected void runSQL(String sql) {
try {
DataSource dataSource =
notificationTemplatePersistence.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 NotificationTemplateLocalService notificationTemplateLocalService;
@Reference
protected NotificationTemplatePersistence notificationTemplatePersistence;
@Reference
protected com.liferay.counter.kernel.service.CounterLocalService
counterLocalService;
private static final Log _log = LogFactoryUtil.getLog(
NotificationTemplateLocalServiceBaseImpl.class);
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy