
com.liferay.commerce.service.base.CommerceShipmentLocalServiceBaseImpl 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.commerce.service.base;
import com.liferay.commerce.model.CommerceShipment;
import com.liferay.commerce.service.CommerceShipmentLocalService;
import com.liferay.commerce.service.persistence.CommerceShipmentFinder;
import com.liferay.commerce.service.persistence.CommerceShipmentPersistence;
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 commerce shipment 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.commerce.service.impl.CommerceShipmentLocalServiceImpl}.
*
*
* @author Alessio Antonio Rendina
* @see com.liferay.commerce.service.impl.CommerceShipmentLocalServiceImpl
* @generated
*/
public abstract class CommerceShipmentLocalServiceBaseImpl
extends BaseLocalServiceImpl
implements AopService, CommerceShipmentLocalService,
IdentifiableOSGiService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this class directly. Use CommerceShipmentLocalService
via injection or a org.osgi.util.tracker.ServiceTracker
or use com.liferay.commerce.service.CommerceShipmentLocalServiceUtil
.
*/
/**
* Adds the commerce shipment to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect CommerceShipmentLocalServiceImpl 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 commerceShipment the commerce shipment
* @return the commerce shipment that was added
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public CommerceShipment addCommerceShipment(
CommerceShipment commerceShipment) {
commerceShipment.setNew(true);
return commerceShipmentPersistence.update(commerceShipment);
}
/**
* Creates a new commerce shipment with the primary key. Does not add the commerce shipment to the database.
*
* @param commerceShipmentId the primary key for the new commerce shipment
* @return the new commerce shipment
*/
@Override
@Transactional(enabled = false)
public CommerceShipment createCommerceShipment(long commerceShipmentId) {
return commerceShipmentPersistence.create(commerceShipmentId);
}
/**
* Deletes the commerce shipment with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect CommerceShipmentLocalServiceImpl 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 commerceShipmentId the primary key of the commerce shipment
* @return the commerce shipment that was removed
* @throws PortalException if a commerce shipment with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
@Override
public CommerceShipment deleteCommerceShipment(long commerceShipmentId)
throws PortalException {
return commerceShipmentPersistence.remove(commerceShipmentId);
}
/**
* Deletes the commerce shipment from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect CommerceShipmentLocalServiceImpl 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 commerceShipment the commerce shipment
* @return the commerce shipment that was removed
*/
@Indexable(type = IndexableType.DELETE)
@Override
public CommerceShipment deleteCommerceShipment(
CommerceShipment commerceShipment) {
return commerceShipmentPersistence.remove(commerceShipment);
}
@Override
public T dslQuery(DSLQuery dslQuery) {
return commerceShipmentPersistence.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(
CommerceShipment.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 commerceShipmentPersistence.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.commerce.model.impl.CommerceShipmentModelImpl
.
*
*
* @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 commerceShipmentPersistence.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.commerce.model.impl.CommerceShipmentModelImpl
.
*
*
* @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 commerceShipmentPersistence.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 commerceShipmentPersistence.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 commerceShipmentPersistence.countWithDynamicQuery(
dynamicQuery, projection);
}
@Override
public CommerceShipment fetchCommerceShipment(long commerceShipmentId) {
return commerceShipmentPersistence.fetchByPrimaryKey(
commerceShipmentId);
}
/**
* Returns the commerce shipment matching the UUID and group.
*
* @param uuid the commerce shipment's UUID
* @param groupId the primary key of the group
* @return the matching commerce shipment, or null
if a matching commerce shipment could not be found
*/
@Override
public CommerceShipment fetchCommerceShipmentByUuidAndGroupId(
String uuid, long groupId) {
return commerceShipmentPersistence.fetchByUUID_G(uuid, groupId);
}
@Override
public CommerceShipment fetchCommerceShipmentByExternalReferenceCode(
String externalReferenceCode, long companyId) {
return commerceShipmentPersistence.fetchByERC_C(
externalReferenceCode, companyId);
}
@Override
public CommerceShipment getCommerceShipmentByExternalReferenceCode(
String externalReferenceCode, long companyId)
throws PortalException {
return commerceShipmentPersistence.findByERC_C(
externalReferenceCode, companyId);
}
/**
* Returns the commerce shipment with the primary key.
*
* @param commerceShipmentId the primary key of the commerce shipment
* @return the commerce shipment
* @throws PortalException if a commerce shipment with the primary key could not be found
*/
@Override
public CommerceShipment getCommerceShipment(long commerceShipmentId)
throws PortalException {
return commerceShipmentPersistence.findByPrimaryKey(commerceShipmentId);
}
@Override
public ActionableDynamicQuery getActionableDynamicQuery() {
ActionableDynamicQuery actionableDynamicQuery =
new DefaultActionableDynamicQuery();
actionableDynamicQuery.setBaseLocalService(
commerceShipmentLocalService);
actionableDynamicQuery.setClassLoader(getClassLoader());
actionableDynamicQuery.setModelClass(CommerceShipment.class);
actionableDynamicQuery.setPrimaryKeyPropertyName("commerceShipmentId");
return actionableDynamicQuery;
}
@Override
public IndexableActionableDynamicQuery
getIndexableActionableDynamicQuery() {
IndexableActionableDynamicQuery indexableActionableDynamicQuery =
new IndexableActionableDynamicQuery();
indexableActionableDynamicQuery.setBaseLocalService(
commerceShipmentLocalService);
indexableActionableDynamicQuery.setClassLoader(getClassLoader());
indexableActionableDynamicQuery.setModelClass(CommerceShipment.class);
indexableActionableDynamicQuery.setPrimaryKeyPropertyName(
"commerceShipmentId");
return indexableActionableDynamicQuery;
}
protected void initActionableDynamicQuery(
ActionableDynamicQuery actionableDynamicQuery) {
actionableDynamicQuery.setBaseLocalService(
commerceShipmentLocalService);
actionableDynamicQuery.setClassLoader(getClassLoader());
actionableDynamicQuery.setModelClass(CommerceShipment.class);
actionableDynamicQuery.setPrimaryKeyPropertyName("commerceShipmentId");
}
@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(CommerceShipment commerceShipment)
throws PortalException {
StagedModelDataHandlerUtil.exportStagedModel(
portletDataContext, commerceShipment);
}
});
exportActionableDynamicQuery.setStagedModelType(
new StagedModelType(
PortalUtil.getClassNameId(CommerceShipment.class.getName())));
return exportActionableDynamicQuery;
}
/**
* @throws PortalException
*/
@Override
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException {
return commerceShipmentPersistence.create(
((Long)primaryKeyObj).longValue());
}
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException {
if (_log.isWarnEnabled()) {
_log.warn(
"Implement CommerceShipmentLocalServiceImpl#deleteCommerceShipment(CommerceShipment) to avoid orphaned data");
}
return commerceShipmentLocalService.deleteCommerceShipment(
(CommerceShipment)persistedModel);
}
@Override
public BasePersistence getBasePersistence() {
return commerceShipmentPersistence;
}
/**
* @throws PortalException
*/
@Override
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException {
return commerceShipmentPersistence.findByPrimaryKey(primaryKeyObj);
}
/**
* Returns all the commerce shipments matching the UUID and company.
*
* @param uuid the UUID of the commerce shipments
* @param companyId the primary key of the company
* @return the matching commerce shipments, or an empty list if no matches were found
*/
@Override
public List getCommerceShipmentsByUuidAndCompanyId(
String uuid, long companyId) {
return commerceShipmentPersistence.findByUuid_C(uuid, companyId);
}
/**
* Returns a range of commerce shipments matching the UUID and company.
*
* @param uuid the UUID of the commerce shipments
* @param companyId the primary key of the company
* @param start the lower bound of the range of commerce shipments
* @param end the upper bound of the range of commerce shipments (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null
)
* @return the range of matching commerce shipments, or an empty list if no matches were found
*/
@Override
public List getCommerceShipmentsByUuidAndCompanyId(
String uuid, long companyId, int start, int end,
OrderByComparator orderByComparator) {
return commerceShipmentPersistence.findByUuid_C(
uuid, companyId, start, end, orderByComparator);
}
/**
* Returns the commerce shipment matching the UUID and group.
*
* @param uuid the commerce shipment's UUID
* @param groupId the primary key of the group
* @return the matching commerce shipment
* @throws PortalException if a matching commerce shipment could not be found
*/
@Override
public CommerceShipment getCommerceShipmentByUuidAndGroupId(
String uuid, long groupId)
throws PortalException {
return commerceShipmentPersistence.findByUUID_G(uuid, groupId);
}
/**
* Returns a range of all the commerce shipments.
*
*
* 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.commerce.model.impl.CommerceShipmentModelImpl
.
*
*
* @param start the lower bound of the range of commerce shipments
* @param end the upper bound of the range of commerce shipments (not inclusive)
* @return the range of commerce shipments
*/
@Override
public List getCommerceShipments(int start, int end) {
return commerceShipmentPersistence.findAll(start, end);
}
/**
* Returns the number of commerce shipments.
*
* @return the number of commerce shipments
*/
@Override
public int getCommerceShipmentsCount() {
return commerceShipmentPersistence.countAll();
}
/**
* Updates the commerce shipment in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect CommerceShipmentLocalServiceImpl 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 commerceShipment the commerce shipment
* @return the commerce shipment that was updated
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public CommerceShipment updateCommerceShipment(
CommerceShipment commerceShipment) {
return commerceShipmentPersistence.update(commerceShipment);
}
@Deactivate
protected void deactivate() {
}
@Override
public Class>[] getAopInterfaces() {
return new Class>[] {
CommerceShipmentLocalService.class, IdentifiableOSGiService.class,
PersistedModelLocalService.class
};
}
@Override
public void setAopProxy(Object aopProxy) {
commerceShipmentLocalService = (CommerceShipmentLocalService)aopProxy;
}
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
@Override
public String getOSGiServiceIdentifier() {
return CommerceShipmentLocalService.class.getName();
}
protected Class> getModelClass() {
return CommerceShipment.class;
}
protected String getModelClassName() {
return CommerceShipment.class.getName();
}
/**
* Performs a SQL query.
*
* @param sql the sql query
*/
protected void runSQL(String sql) {
try {
DataSource dataSource = commerceShipmentPersistence.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 CommerceShipmentLocalService commerceShipmentLocalService;
@Reference
protected CommerceShipmentPersistence commerceShipmentPersistence;
@Reference
protected CommerceShipmentFinder commerceShipmentFinder;
@Reference
protected com.liferay.counter.kernel.service.CounterLocalService
counterLocalService;
private static final Log _log = LogFactoryUtil.getLog(
CommerceShipmentLocalServiceBaseImpl.class);
}