Interface SiteFriendlyURLLocalService

All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService
All Known Implementing Classes:
SiteFriendlyURLLocalServiceWrapper

@ProviderType @Transactional(isolation=PORTAL, rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class}) public interface SiteFriendlyURLLocalService extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService
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.
See Also:
Generated:
  • Method Details

    • addSiteFriendlyURL

      SiteFriendlyURL addSiteFriendlyURL(long userId, long companyId, long groupId, String friendlyURL, String languageId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addSiteFriendlyURL

      @Indexable(type=REINDEX) SiteFriendlyURL addSiteFriendlyURL(SiteFriendlyURL siteFriendlyURL)
      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.

      Parameters:
      siteFriendlyURL - the site friendly url
      Returns:
      the site friendly url that was added
    • addSiteFriendlyURLs

      List<SiteFriendlyURL> addSiteFriendlyURLs(long userId, long companyId, long groupId, Map<Locale,String> friendlyURLMap, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createPersistedModel

      com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      createPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createSiteFriendlyURL

      @Transactional(enabled=false) SiteFriendlyURL createSiteFriendlyURL(long siteFriendlyURLId)
      Creates a new site friendly url with the primary key. Does not add the site friendly url to the database.
      Parameters:
      siteFriendlyURLId - the primary key for the new site friendly url
      Returns:
      the new site friendly url
    • deletePersistedModel

      com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteSiteFriendlyURL

      @Indexable(type=DELETE) SiteFriendlyURL deleteSiteFriendlyURL(long siteFriendlyURLId) throws com.liferay.portal.kernel.exception.PortalException
      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.

      Parameters:
      siteFriendlyURLId - the primary key of the site friendly url
      Returns:
      the site friendly url that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a site friendly url with the primary key could not be found
    • deleteSiteFriendlyURL

      SiteFriendlyURL deleteSiteFriendlyURL(long companyId, long groupId, String languageId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteSiteFriendlyURL

      @Indexable(type=DELETE) @SystemEvent(type=1) SiteFriendlyURL deleteSiteFriendlyURL(SiteFriendlyURL siteFriendlyURL)
      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.

      Parameters:
      siteFriendlyURL - the site friendly url
      Returns:
      the site friendly url that was removed
    • deleteSiteFriendlyURLs

      void deleteSiteFriendlyURLs(long companyId, long groupId)
    • dslQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQuery in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dslQueryCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQueryCount in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
      Performs a dynamic query on the database and returns the matching rows.
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the matching rows
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end)
      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.

      Parameters:
      dynamicQuery - the dynamic query
      start - the lower bound of the range of model instances
      end - the upper bound of the range of model instances (not inclusive)
      Returns:
      the range of matching rows
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)
      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.

      Parameters:
      dynamicQuery - the dynamic query
      start - the lower bound of the range of model instances
      end - the upper bound of the range of model instances (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the ordered range of matching rows
    • dynamicQueryCount

      @Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
      Returns the number of rows matching the dynamic query.
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the number of rows matching the dynamic query
    • dynamicQueryCount

      @Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection)
      Returns the number of rows matching the dynamic query.
      Parameters:
      dynamicQuery - the dynamic query
      projection - the projection to apply to the query
      Returns:
      the number of rows matching the dynamic query
    • fetchSiteFriendlyURL

      @Transactional(propagation=SUPPORTS, readOnly=true) SiteFriendlyURL fetchSiteFriendlyURL(long siteFriendlyURLId)
    • fetchSiteFriendlyURL

      @Transactional(propagation=SUPPORTS, readOnly=true) SiteFriendlyURL fetchSiteFriendlyURL(long companyId, long groupId, String languageId)
    • fetchSiteFriendlyURLByFriendlyURL

      @Transactional(propagation=SUPPORTS, readOnly=true) SiteFriendlyURL fetchSiteFriendlyURLByFriendlyURL(long companyId, String friendlyURL)
    • fetchSiteFriendlyURLByUuidAndGroupId

      @Transactional(propagation=SUPPORTS, readOnly=true) SiteFriendlyURL fetchSiteFriendlyURLByUuidAndGroupId(String uuid, long groupId)
      Returns the site friendly url matching the UUID and group.
      Parameters:
      uuid - the site friendly url's UUID
      groupId - the primary key of the group
      Returns:
      the matching site friendly url, or null if a matching site friendly url could not be found
    • getActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • getExportActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
    • getIndexableActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

      String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • getPersistedModel

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getSiteFriendlyURL

      @Transactional(propagation=SUPPORTS, readOnly=true) SiteFriendlyURL getSiteFriendlyURL(long siteFriendlyURLId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the site friendly url with the primary key.
      Parameters:
      siteFriendlyURLId - the primary key of the site friendly url
      Returns:
      the site friendly url
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a site friendly url with the primary key could not be found
    • getSiteFriendlyURLByUuidAndGroupId

      @Transactional(propagation=SUPPORTS, readOnly=true) SiteFriendlyURL getSiteFriendlyURLByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the site friendly url matching the UUID and group.
      Parameters:
      uuid - the site friendly url's UUID
      groupId - the primary key of the group
      Returns:
      the matching site friendly url
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching site friendly url could not be found
    • getSiteFriendlyURLs

      @Transactional(propagation=SUPPORTS, readOnly=true) List<SiteFriendlyURL> getSiteFriendlyURLs(int start, int end)
      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.

      Parameters:
      start - the lower bound of the range of site friendly urls
      end - the upper bound of the range of site friendly urls (not inclusive)
      Returns:
      the range of site friendly urls
    • getSiteFriendlyURLs

      @Transactional(propagation=SUPPORTS, readOnly=true) List<SiteFriendlyURL> getSiteFriendlyURLs(long companyId, long groupId)
    • getSiteFriendlyURLsByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) List<SiteFriendlyURL> getSiteFriendlyURLsByUuidAndCompanyId(String uuid, long companyId)
      Returns all the site friendly urls matching the UUID and company.
      Parameters:
      uuid - the UUID of the site friendly urls
      companyId - the primary key of the company
      Returns:
      the matching site friendly urls, or an empty list if no matches were found
    • getSiteFriendlyURLsByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) List<SiteFriendlyURL> getSiteFriendlyURLsByUuidAndCompanyId(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<SiteFriendlyURL> orderByComparator)
      Returns a range of site friendly urls matching the UUID and company.
      Parameters:
      uuid - the UUID of the site friendly urls
      companyId - the primary key of the company
      start - the lower bound of the range of site friendly urls
      end - the upper bound of the range of site friendly urls (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the range of matching site friendly urls, or an empty list if no matches were found
    • getSiteFriendlyURLsCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getSiteFriendlyURLsCount()
      Returns the number of site friendly urls.
      Returns:
      the number of site friendly urls
    • updateSiteFriendlyURL

      SiteFriendlyURL updateSiteFriendlyURL(long userId, long companyId, long groupId, String friendlyURL, String languageId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateSiteFriendlyURL

      @Indexable(type=REINDEX) SiteFriendlyURL updateSiteFriendlyURL(SiteFriendlyURL siteFriendlyURL)
      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.

      Parameters:
      siteFriendlyURL - the site friendly url
      Returns:
      the site friendly url that was updated
    • updateSiteFriendlyURLs

      List<SiteFriendlyURL> updateSiteFriendlyURLs(long userId, long companyId, long groupId, Map<Locale,String> friendlyURLMap, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException