com.liferay.site.service.SiteFriendlyURLLocalService Maven / Gradle / Ivy
/**
* Copyright (c) 2000-present Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.site.service;
import aQute.bnd.annotation.ProviderType;
import com.liferay.exportimport.kernel.lar.PortletDataContext;
import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.DynamicQuery;
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.model.PersistedModel;
import com.liferay.portal.kernel.search.Indexable;
import com.liferay.portal.kernel.search.IndexableType;
import com.liferay.portal.kernel.service.BaseLocalService;
import com.liferay.portal.kernel.service.PersistedModelLocalService;
import com.liferay.portal.kernel.service.ServiceContext;
import com.liferay.portal.kernel.transaction.Isolation;
import com.liferay.portal.kernel.transaction.Propagation;
import com.liferay.portal.kernel.transaction.Transactional;
import com.liferay.portal.kernel.util.OrderByComparator;
import com.liferay.site.model.SiteFriendlyURL;
import java.io.Serializable;
import java.util.List;
import java.util.Locale;
import java.util.Map;
/**
* Provides the local service interface for SiteFriendlyURL. Methods of this
* service will not have security checks based on the propagated JAAS
* credentials because this service can only be accessed from within the same
* VM.
*
* @author Brian Wing Shun Chan
* @see SiteFriendlyURLLocalServiceUtil
* @generated
*/
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface SiteFriendlyURLLocalService
extends BaseLocalService, PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link SiteFriendlyURLLocalServiceUtil} to access the site friendly url local service. Add custom service methods to com.liferay.site.service.impl.SiteFriendlyURLLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.
*/
public SiteFriendlyURL addSiteFriendlyURL(
long userId, long companyId, long groupId, String friendlyURL,
String languageId, ServiceContext serviceContext)
throws PortalException;
/**
* Adds the site friendly url to the database. Also notifies the appropriate model listeners.
*
* @param siteFriendlyURL the site friendly url
* @return the site friendly url that was added
*/
@Indexable(type = IndexableType.REINDEX)
public SiteFriendlyURL addSiteFriendlyURL(SiteFriendlyURL siteFriendlyURL);
public List addSiteFriendlyURLs(
long userId, long companyId, long groupId,
Map friendlyURLMap, ServiceContext serviceContext)
throws PortalException;
/**
* 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
*/
@Transactional(enabled = false)
public SiteFriendlyURL createSiteFriendlyURL(long siteFriendlyURLId);
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException;
/**
* Deletes the site friendly url with the primary key from the database. Also notifies the appropriate model listeners.
*
* @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)
public SiteFriendlyURL deleteSiteFriendlyURL(long siteFriendlyURLId)
throws PortalException;
public SiteFriendlyURL deleteSiteFriendlyURL(
long companyId, long groupId, String languageId)
throws PortalException;
/**
* Deletes the site friendly url from the database. Also notifies the appropriate model listeners.
*
* @param siteFriendlyURL the site friendly url
* @return the site friendly url that was removed
*/
@Indexable(type = IndexableType.DELETE)
public SiteFriendlyURL deleteSiteFriendlyURL(
SiteFriendlyURL siteFriendlyURL);
public void deleteSiteFriendlyURLs(long companyId, long groupId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public DynamicQuery dynamicQuery();
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(DynamicQuery 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 and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.site.model.impl.SiteFriendlyURLModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
*
*
* @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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(
DynamicQuery dynamicQuery, int start, int 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 and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.site.model.impl.SiteFriendlyURLModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
*
*
* @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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(
DynamicQuery dynamicQuery, int start, int end,
OrderByComparator orderByComparator);
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @return the number of rows matching the dynamic query
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long dynamicQueryCount(DynamicQuery 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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long dynamicQueryCount(
DynamicQuery dynamicQuery, Projection projection);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public SiteFriendlyURL fetchSiteFriendlyURL(long siteFriendlyURLId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public SiteFriendlyURL fetchSiteFriendlyURL(
long companyId, long groupId, String languageId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public SiteFriendlyURL fetchSiteFriendlyURLByFriendlyURL(
long companyId, String friendlyURL);
/**
* 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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public SiteFriendlyURL fetchSiteFriendlyURLByUuidAndGroupId(
String uuid, long groupId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ExportActionableDynamicQuery getExportActionableDynamicQuery(
PortletDataContext portletDataContext);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
public String getOSGiServiceIdentifier();
@Override
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException;
/**
* 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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public SiteFriendlyURL getSiteFriendlyURL(long siteFriendlyURLId)
throws PortalException;
/**
* 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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public SiteFriendlyURL getSiteFriendlyURLByUuidAndGroupId(
String uuid, long groupId)
throws PortalException;
/**
* 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 and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.site.model.impl.SiteFriendlyURLModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
*
*
* @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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getSiteFriendlyURLs(int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getSiteFriendlyURLs(
long companyId, long groupId);
/**
* 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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getSiteFriendlyURLsByUuidAndCompanyId(
String uuid, long 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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getSiteFriendlyURLsByUuidAndCompanyId(
String uuid, long companyId, int start, int end,
OrderByComparator orderByComparator);
/**
* Returns the number of site friendly urls.
*
* @return the number of site friendly urls
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getSiteFriendlyURLsCount();
public SiteFriendlyURL updateSiteFriendlyURL(
long userId, long companyId, long groupId, String friendlyURL,
String languageId, ServiceContext serviceContext)
throws PortalException;
/**
* Updates the site friendly url in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
* @param siteFriendlyURL the site friendly url
* @return the site friendly url that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public SiteFriendlyURL updateSiteFriendlyURL(
SiteFriendlyURL siteFriendlyURL);
public List updateSiteFriendlyURLs(
long userId, long companyId, long groupId,
Map friendlyURLMap, ServiceContext serviceContext)
throws PortalException;
}