com.liferay.sharing.service.base.SharingEntryLocalServiceBaseImpl 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.sharing.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.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 com.liferay.sharing.model.SharingEntry;
import com.liferay.sharing.service.SharingEntryLocalService;
import com.liferay.sharing.service.persistence.SharingEntryFinder;
import com.liferay.sharing.service.persistence.SharingEntryPersistence;
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 sharing entry 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.sharing.service.impl.SharingEntryLocalServiceImpl}.
*
*
* @author Brian Wing Shun Chan
* @see com.liferay.sharing.service.impl.SharingEntryLocalServiceImpl
* @generated
*/
public abstract class SharingEntryLocalServiceBaseImpl
extends BaseLocalServiceImpl
implements AopService, IdentifiableOSGiService, SharingEntryLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this class directly. Use SharingEntryLocalService via injection or a org.osgi.util.tracker.ServiceTracker or use com.liferay.sharing.service.SharingEntryLocalServiceUtil.
*/
/**
* Adds the sharing entry to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect SharingEntryLocalServiceImpl 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 sharingEntry the sharing entry
* @return the sharing entry that was added
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public SharingEntry addSharingEntry(SharingEntry sharingEntry) {
sharingEntry.setNew(true);
return sharingEntryPersistence.update(sharingEntry);
}
/**
* Creates a new sharing entry with the primary key. Does not add the sharing entry to the database.
*
* @param sharingEntryId the primary key for the new sharing entry
* @return the new sharing entry
*/
@Override
@Transactional(enabled = false)
public SharingEntry createSharingEntry(long sharingEntryId) {
return sharingEntryPersistence.create(sharingEntryId);
}
/**
* Deletes the sharing entry with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect SharingEntryLocalServiceImpl 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 sharingEntryId the primary key of the sharing entry
* @return the sharing entry that was removed
* @throws PortalException if a sharing entry with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
@Override
public SharingEntry deleteSharingEntry(long sharingEntryId)
throws PortalException {
return sharingEntryPersistence.remove(sharingEntryId);
}
/**
* Deletes the sharing entry from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect SharingEntryLocalServiceImpl 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 sharingEntry the sharing entry
* @return the sharing entry that was removed
*/
@Indexable(type = IndexableType.DELETE)
@Override
public SharingEntry deleteSharingEntry(SharingEntry sharingEntry) {
return sharingEntryPersistence.remove(sharingEntry);
}
@Override
public T dslQuery(DSLQuery dslQuery) {
return sharingEntryPersistence.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(
SharingEntry.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 sharingEntryPersistence.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.sharing.model.impl.SharingEntryModelImpl.
*
*
* @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 sharingEntryPersistence.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.sharing.model.impl.SharingEntryModelImpl.
*
*
* @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 sharingEntryPersistence.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 sharingEntryPersistence.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 sharingEntryPersistence.countWithDynamicQuery(
dynamicQuery, projection);
}
@Override
public SharingEntry fetchSharingEntry(long sharingEntryId) {
return sharingEntryPersistence.fetchByPrimaryKey(sharingEntryId);
}
/**
* Returns the sharing entry matching the UUID and group.
*
* @param uuid the sharing entry's UUID
* @param groupId the primary key of the group
* @return the matching sharing entry, or null if a matching sharing entry could not be found
*/
@Override
public SharingEntry fetchSharingEntryByUuidAndGroupId(
String uuid, long groupId) {
return sharingEntryPersistence.fetchByUUID_G(uuid, groupId);
}
/**
* Returns the sharing entry with the primary key.
*
* @param sharingEntryId the primary key of the sharing entry
* @return the sharing entry
* @throws PortalException if a sharing entry with the primary key could not be found
*/
@Override
public SharingEntry getSharingEntry(long sharingEntryId)
throws PortalException {
return sharingEntryPersistence.findByPrimaryKey(sharingEntryId);
}
@Override
public ActionableDynamicQuery getActionableDynamicQuery() {
ActionableDynamicQuery actionableDynamicQuery =
new DefaultActionableDynamicQuery();
actionableDynamicQuery.setBaseLocalService(sharingEntryLocalService);
actionableDynamicQuery.setClassLoader(getClassLoader());
actionableDynamicQuery.setModelClass(SharingEntry.class);
actionableDynamicQuery.setPrimaryKeyPropertyName("sharingEntryId");
return actionableDynamicQuery;
}
@Override
public IndexableActionableDynamicQuery
getIndexableActionableDynamicQuery() {
IndexableActionableDynamicQuery indexableActionableDynamicQuery =
new IndexableActionableDynamicQuery();
indexableActionableDynamicQuery.setBaseLocalService(
sharingEntryLocalService);
indexableActionableDynamicQuery.setClassLoader(getClassLoader());
indexableActionableDynamicQuery.setModelClass(SharingEntry.class);
indexableActionableDynamicQuery.setPrimaryKeyPropertyName(
"sharingEntryId");
return indexableActionableDynamicQuery;
}
protected void initActionableDynamicQuery(
ActionableDynamicQuery actionableDynamicQuery) {
actionableDynamicQuery.setBaseLocalService(sharingEntryLocalService);
actionableDynamicQuery.setClassLoader(getClassLoader());
actionableDynamicQuery.setModelClass(SharingEntry.class);
actionableDynamicQuery.setPrimaryKeyPropertyName("sharingEntryId");
}
@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(SharingEntry sharingEntry)
throws PortalException {
StagedModelDataHandlerUtil.exportStagedModel(
portletDataContext, sharingEntry);
}
});
exportActionableDynamicQuery.setStagedModelType(
new StagedModelType(
PortalUtil.getClassNameId(SharingEntry.class.getName()),
StagedModelType.REFERRER_CLASS_NAME_ID_ALL));
return exportActionableDynamicQuery;
}
/**
* @throws PortalException
*/
@Override
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException {
return sharingEntryPersistence.create(
((Long)primaryKeyObj).longValue());
}
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException {
if (_log.isWarnEnabled()) {
_log.warn(
"Implement SharingEntryLocalServiceImpl#deleteSharingEntry(SharingEntry) to avoid orphaned data");
}
return sharingEntryLocalService.deleteSharingEntry(
(SharingEntry)persistedModel);
}
@Override
public BasePersistence getBasePersistence() {
return sharingEntryPersistence;
}
/**
* @throws PortalException
*/
@Override
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException {
return sharingEntryPersistence.findByPrimaryKey(primaryKeyObj);
}
/**
* Returns all the sharing entries matching the UUID and company.
*
* @param uuid the UUID of the sharing entries
* @param companyId the primary key of the company
* @return the matching sharing entries, or an empty list if no matches were found
*/
@Override
public List getSharingEntriesByUuidAndCompanyId(
String uuid, long companyId) {
return sharingEntryPersistence.findByUuid_C(uuid, companyId);
}
/**
* Returns a range of sharing entries matching the UUID and company.
*
* @param uuid the UUID of the sharing entries
* @param companyId the primary key of the company
* @param start the lower bound of the range of sharing entries
* @param end the upper bound of the range of sharing entries (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the range of matching sharing entries, or an empty list if no matches were found
*/
@Override
public List getSharingEntriesByUuidAndCompanyId(
String uuid, long companyId, int start, int end,
OrderByComparator orderByComparator) {
return sharingEntryPersistence.findByUuid_C(
uuid, companyId, start, end, orderByComparator);
}
/**
* Returns the sharing entry matching the UUID and group.
*
* @param uuid the sharing entry's UUID
* @param groupId the primary key of the group
* @return the matching sharing entry
* @throws PortalException if a matching sharing entry could not be found
*/
@Override
public SharingEntry getSharingEntryByUuidAndGroupId(
String uuid, long groupId)
throws PortalException {
return sharingEntryPersistence.findByUUID_G(uuid, groupId);
}
/**
* Returns a range of all the sharing entries.
*
*
* 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.sharing.model.impl.SharingEntryModelImpl.
*
*
* @param start the lower bound of the range of sharing entries
* @param end the upper bound of the range of sharing entries (not inclusive)
* @return the range of sharing entries
*/
@Override
public List getSharingEntries(int start, int end) {
return sharingEntryPersistence.findAll(start, end);
}
/**
* Returns the number of sharing entries.
*
* @return the number of sharing entries
*/
@Override
public int getSharingEntriesCount() {
return sharingEntryPersistence.countAll();
}
/**
* Updates the sharing entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect SharingEntryLocalServiceImpl 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 sharingEntry the sharing entry
* @return the sharing entry that was updated
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public SharingEntry updateSharingEntry(SharingEntry sharingEntry) {
return sharingEntryPersistence.update(sharingEntry);
}
@Deactivate
protected void deactivate() {
}
@Override
public Class[] getAopInterfaces() {
return new Class[] {
SharingEntryLocalService.class, IdentifiableOSGiService.class,
PersistedModelLocalService.class
};
}
@Override
public void setAopProxy(Object aopProxy) {
sharingEntryLocalService = (SharingEntryLocalService)aopProxy;
}
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
@Override
public String getOSGiServiceIdentifier() {
return SharingEntryLocalService.class.getName();
}
protected Class getModelClass() {
return SharingEntry.class;
}
protected String getModelClassName() {
return SharingEntry.class.getName();
}
/**
* Performs a SQL query.
*
* @param sql the sql query
*/
protected void runSQL(String sql) {
try {
DataSource dataSource = sharingEntryPersistence.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 SharingEntryLocalService sharingEntryLocalService;
@Reference
protected SharingEntryPersistence sharingEntryPersistence;
@Reference
protected SharingEntryFinder sharingEntryFinder;
@Reference
protected com.liferay.counter.kernel.service.CounterLocalService
counterLocalService;
private static final Log _log = LogFactoryUtil.getLog(
SharingEntryLocalServiceBaseImpl.class);
}