com.liferay.site.service.base.SiteFriendlyURLLocalServiceBaseImpl 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.site.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.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.site.model.SiteFriendlyURL;
import com.liferay.site.service.SiteFriendlyURLLocalService;
import com.liferay.site.service.persistence.SiteFriendlyURLPersistence;
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 site friendly url 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.site.service.impl.SiteFriendlyURLLocalServiceImpl}.
*
*
* @author Brian Wing Shun Chan
* @see com.liferay.site.service.impl.SiteFriendlyURLLocalServiceImpl
* @generated
*/
public abstract class SiteFriendlyURLLocalServiceBaseImpl
extends BaseLocalServiceImpl
implements AopService, IdentifiableOSGiService,
SiteFriendlyURLLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this class directly. Use SiteFriendlyURLLocalService via injection or a org.osgi.util.tracker.ServiceTracker or use com.liferay.site.service.SiteFriendlyURLLocalServiceUtil.
*/
/**
* Adds the site friendly url to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect SiteFriendlyURLLocalServiceImpl 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 siteFriendlyURL the site friendly url
* @return the site friendly url that was added
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public SiteFriendlyURL addSiteFriendlyURL(SiteFriendlyURL siteFriendlyURL) {
siteFriendlyURL.setNew(true);
return siteFriendlyURLPersistence.update(siteFriendlyURL);
}
/**
* Creates a new site friendly url with the primary key. Does not add the site friendly url to the database.
*
* @param siteFriendlyURLId the primary key for the new site friendly url
* @return the new site friendly url
*/
@Override
@Transactional(enabled = false)
public SiteFriendlyURL createSiteFriendlyURL(long siteFriendlyURLId) {
return siteFriendlyURLPersistence.create(siteFriendlyURLId);
}
/**
* Deletes the site friendly url with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect SiteFriendlyURLLocalServiceImpl 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 siteFriendlyURLId the primary key of the site friendly url
* @return the site friendly url that was removed
* @throws PortalException if a site friendly url with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
@Override
public SiteFriendlyURL deleteSiteFriendlyURL(long siteFriendlyURLId)
throws PortalException {
return siteFriendlyURLPersistence.remove(siteFriendlyURLId);
}
/**
* Deletes the site friendly url from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect SiteFriendlyURLLocalServiceImpl 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 siteFriendlyURL the site friendly url
* @return the site friendly url that was removed
*/
@Indexable(type = IndexableType.DELETE)
@Override
public SiteFriendlyURL deleteSiteFriendlyURL(
SiteFriendlyURL siteFriendlyURL) {
return siteFriendlyURLPersistence.remove(siteFriendlyURL);
}
@Override
public T dslQuery(DSLQuery dslQuery) {
return siteFriendlyURLPersistence.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(
SiteFriendlyURL.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 siteFriendlyURLPersistence.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.site.model.impl.SiteFriendlyURLModelImpl.
*
*
* @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 siteFriendlyURLPersistence.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.site.model.impl.SiteFriendlyURLModelImpl.
*
*
* @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 siteFriendlyURLPersistence.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 siteFriendlyURLPersistence.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 siteFriendlyURLPersistence.countWithDynamicQuery(
dynamicQuery, projection);
}
@Override
public SiteFriendlyURL fetchSiteFriendlyURL(long siteFriendlyURLId) {
return siteFriendlyURLPersistence.fetchByPrimaryKey(siteFriendlyURLId);
}
/**
* Returns the site friendly url matching the UUID and group.
*
* @param uuid the site friendly url's UUID
* @param groupId the primary key of the group
* @return the matching site friendly url, or null if a matching site friendly url could not be found
*/
@Override
public SiteFriendlyURL fetchSiteFriendlyURLByUuidAndGroupId(
String uuid, long groupId) {
return siteFriendlyURLPersistence.fetchByUUID_G(uuid, groupId);
}
/**
* Returns the site friendly url with the primary key.
*
* @param siteFriendlyURLId the primary key of the site friendly url
* @return the site friendly url
* @throws PortalException if a site friendly url with the primary key could not be found
*/
@Override
public SiteFriendlyURL getSiteFriendlyURL(long siteFriendlyURLId)
throws PortalException {
return siteFriendlyURLPersistence.findByPrimaryKey(siteFriendlyURLId);
}
@Override
public ActionableDynamicQuery getActionableDynamicQuery() {
ActionableDynamicQuery actionableDynamicQuery =
new DefaultActionableDynamicQuery();
actionableDynamicQuery.setBaseLocalService(siteFriendlyURLLocalService);
actionableDynamicQuery.setClassLoader(getClassLoader());
actionableDynamicQuery.setModelClass(SiteFriendlyURL.class);
actionableDynamicQuery.setPrimaryKeyPropertyName("siteFriendlyURLId");
return actionableDynamicQuery;
}
@Override
public IndexableActionableDynamicQuery
getIndexableActionableDynamicQuery() {
IndexableActionableDynamicQuery indexableActionableDynamicQuery =
new IndexableActionableDynamicQuery();
indexableActionableDynamicQuery.setBaseLocalService(
siteFriendlyURLLocalService);
indexableActionableDynamicQuery.setClassLoader(getClassLoader());
indexableActionableDynamicQuery.setModelClass(SiteFriendlyURL.class);
indexableActionableDynamicQuery.setPrimaryKeyPropertyName(
"siteFriendlyURLId");
return indexableActionableDynamicQuery;
}
protected void initActionableDynamicQuery(
ActionableDynamicQuery actionableDynamicQuery) {
actionableDynamicQuery.setBaseLocalService(siteFriendlyURLLocalService);
actionableDynamicQuery.setClassLoader(getClassLoader());
actionableDynamicQuery.setModelClass(SiteFriendlyURL.class);
actionableDynamicQuery.setPrimaryKeyPropertyName("siteFriendlyURLId");
}
@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.setGroupId(
portletDataContext.getScopeGroupId());
exportActionableDynamicQuery.setPerformActionMethod(
new ActionableDynamicQuery.PerformActionMethod() {
@Override
public void performAction(SiteFriendlyURL siteFriendlyURL)
throws PortalException {
StagedModelDataHandlerUtil.exportStagedModel(
portletDataContext, siteFriendlyURL);
}
});
exportActionableDynamicQuery.setStagedModelType(
new StagedModelType(
PortalUtil.getClassNameId(SiteFriendlyURL.class.getName())));
return exportActionableDynamicQuery;
}
/**
* @throws PortalException
*/
@Override
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException {
return siteFriendlyURLPersistence.create(
((Long)primaryKeyObj).longValue());
}
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException {
if (_log.isWarnEnabled()) {
_log.warn(
"Implement SiteFriendlyURLLocalServiceImpl#deleteSiteFriendlyURL(SiteFriendlyURL) to avoid orphaned data");
}
return siteFriendlyURLLocalService.deleteSiteFriendlyURL(
(SiteFriendlyURL)persistedModel);
}
@Override
public BasePersistence getBasePersistence() {
return siteFriendlyURLPersistence;
}
/**
* @throws PortalException
*/
@Override
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException {
return siteFriendlyURLPersistence.findByPrimaryKey(primaryKeyObj);
}
/**
* Returns all the site friendly urls matching the UUID and company.
*
* @param uuid the UUID of the site friendly urls
* @param companyId the primary key of the company
* @return the matching site friendly urls, or an empty list if no matches were found
*/
@Override
public List getSiteFriendlyURLsByUuidAndCompanyId(
String uuid, long companyId) {
return siteFriendlyURLPersistence.findByUuid_C(uuid, companyId);
}
/**
* Returns a range of site friendly urls matching the UUID and company.
*
* @param uuid the UUID of the site friendly urls
* @param companyId the primary key of the company
* @param start the lower bound of the range of site friendly urls
* @param end the upper bound of the range of site friendly urls (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the range of matching site friendly urls, or an empty list if no matches were found
*/
@Override
public List getSiteFriendlyURLsByUuidAndCompanyId(
String uuid, long companyId, int start, int end,
OrderByComparator orderByComparator) {
return siteFriendlyURLPersistence.findByUuid_C(
uuid, companyId, start, end, orderByComparator);
}
/**
* Returns the site friendly url matching the UUID and group.
*
* @param uuid the site friendly url's UUID
* @param groupId the primary key of the group
* @return the matching site friendly url
* @throws PortalException if a matching site friendly url could not be found
*/
@Override
public SiteFriendlyURL getSiteFriendlyURLByUuidAndGroupId(
String uuid, long groupId)
throws PortalException {
return siteFriendlyURLPersistence.findByUUID_G(uuid, groupId);
}
/**
* Returns a range of all the site friendly urls.
*
*
* 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.site.model.impl.SiteFriendlyURLModelImpl.
*
*
* @param start the lower bound of the range of site friendly urls
* @param end the upper bound of the range of site friendly urls (not inclusive)
* @return the range of site friendly urls
*/
@Override
public List getSiteFriendlyURLs(int start, int end) {
return siteFriendlyURLPersistence.findAll(start, end);
}
/**
* Returns the number of site friendly urls.
*
* @return the number of site friendly urls
*/
@Override
public int getSiteFriendlyURLsCount() {
return siteFriendlyURLPersistence.countAll();
}
/**
* Updates the site friendly url in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect SiteFriendlyURLLocalServiceImpl 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 siteFriendlyURL the site friendly url
* @return the site friendly url that was updated
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public SiteFriendlyURL updateSiteFriendlyURL(
SiteFriendlyURL siteFriendlyURL) {
return siteFriendlyURLPersistence.update(siteFriendlyURL);
}
@Deactivate
protected void deactivate() {
}
@Override
public Class[] getAopInterfaces() {
return new Class[] {
SiteFriendlyURLLocalService.class, IdentifiableOSGiService.class,
PersistedModelLocalService.class
};
}
@Override
public void setAopProxy(Object aopProxy) {
siteFriendlyURLLocalService = (SiteFriendlyURLLocalService)aopProxy;
}
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
@Override
public String getOSGiServiceIdentifier() {
return SiteFriendlyURLLocalService.class.getName();
}
protected Class getModelClass() {
return SiteFriendlyURL.class;
}
protected String getModelClassName() {
return SiteFriendlyURL.class.getName();
}
/**
* Performs a SQL query.
*
* @param sql the sql query
*/
protected void runSQL(String sql) {
try {
DataSource dataSource = siteFriendlyURLPersistence.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 SiteFriendlyURLLocalService siteFriendlyURLLocalService;
@Reference
protected SiteFriendlyURLPersistence siteFriendlyURLPersistence;
@Reference
protected com.liferay.counter.kernel.service.CounterLocalService
counterLocalService;
private static final Log _log = LogFactoryUtil.getLog(
SiteFriendlyURLLocalServiceBaseImpl.class);
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy