
com.liferay.notification.service.base.NotificationRecipientLocalServiceBaseImpl 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.NotificationRecipient;
import com.liferay.notification.service.NotificationRecipientLocalService;
import com.liferay.notification.service.persistence.NotificationRecipientPersistence;
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.dao.orm.Property;
import com.liferay.portal.kernel.dao.orm.PropertyFactoryUtil;
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 recipient 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.NotificationRecipientLocalServiceImpl}.
*
*
* @author Gabriel Albuquerque
* @see com.liferay.notification.service.impl.NotificationRecipientLocalServiceImpl
* @generated
*/
public abstract class NotificationRecipientLocalServiceBaseImpl
extends BaseLocalServiceImpl
implements AopService, IdentifiableOSGiService,
NotificationRecipientLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this class directly. Use NotificationRecipientLocalService
via injection or a org.osgi.util.tracker.ServiceTracker
or use com.liferay.notification.service.NotificationRecipientLocalServiceUtil
.
*/
/**
* Adds the notification recipient to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect NotificationRecipientLocalServiceImpl 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 notificationRecipient the notification recipient
* @return the notification recipient that was added
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public NotificationRecipient addNotificationRecipient(
NotificationRecipient notificationRecipient) {
notificationRecipient.setNew(true);
return notificationRecipientPersistence.update(notificationRecipient);
}
/**
* Creates a new notification recipient with the primary key. Does not add the notification recipient to the database.
*
* @param notificationRecipientId the primary key for the new notification recipient
* @return the new notification recipient
*/
@Override
@Transactional(enabled = false)
public NotificationRecipient createNotificationRecipient(
long notificationRecipientId) {
return notificationRecipientPersistence.create(notificationRecipientId);
}
/**
* Deletes the notification recipient with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect NotificationRecipientLocalServiceImpl 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 notificationRecipientId the primary key of the notification recipient
* @return the notification recipient that was removed
* @throws PortalException if a notification recipient with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
@Override
public NotificationRecipient deleteNotificationRecipient(
long notificationRecipientId)
throws PortalException {
return notificationRecipientPersistence.remove(notificationRecipientId);
}
/**
* Deletes the notification recipient from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect NotificationRecipientLocalServiceImpl 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 notificationRecipient the notification recipient
* @return the notification recipient that was removed
*/
@Indexable(type = IndexableType.DELETE)
@Override
public NotificationRecipient deleteNotificationRecipient(
NotificationRecipient notificationRecipient) {
return notificationRecipientPersistence.remove(notificationRecipient);
}
@Override
public T dslQuery(DSLQuery dslQuery) {
return notificationRecipientPersistence.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(
NotificationRecipient.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 notificationRecipientPersistence.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.NotificationRecipientModelImpl
.
*
*
* @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 notificationRecipientPersistence.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.NotificationRecipientModelImpl
.
*
*
* @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 notificationRecipientPersistence.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 notificationRecipientPersistence.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 notificationRecipientPersistence.countWithDynamicQuery(
dynamicQuery, projection);
}
@Override
public NotificationRecipient fetchNotificationRecipient(
long notificationRecipientId) {
return notificationRecipientPersistence.fetchByPrimaryKey(
notificationRecipientId);
}
/**
* Returns the notification recipient with the matching UUID and company.
*
* @param uuid the notification recipient's UUID
* @param companyId the primary key of the company
* @return the matching notification recipient, or null
if a matching notification recipient could not be found
*/
@Override
public NotificationRecipient fetchNotificationRecipientByUuidAndCompanyId(
String uuid, long companyId) {
return notificationRecipientPersistence.fetchByUuid_C_First(
uuid, companyId, null);
}
/**
* Returns the notification recipient with the primary key.
*
* @param notificationRecipientId the primary key of the notification recipient
* @return the notification recipient
* @throws PortalException if a notification recipient with the primary key could not be found
*/
@Override
public NotificationRecipient getNotificationRecipient(
long notificationRecipientId)
throws PortalException {
return notificationRecipientPersistence.findByPrimaryKey(
notificationRecipientId);
}
@Override
public ActionableDynamicQuery getActionableDynamicQuery() {
ActionableDynamicQuery actionableDynamicQuery =
new DefaultActionableDynamicQuery();
actionableDynamicQuery.setBaseLocalService(
notificationRecipientLocalService);
actionableDynamicQuery.setClassLoader(getClassLoader());
actionableDynamicQuery.setModelClass(NotificationRecipient.class);
actionableDynamicQuery.setPrimaryKeyPropertyName(
"notificationRecipientId");
return actionableDynamicQuery;
}
@Override
public IndexableActionableDynamicQuery
getIndexableActionableDynamicQuery() {
IndexableActionableDynamicQuery indexableActionableDynamicQuery =
new IndexableActionableDynamicQuery();
indexableActionableDynamicQuery.setBaseLocalService(
notificationRecipientLocalService);
indexableActionableDynamicQuery.setClassLoader(getClassLoader());
indexableActionableDynamicQuery.setModelClass(
NotificationRecipient.class);
indexableActionableDynamicQuery.setPrimaryKeyPropertyName(
"notificationRecipientId");
return indexableActionableDynamicQuery;
}
protected void initActionableDynamicQuery(
ActionableDynamicQuery actionableDynamicQuery) {
actionableDynamicQuery.setBaseLocalService(
notificationRecipientLocalService);
actionableDynamicQuery.setClassLoader(getClassLoader());
actionableDynamicQuery.setModelClass(NotificationRecipient.class);
actionableDynamicQuery.setPrimaryKeyPropertyName(
"notificationRecipientId");
}
@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");
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());
}
}
});
exportActionableDynamicQuery.setCompanyId(
portletDataContext.getCompanyId());
exportActionableDynamicQuery.setPerformActionMethod(
new ActionableDynamicQuery.PerformActionMethod
() {
@Override
public void performAction(
NotificationRecipient notificationRecipient)
throws PortalException {
StagedModelDataHandlerUtil.exportStagedModel(
portletDataContext, notificationRecipient);
}
});
exportActionableDynamicQuery.setStagedModelType(
new StagedModelType(
PortalUtil.getClassNameId(
NotificationRecipient.class.getName()),
StagedModelType.REFERRER_CLASS_NAME_ID_ALL));
return exportActionableDynamicQuery;
}
/**
* @throws PortalException
*/
@Override
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException {
return notificationRecipientPersistence.create(
((Long)primaryKeyObj).longValue());
}
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException {
if (_log.isWarnEnabled()) {
_log.warn(
"Implement NotificationRecipientLocalServiceImpl#deleteNotificationRecipient(NotificationRecipient) to avoid orphaned data");
}
return notificationRecipientLocalService.deleteNotificationRecipient(
(NotificationRecipient)persistedModel);
}
@Override
public BasePersistence getBasePersistence() {
return notificationRecipientPersistence;
}
/**
* @throws PortalException
*/
@Override
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException {
return notificationRecipientPersistence.findByPrimaryKey(primaryKeyObj);
}
/**
* Returns the notification recipient with the matching UUID and company.
*
* @param uuid the notification recipient's UUID
* @param companyId the primary key of the company
* @return the matching notification recipient
* @throws PortalException if a matching notification recipient could not be found
*/
@Override
public NotificationRecipient getNotificationRecipientByUuidAndCompanyId(
String uuid, long companyId)
throws PortalException {
return notificationRecipientPersistence.findByUuid_C_First(
uuid, companyId, null);
}
/**
* Returns a range of all the notification recipients.
*
*
* 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.NotificationRecipientModelImpl
.
*
*
* @param start the lower bound of the range of notification recipients
* @param end the upper bound of the range of notification recipients (not inclusive)
* @return the range of notification recipients
*/
@Override
public List getNotificationRecipients(
int start, int end) {
return notificationRecipientPersistence.findAll(start, end);
}
/**
* Returns the number of notification recipients.
*
* @return the number of notification recipients
*/
@Override
public int getNotificationRecipientsCount() {
return notificationRecipientPersistence.countAll();
}
/**
* Updates the notification recipient in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect NotificationRecipientLocalServiceImpl 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 notificationRecipient the notification recipient
* @return the notification recipient that was updated
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public NotificationRecipient updateNotificationRecipient(
NotificationRecipient notificationRecipient) {
return notificationRecipientPersistence.update(notificationRecipient);
}
@Deactivate
protected void deactivate() {
}
@Override
public Class>[] getAopInterfaces() {
return new Class>[] {
NotificationRecipientLocalService.class,
IdentifiableOSGiService.class, PersistedModelLocalService.class
};
}
@Override
public void setAopProxy(Object aopProxy) {
notificationRecipientLocalService =
(NotificationRecipientLocalService)aopProxy;
}
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
@Override
public String getOSGiServiceIdentifier() {
return NotificationRecipientLocalService.class.getName();
}
protected Class> getModelClass() {
return NotificationRecipient.class;
}
protected String getModelClassName() {
return NotificationRecipient.class.getName();
}
/**
* Performs a SQL query.
*
* @param sql the sql query
*/
protected void runSQL(String sql) {
try {
DataSource dataSource =
notificationRecipientPersistence.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 NotificationRecipientLocalService
notificationRecipientLocalService;
@Reference
protected NotificationRecipientPersistence notificationRecipientPersistence;
@Reference
protected com.liferay.counter.kernel.service.CounterLocalService
counterLocalService;
private static final Log _log = LogFactoryUtil.getLog(
NotificationRecipientLocalServiceBaseImpl.class);
}