com.liferay.dispatch.service.base.DispatchTriggerLocalServiceBaseImpl 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.dispatch.service.base;
import com.liferay.dispatch.model.DispatchTrigger;
import com.liferay.dispatch.service.DispatchTriggerLocalService;
import com.liferay.dispatch.service.DispatchTriggerLocalServiceUtil;
import com.liferay.dispatch.service.persistence.DispatchTriggerPersistence;
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.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 dispatch trigger 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.dispatch.service.impl.DispatchTriggerLocalServiceImpl}.
*
*
* @author Matija Petanjek
* @see com.liferay.dispatch.service.impl.DispatchTriggerLocalServiceImpl
* @generated
*/
public abstract class DispatchTriggerLocalServiceBaseImpl
extends BaseLocalServiceImpl
implements AopService, DispatchTriggerLocalService,
IdentifiableOSGiService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this class directly. Use DispatchTriggerLocalService
via injection or a org.osgi.util.tracker.ServiceTracker
or use DispatchTriggerLocalServiceUtil
.
*/
/**
* Adds the dispatch trigger to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect DispatchTriggerLocalServiceImpl 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 dispatchTrigger the dispatch trigger
* @return the dispatch trigger that was added
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public DispatchTrigger addDispatchTrigger(DispatchTrigger dispatchTrigger) {
dispatchTrigger.setNew(true);
return dispatchTriggerPersistence.update(dispatchTrigger);
}
/**
* Creates a new dispatch trigger with the primary key. Does not add the dispatch trigger to the database.
*
* @param dispatchTriggerId the primary key for the new dispatch trigger
* @return the new dispatch trigger
*/
@Override
@Transactional(enabled = false)
public DispatchTrigger createDispatchTrigger(long dispatchTriggerId) {
return dispatchTriggerPersistence.create(dispatchTriggerId);
}
/**
* Deletes the dispatch trigger with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect DispatchTriggerLocalServiceImpl 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 dispatchTriggerId the primary key of the dispatch trigger
* @return the dispatch trigger that was removed
* @throws PortalException if a dispatch trigger with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
@Override
public DispatchTrigger deleteDispatchTrigger(long dispatchTriggerId)
throws PortalException {
return dispatchTriggerPersistence.remove(dispatchTriggerId);
}
/**
* Deletes the dispatch trigger from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect DispatchTriggerLocalServiceImpl 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 dispatchTrigger the dispatch trigger
* @return the dispatch trigger that was removed
* @throws PortalException
*/
@Indexable(type = IndexableType.DELETE)
@Override
public DispatchTrigger deleteDispatchTrigger(
DispatchTrigger dispatchTrigger)
throws PortalException {
return dispatchTriggerPersistence.remove(dispatchTrigger);
}
@Override
public T dslQuery(DSLQuery dslQuery) {
return dispatchTriggerPersistence.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(
DispatchTrigger.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 dispatchTriggerPersistence.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.dispatch.model.impl.DispatchTriggerModelImpl
.
*
*
* @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 dispatchTriggerPersistence.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.dispatch.model.impl.DispatchTriggerModelImpl
.
*
*
* @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 dispatchTriggerPersistence.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 dispatchTriggerPersistence.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 dispatchTriggerPersistence.countWithDynamicQuery(
dynamicQuery, projection);
}
@Override
public DispatchTrigger fetchDispatchTrigger(long dispatchTriggerId) {
return dispatchTriggerPersistence.fetchByPrimaryKey(dispatchTriggerId);
}
/**
* Returns the dispatch trigger with the matching UUID and company.
*
* @param uuid the dispatch trigger's UUID
* @param companyId the primary key of the company
* @return the matching dispatch trigger, or null
if a matching dispatch trigger could not be found
*/
@Override
public DispatchTrigger fetchDispatchTriggerByUuidAndCompanyId(
String uuid, long companyId) {
return dispatchTriggerPersistence.fetchByUuid_C_First(
uuid, companyId, null);
}
@Override
public DispatchTrigger fetchDispatchTriggerByExternalReferenceCode(
String externalReferenceCode, long companyId) {
return dispatchTriggerPersistence.fetchByERC_C(
externalReferenceCode, companyId);
}
@Override
public DispatchTrigger getDispatchTriggerByExternalReferenceCode(
String externalReferenceCode, long companyId)
throws PortalException {
return dispatchTriggerPersistence.findByERC_C(
externalReferenceCode, companyId);
}
/**
* Returns the dispatch trigger with the primary key.
*
* @param dispatchTriggerId the primary key of the dispatch trigger
* @return the dispatch trigger
* @throws PortalException if a dispatch trigger with the primary key could not be found
*/
@Override
public DispatchTrigger getDispatchTrigger(long dispatchTriggerId)
throws PortalException {
return dispatchTriggerPersistence.findByPrimaryKey(dispatchTriggerId);
}
@Override
public ActionableDynamicQuery getActionableDynamicQuery() {
ActionableDynamicQuery actionableDynamicQuery =
new DefaultActionableDynamicQuery();
actionableDynamicQuery.setBaseLocalService(dispatchTriggerLocalService);
actionableDynamicQuery.setClassLoader(getClassLoader());
actionableDynamicQuery.setModelClass(DispatchTrigger.class);
actionableDynamicQuery.setPrimaryKeyPropertyName("dispatchTriggerId");
return actionableDynamicQuery;
}
@Override
public IndexableActionableDynamicQuery
getIndexableActionableDynamicQuery() {
IndexableActionableDynamicQuery indexableActionableDynamicQuery =
new IndexableActionableDynamicQuery();
indexableActionableDynamicQuery.setBaseLocalService(
dispatchTriggerLocalService);
indexableActionableDynamicQuery.setClassLoader(getClassLoader());
indexableActionableDynamicQuery.setModelClass(DispatchTrigger.class);
indexableActionableDynamicQuery.setPrimaryKeyPropertyName(
"dispatchTriggerId");
return indexableActionableDynamicQuery;
}
protected void initActionableDynamicQuery(
ActionableDynamicQuery actionableDynamicQuery) {
actionableDynamicQuery.setBaseLocalService(dispatchTriggerLocalService);
actionableDynamicQuery.setClassLoader(getClassLoader());
actionableDynamicQuery.setModelClass(DispatchTrigger.class);
actionableDynamicQuery.setPrimaryKeyPropertyName("dispatchTriggerId");
}
@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(DispatchTrigger dispatchTrigger)
throws PortalException {
StagedModelDataHandlerUtil.exportStagedModel(
portletDataContext, dispatchTrigger);
}
});
exportActionableDynamicQuery.setStagedModelType(
new StagedModelType(
PortalUtil.getClassNameId(DispatchTrigger.class.getName())));
return exportActionableDynamicQuery;
}
/**
* @throws PortalException
*/
@Override
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException {
return dispatchTriggerPersistence.create(
((Long)primaryKeyObj).longValue());
}
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException {
if (_log.isWarnEnabled()) {
_log.warn(
"Implement DispatchTriggerLocalServiceImpl#deleteDispatchTrigger(DispatchTrigger) to avoid orphaned data");
}
return dispatchTriggerLocalService.deleteDispatchTrigger(
(DispatchTrigger)persistedModel);
}
@Override
public BasePersistence getBasePersistence() {
return dispatchTriggerPersistence;
}
/**
* @throws PortalException
*/
@Override
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException {
return dispatchTriggerPersistence.findByPrimaryKey(primaryKeyObj);
}
/**
* Returns the dispatch trigger with the matching UUID and company.
*
* @param uuid the dispatch trigger's UUID
* @param companyId the primary key of the company
* @return the matching dispatch trigger
* @throws PortalException if a matching dispatch trigger could not be found
*/
@Override
public DispatchTrigger getDispatchTriggerByUuidAndCompanyId(
String uuid, long companyId)
throws PortalException {
return dispatchTriggerPersistence.findByUuid_C_First(
uuid, companyId, null);
}
/**
* Returns a range of all the dispatch triggers.
*
*
* 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.dispatch.model.impl.DispatchTriggerModelImpl
.
*
*
* @param start the lower bound of the range of dispatch triggers
* @param end the upper bound of the range of dispatch triggers (not inclusive)
* @return the range of dispatch triggers
*/
@Override
public List getDispatchTriggers(int start, int end) {
return dispatchTriggerPersistence.findAll(start, end);
}
/**
* Returns the number of dispatch triggers.
*
* @return the number of dispatch triggers
*/
@Override
public int getDispatchTriggersCount() {
return dispatchTriggerPersistence.countAll();
}
/**
* Updates the dispatch trigger in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect DispatchTriggerLocalServiceImpl 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 dispatchTrigger the dispatch trigger
* @return the dispatch trigger that was updated
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public DispatchTrigger updateDispatchTrigger(
DispatchTrigger dispatchTrigger) {
return dispatchTriggerPersistence.update(dispatchTrigger);
}
@Deactivate
protected void deactivate() {
DispatchTriggerLocalServiceUtil.setService(null);
}
@Override
public Class>[] getAopInterfaces() {
return new Class>[] {
DispatchTriggerLocalService.class, IdentifiableOSGiService.class,
PersistedModelLocalService.class
};
}
@Override
public void setAopProxy(Object aopProxy) {
dispatchTriggerLocalService = (DispatchTriggerLocalService)aopProxy;
DispatchTriggerLocalServiceUtil.setService(dispatchTriggerLocalService);
}
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
@Override
public String getOSGiServiceIdentifier() {
return DispatchTriggerLocalService.class.getName();
}
protected Class> getModelClass() {
return DispatchTrigger.class;
}
protected String getModelClassName() {
return DispatchTrigger.class.getName();
}
/**
* Performs a SQL query.
*
* @param sql the sql query
*/
protected void runSQL(String sql) {
try {
DataSource dataSource = dispatchTriggerPersistence.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 DispatchTriggerLocalService dispatchTriggerLocalService;
@Reference
protected DispatchTriggerPersistence dispatchTriggerPersistence;
@Reference
protected com.liferay.counter.kernel.service.CounterLocalService
counterLocalService;
private static final Log _log = LogFactoryUtil.getLog(
DispatchTriggerLocalServiceBaseImpl.class);
}