com.liferay.bookmarks.service.base.BookmarksFolderLocalServiceBaseImpl Maven / Gradle / Ivy
The newest version!
/**
* 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.BookmarksFolder;
import com.liferay.bookmarks.service.BookmarksFolderLocalService;
import com.liferay.bookmarks.service.persistence.BookmarksFolderFinder;
import com.liferay.bookmarks.service.persistence.BookmarksFolderPersistence;
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 folder 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.BookmarksFolderLocalServiceImpl}.
*
*
* @author Brian Wing Shun Chan
* @see com.liferay.bookmarks.service.impl.BookmarksFolderLocalServiceImpl
* @generated
*/
public abstract class BookmarksFolderLocalServiceBaseImpl
extends BaseLocalServiceImpl
implements AopService, BookmarksFolderLocalService,
IdentifiableOSGiService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this class directly. Use BookmarksFolderLocalService via injection or a org.osgi.util.tracker.ServiceTracker or use com.liferay.bookmarks.service.BookmarksFolderLocalServiceUtil.
*/
/**
* Adds the bookmarks folder to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect BookmarksFolderLocalServiceImpl 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 bookmarksFolder the bookmarks folder
* @return the bookmarks folder that was added
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public BookmarksFolder addBookmarksFolder(BookmarksFolder bookmarksFolder) {
bookmarksFolder.setNew(true);
return bookmarksFolderPersistence.update(bookmarksFolder);
}
/**
* Creates a new bookmarks folder with the primary key. Does not add the bookmarks folder to the database.
*
* @param folderId the primary key for the new bookmarks folder
* @return the new bookmarks folder
*/
@Override
@Transactional(enabled = false)
public BookmarksFolder createBookmarksFolder(long folderId) {
return bookmarksFolderPersistence.create(folderId);
}
/**
* Deletes the bookmarks folder with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect BookmarksFolderLocalServiceImpl 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 folderId the primary key of the bookmarks folder
* @return the bookmarks folder that was removed
* @throws PortalException if a bookmarks folder with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
@Override
public BookmarksFolder deleteBookmarksFolder(long folderId)
throws PortalException {
return bookmarksFolderPersistence.remove(folderId);
}
/**
* Deletes the bookmarks folder from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect BookmarksFolderLocalServiceImpl 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 bookmarksFolder the bookmarks folder
* @return the bookmarks folder that was removed
*/
@Indexable(type = IndexableType.DELETE)
@Override
public BookmarksFolder deleteBookmarksFolder(
BookmarksFolder bookmarksFolder) {
return bookmarksFolderPersistence.remove(bookmarksFolder);
}
@Override
public T dslQuery(DSLQuery dslQuery) {
return bookmarksFolderPersistence.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(
BookmarksFolder.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 bookmarksFolderPersistence.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.BookmarksFolderModelImpl.
*
*
* @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 bookmarksFolderPersistence.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.BookmarksFolderModelImpl.
*
*
* @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 bookmarksFolderPersistence.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 bookmarksFolderPersistence.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 bookmarksFolderPersistence.countWithDynamicQuery(
dynamicQuery, projection);
}
@Override
public BookmarksFolder fetchBookmarksFolder(long folderId) {
return bookmarksFolderPersistence.fetchByPrimaryKey(folderId);
}
/**
* Returns the bookmarks folder matching the UUID and group.
*
* @param uuid the bookmarks folder's UUID
* @param groupId the primary key of the group
* @return the matching bookmarks folder, or null if a matching bookmarks folder could not be found
*/
@Override
public BookmarksFolder fetchBookmarksFolderByUuidAndGroupId(
String uuid, long groupId) {
return bookmarksFolderPersistence.fetchByUUID_G(uuid, groupId);
}
/**
* Returns the bookmarks folder with the primary key.
*
* @param folderId the primary key of the bookmarks folder
* @return the bookmarks folder
* @throws PortalException if a bookmarks folder with the primary key could not be found
*/
@Override
public BookmarksFolder getBookmarksFolder(long folderId)
throws PortalException {
return bookmarksFolderPersistence.findByPrimaryKey(folderId);
}
@Override
public ActionableDynamicQuery getActionableDynamicQuery() {
ActionableDynamicQuery actionableDynamicQuery =
new DefaultActionableDynamicQuery();
actionableDynamicQuery.setBaseLocalService(bookmarksFolderLocalService);
actionableDynamicQuery.setClassLoader(getClassLoader());
actionableDynamicQuery.setModelClass(BookmarksFolder.class);
actionableDynamicQuery.setPrimaryKeyPropertyName("folderId");
return actionableDynamicQuery;
}
@Override
public IndexableActionableDynamicQuery
getIndexableActionableDynamicQuery() {
IndexableActionableDynamicQuery indexableActionableDynamicQuery =
new IndexableActionableDynamicQuery();
indexableActionableDynamicQuery.setBaseLocalService(
bookmarksFolderLocalService);
indexableActionableDynamicQuery.setClassLoader(getClassLoader());
indexableActionableDynamicQuery.setModelClass(BookmarksFolder.class);
indexableActionableDynamicQuery.setPrimaryKeyPropertyName("folderId");
return indexableActionableDynamicQuery;
}
protected void initActionableDynamicQuery(
ActionableDynamicQuery actionableDynamicQuery) {
actionableDynamicQuery.setBaseLocalService(bookmarksFolderLocalService);
actionableDynamicQuery.setClassLoader(getClassLoader());
actionableDynamicQuery.setModelClass(BookmarksFolder.class);
actionableDynamicQuery.setPrimaryKeyPropertyName("folderId");
}
@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(
BookmarksFolder.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(BookmarksFolder bookmarksFolder)
throws PortalException {
StagedModelDataHandlerUtil.exportStagedModel(
portletDataContext, bookmarksFolder);
}
});
exportActionableDynamicQuery.setStagedModelType(
new StagedModelType(
PortalUtil.getClassNameId(BookmarksFolder.class.getName())));
return exportActionableDynamicQuery;
}
/**
* @throws PortalException
*/
@Override
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException {
return bookmarksFolderPersistence.create(
((Long)primaryKeyObj).longValue());
}
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException {
if (_log.isWarnEnabled()) {
_log.warn(
"Implement BookmarksFolderLocalServiceImpl#deleteBookmarksFolder(BookmarksFolder) to avoid orphaned data");
}
return bookmarksFolderLocalService.deleteBookmarksFolder(
(BookmarksFolder)persistedModel);
}
@Override
public BasePersistence getBasePersistence() {
return bookmarksFolderPersistence;
}
/**
* @throws PortalException
*/
@Override
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException {
return bookmarksFolderPersistence.findByPrimaryKey(primaryKeyObj);
}
/**
* Returns all the bookmarks folders matching the UUID and company.
*
* @param uuid the UUID of the bookmarks folders
* @param companyId the primary key of the company
* @return the matching bookmarks folders, or an empty list if no matches were found
*/
@Override
public List getBookmarksFoldersByUuidAndCompanyId(
String uuid, long companyId) {
return bookmarksFolderPersistence.findByUuid_C(uuid, companyId);
}
/**
* Returns a range of bookmarks folders matching the UUID and company.
*
* @param uuid the UUID of the bookmarks folders
* @param companyId the primary key of the company
* @param start the lower bound of the range of bookmarks folders
* @param end the upper bound of the range of bookmarks folders (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the range of matching bookmarks folders, or an empty list if no matches were found
*/
@Override
public List getBookmarksFoldersByUuidAndCompanyId(
String uuid, long companyId, int start, int end,
OrderByComparator orderByComparator) {
return bookmarksFolderPersistence.findByUuid_C(
uuid, companyId, start, end, orderByComparator);
}
/**
* Returns the bookmarks folder matching the UUID and group.
*
* @param uuid the bookmarks folder's UUID
* @param groupId the primary key of the group
* @return the matching bookmarks folder
* @throws PortalException if a matching bookmarks folder could not be found
*/
@Override
public BookmarksFolder getBookmarksFolderByUuidAndGroupId(
String uuid, long groupId)
throws PortalException {
return bookmarksFolderPersistence.findByUUID_G(uuid, groupId);
}
/**
* Returns a range of all the bookmarks folders.
*
*
* 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.BookmarksFolderModelImpl.
*
*
* @param start the lower bound of the range of bookmarks folders
* @param end the upper bound of the range of bookmarks folders (not inclusive)
* @return the range of bookmarks folders
*/
@Override
public List getBookmarksFolders(int start, int end) {
return bookmarksFolderPersistence.findAll(start, end);
}
/**
* Returns the number of bookmarks folders.
*
* @return the number of bookmarks folders
*/
@Override
public int getBookmarksFoldersCount() {
return bookmarksFolderPersistence.countAll();
}
/**
* Updates the bookmarks folder in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect BookmarksFolderLocalServiceImpl 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 bookmarksFolder the bookmarks folder
* @return the bookmarks folder that was updated
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public BookmarksFolder updateBookmarksFolder(
BookmarksFolder bookmarksFolder) {
return bookmarksFolderPersistence.update(bookmarksFolder);
}
@Deactivate
protected void deactivate() {
}
@Override
public Class[] getAopInterfaces() {
return new Class[] {
BookmarksFolderLocalService.class, IdentifiableOSGiService.class,
CTService.class, PersistedModelLocalService.class
};
}
@Override
public void setAopProxy(Object aopProxy) {
bookmarksFolderLocalService = (BookmarksFolderLocalService)aopProxy;
}
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
@Override
public String getOSGiServiceIdentifier() {
return BookmarksFolderLocalService.class.getName();
}
@Override
public CTPersistence getCTPersistence() {
return bookmarksFolderPersistence;
}
@Override
public Class getModelClass() {
return BookmarksFolder.class;
}
@Override
public R updateWithUnsafeFunction(
UnsafeFunction, R, E>
updateUnsafeFunction)
throws E {
return updateUnsafeFunction.apply(bookmarksFolderPersistence);
}
protected String getModelClassName() {
return BookmarksFolder.class.getName();
}
/**
* Performs a SQL query.
*
* @param sql the sql query
*/
protected void runSQL(String sql) {
try {
DataSource dataSource = bookmarksFolderPersistence.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 BookmarksFolderLocalService bookmarksFolderLocalService;
@Reference
protected BookmarksFolderPersistence bookmarksFolderPersistence;
@Reference
protected BookmarksFolderFinder bookmarksFolderFinder;
@Reference
protected com.liferay.counter.kernel.service.CounterLocalService
counterLocalService;
private static final Log _log = LogFactoryUtil.getLog(
BookmarksFolderLocalServiceBaseImpl.class);
}