com.liferay.bookmarks.service.base.BookmarksEntryLocalServiceBaseImpl 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.bookmarks.service.base;
import com.liferay.bookmarks.model.BookmarksEntry;
import com.liferay.bookmarks.service.BookmarksEntryLocalService;
import com.liferay.bookmarks.service.persistence.BookmarksEntryPersistence;
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.StagedModelDataHandler;
import com.liferay.exportimport.kernel.lar.StagedModelDataHandlerRegistryUtil;
import com.liferay.exportimport.kernel.lar.StagedModelDataHandlerUtil;
import com.liferay.exportimport.kernel.lar.StagedModelType;
import com.liferay.petra.function.UnsafeFunction;
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.Conjunction;
import com.liferay.portal.kernel.dao.orm.Criterion;
import com.liferay.portal.kernel.dao.orm.DefaultActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.Disjunction;
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.dao.orm.RestrictionsFactoryUtil;
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.change.tracking.CTService;
import com.liferay.portal.kernel.service.persistence.BasePersistence;
import com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence;
import com.liferay.portal.kernel.transaction.Transactional;
import com.liferay.portal.kernel.util.OrderByComparator;
import com.liferay.portal.kernel.util.PortalUtil;
import com.liferay.portal.kernel.workflow.WorkflowConstants;
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 bookmarks 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.bookmarks.service.impl.BookmarksEntryLocalServiceImpl}.
*
*
* @author Brian Wing Shun Chan
* @see com.liferay.bookmarks.service.impl.BookmarksEntryLocalServiceImpl
* @generated
*/
public abstract class BookmarksEntryLocalServiceBaseImpl
extends BaseLocalServiceImpl
implements AopService, BookmarksEntryLocalService, IdentifiableOSGiService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this class directly. Use BookmarksEntryLocalService via injection or a org.osgi.util.tracker.ServiceTracker or use com.liferay.bookmarks.service.BookmarksEntryLocalServiceUtil.
*/
/**
* Adds the bookmarks entry to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect BookmarksEntryLocalServiceImpl 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 bookmarksEntry the bookmarks entry
* @return the bookmarks entry that was added
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public BookmarksEntry addBookmarksEntry(BookmarksEntry bookmarksEntry) {
bookmarksEntry.setNew(true);
return bookmarksEntryPersistence.update(bookmarksEntry);
}
/**
* Creates a new bookmarks entry with the primary key. Does not add the bookmarks entry to the database.
*
* @param entryId the primary key for the new bookmarks entry
* @return the new bookmarks entry
*/
@Override
@Transactional(enabled = false)
public BookmarksEntry createBookmarksEntry(long entryId) {
return bookmarksEntryPersistence.create(entryId);
}
/**
* Deletes the bookmarks entry with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect BookmarksEntryLocalServiceImpl 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 entryId the primary key of the bookmarks entry
* @return the bookmarks entry that was removed
* @throws PortalException if a bookmarks entry with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
@Override
public BookmarksEntry deleteBookmarksEntry(long entryId)
throws PortalException {
return bookmarksEntryPersistence.remove(entryId);
}
/**
* Deletes the bookmarks entry from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect BookmarksEntryLocalServiceImpl 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 bookmarksEntry the bookmarks entry
* @return the bookmarks entry that was removed
*/
@Indexable(type = IndexableType.DELETE)
@Override
public BookmarksEntry deleteBookmarksEntry(BookmarksEntry bookmarksEntry) {
return bookmarksEntryPersistence.remove(bookmarksEntry);
}
@Override
public T dslQuery(DSLQuery dslQuery) {
return bookmarksEntryPersistence.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(
BookmarksEntry.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 bookmarksEntryPersistence.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.bookmarks.model.impl.BookmarksEntryModelImpl.
*
*
* @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 bookmarksEntryPersistence.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.bookmarks.model.impl.BookmarksEntryModelImpl.
*
*
* @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 bookmarksEntryPersistence.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 bookmarksEntryPersistence.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 bookmarksEntryPersistence.countWithDynamicQuery(
dynamicQuery, projection);
}
@Override
public BookmarksEntry fetchBookmarksEntry(long entryId) {
return bookmarksEntryPersistence.fetchByPrimaryKey(entryId);
}
/**
* Returns the bookmarks entry matching the UUID and group.
*
* @param uuid the bookmarks entry's UUID
* @param groupId the primary key of the group
* @return the matching bookmarks entry, or null if a matching bookmarks entry could not be found
*/
@Override
public BookmarksEntry fetchBookmarksEntryByUuidAndGroupId(
String uuid, long groupId) {
return bookmarksEntryPersistence.fetchByUUID_G(uuid, groupId);
}
/**
* Returns the bookmarks entry with the primary key.
*
* @param entryId the primary key of the bookmarks entry
* @return the bookmarks entry
* @throws PortalException if a bookmarks entry with the primary key could not be found
*/
@Override
public BookmarksEntry getBookmarksEntry(long entryId)
throws PortalException {
return bookmarksEntryPersistence.findByPrimaryKey(entryId);
}
@Override
public ActionableDynamicQuery getActionableDynamicQuery() {
ActionableDynamicQuery actionableDynamicQuery =
new DefaultActionableDynamicQuery();
actionableDynamicQuery.setBaseLocalService(bookmarksEntryLocalService);
actionableDynamicQuery.setClassLoader(getClassLoader());
actionableDynamicQuery.setModelClass(BookmarksEntry.class);
actionableDynamicQuery.setPrimaryKeyPropertyName("entryId");
return actionableDynamicQuery;
}
@Override
public IndexableActionableDynamicQuery
getIndexableActionableDynamicQuery() {
IndexableActionableDynamicQuery indexableActionableDynamicQuery =
new IndexableActionableDynamicQuery();
indexableActionableDynamicQuery.setBaseLocalService(
bookmarksEntryLocalService);
indexableActionableDynamicQuery.setClassLoader(getClassLoader());
indexableActionableDynamicQuery.setModelClass(BookmarksEntry.class);
indexableActionableDynamicQuery.setPrimaryKeyPropertyName("entryId");
return indexableActionableDynamicQuery;
}
protected void initActionableDynamicQuery(
ActionableDynamicQuery actionableDynamicQuery) {
actionableDynamicQuery.setBaseLocalService(bookmarksEntryLocalService);
actionableDynamicQuery.setClassLoader(getClassLoader());
actionableDynamicQuery.setModelClass(BookmarksEntry.class);
actionableDynamicQuery.setPrimaryKeyPropertyName("entryId");
}
@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) {
Criterion modifiedDateCriterion =
portletDataContext.getDateRangeCriteria("modifiedDate");
if (modifiedDateCriterion != null) {
Conjunction conjunction =
RestrictionsFactoryUtil.conjunction();
conjunction.add(modifiedDateCriterion);
Disjunction disjunction =
RestrictionsFactoryUtil.disjunction();
disjunction.add(
RestrictionsFactoryUtil.gtProperty(
"modifiedDate", "lastPublishDate"));
Property lastPublishDateProperty =
PropertyFactoryUtil.forName("lastPublishDate");
disjunction.add(lastPublishDateProperty.isNull());
conjunction.add(disjunction);
modifiedDateCriterion = conjunction;
}
Criterion statusDateCriterion =
portletDataContext.getDateRangeCriteria("statusDate");
if ((modifiedDateCriterion != null) &&
(statusDateCriterion != null)) {
Disjunction disjunction =
RestrictionsFactoryUtil.disjunction();
disjunction.add(modifiedDateCriterion);
disjunction.add(statusDateCriterion);
dynamicQuery.add(disjunction);
}
Property workflowStatusProperty =
PropertyFactoryUtil.forName("status");
if (portletDataContext.isInitialPublication()) {
dynamicQuery.add(
workflowStatusProperty.ne(
WorkflowConstants.STATUS_IN_TRASH));
}
else {
StagedModelDataHandler stagedModelDataHandler =
StagedModelDataHandlerRegistryUtil.
getStagedModelDataHandler(
BookmarksEntry.class.getName());
dynamicQuery.add(
workflowStatusProperty.in(
stagedModelDataHandler.
getExportableStatuses()));
}
}
});
exportActionableDynamicQuery.setCompanyId(
portletDataContext.getCompanyId());
exportActionableDynamicQuery.setGroupId(
portletDataContext.getScopeGroupId());
exportActionableDynamicQuery.setPerformActionMethod(
new ActionableDynamicQuery.PerformActionMethod() {
@Override
public void performAction(BookmarksEntry bookmarksEntry)
throws PortalException {
StagedModelDataHandlerUtil.exportStagedModel(
portletDataContext, bookmarksEntry);
}
});
exportActionableDynamicQuery.setStagedModelType(
new StagedModelType(
PortalUtil.getClassNameId(BookmarksEntry.class.getName())));
return exportActionableDynamicQuery;
}
/**
* @throws PortalException
*/
@Override
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException {
return bookmarksEntryPersistence.create(
((Long)primaryKeyObj).longValue());
}
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException {
if (_log.isWarnEnabled()) {
_log.warn(
"Implement BookmarksEntryLocalServiceImpl#deleteBookmarksEntry(BookmarksEntry) to avoid orphaned data");
}
return bookmarksEntryLocalService.deleteBookmarksEntry(
(BookmarksEntry)persistedModel);
}
@Override
public BasePersistence getBasePersistence() {
return bookmarksEntryPersistence;
}
/**
* @throws PortalException
*/
@Override
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException {
return bookmarksEntryPersistence.findByPrimaryKey(primaryKeyObj);
}
/**
* Returns all the bookmarks entries matching the UUID and company.
*
* @param uuid the UUID of the bookmarks entries
* @param companyId the primary key of the company
* @return the matching bookmarks entries, or an empty list if no matches were found
*/
@Override
public List getBookmarksEntriesByUuidAndCompanyId(
String uuid, long companyId) {
return bookmarksEntryPersistence.findByUuid_C(uuid, companyId);
}
/**
* Returns a range of bookmarks entries matching the UUID and company.
*
* @param uuid the UUID of the bookmarks entries
* @param companyId the primary key of the company
* @param start the lower bound of the range of bookmarks entries
* @param end the upper bound of the range of bookmarks entries (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the range of matching bookmarks entries, or an empty list if no matches were found
*/
@Override
public List getBookmarksEntriesByUuidAndCompanyId(
String uuid, long companyId, int start, int end,
OrderByComparator orderByComparator) {
return bookmarksEntryPersistence.findByUuid_C(
uuid, companyId, start, end, orderByComparator);
}
/**
* Returns the bookmarks entry matching the UUID and group.
*
* @param uuid the bookmarks entry's UUID
* @param groupId the primary key of the group
* @return the matching bookmarks entry
* @throws PortalException if a matching bookmarks entry could not be found
*/
@Override
public BookmarksEntry getBookmarksEntryByUuidAndGroupId(
String uuid, long groupId)
throws PortalException {
return bookmarksEntryPersistence.findByUUID_G(uuid, groupId);
}
/**
* Returns a range of all the bookmarks 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.bookmarks.model.impl.BookmarksEntryModelImpl.
*
*
* @param start the lower bound of the range of bookmarks entries
* @param end the upper bound of the range of bookmarks entries (not inclusive)
* @return the range of bookmarks entries
*/
@Override
public List getBookmarksEntries(int start, int end) {
return bookmarksEntryPersistence.findAll(start, end);
}
/**
* Returns the number of bookmarks entries.
*
* @return the number of bookmarks entries
*/
@Override
public int getBookmarksEntriesCount() {
return bookmarksEntryPersistence.countAll();
}
/**
* Updates the bookmarks entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect BookmarksEntryLocalServiceImpl 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 bookmarksEntry the bookmarks entry
* @return the bookmarks entry that was updated
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public BookmarksEntry updateBookmarksEntry(BookmarksEntry bookmarksEntry) {
return bookmarksEntryPersistence.update(bookmarksEntry);
}
@Deactivate
protected void deactivate() {
}
@Override
public Class[] getAopInterfaces() {
return new Class[] {
BookmarksEntryLocalService.class, IdentifiableOSGiService.class,
CTService.class, PersistedModelLocalService.class
};
}
@Override
public void setAopProxy(Object aopProxy) {
bookmarksEntryLocalService = (BookmarksEntryLocalService)aopProxy;
}
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
@Override
public String getOSGiServiceIdentifier() {
return BookmarksEntryLocalService.class.getName();
}
@Override
public CTPersistence getCTPersistence() {
return bookmarksEntryPersistence;
}
@Override
public Class getModelClass() {
return BookmarksEntry.class;
}
@Override
public R updateWithUnsafeFunction(
UnsafeFunction, R, E>
updateUnsafeFunction)
throws E {
return updateUnsafeFunction.apply(bookmarksEntryPersistence);
}
protected String getModelClassName() {
return BookmarksEntry.class.getName();
}
/**
* Performs a SQL query.
*
* @param sql the sql query
*/
protected void runSQL(String sql) {
try {
DataSource dataSource = bookmarksEntryPersistence.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 BookmarksEntryLocalService bookmarksEntryLocalService;
@Reference
protected BookmarksEntryPersistence bookmarksEntryPersistence;
@Reference
protected com.liferay.counter.kernel.service.CounterLocalService
counterLocalService;
private static final Log _log = LogFactoryUtil.getLog(
BookmarksEntryLocalServiceBaseImpl.class);
}