Class SiteFriendlyURLLocalServiceUtil

java.lang.Object
com.liferay.site.service.SiteFriendlyURLLocalServiceUtil

public class SiteFriendlyURLLocalServiceUtil extends Object
Provides the local service utility for SiteFriendlyURL. This utility wraps com.liferay.site.service.impl.SiteFriendlyURLLocalServiceImpl and is an access point for service operations in application layer code running on the local server. 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:
  • Constructor Details

    • SiteFriendlyURLLocalServiceUtil

      public SiteFriendlyURLLocalServiceUtil()
  • Method Details

    • addSiteFriendlyURL

      public static 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

      public static 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

      public static 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

      public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createSiteFriendlyURL

      public static 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

      public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteSiteFriendlyURL

      public static 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

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

      public static 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

      public static void deleteSiteFriendlyURLs(long companyId, long groupId)
    • dslQuery

      public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dslQueryCount

      public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dynamicQuery

      public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

      public static <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

      public static <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

      public static <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

      public static 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

      public static 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

      public static SiteFriendlyURL fetchSiteFriendlyURL(long siteFriendlyURLId)
    • fetchSiteFriendlyURL

      public static SiteFriendlyURL fetchSiteFriendlyURL(long companyId, long groupId, String languageId)
    • fetchSiteFriendlyURLByFriendlyURL

      public static SiteFriendlyURL fetchSiteFriendlyURLByFriendlyURL(long companyId, String friendlyURL)
    • fetchSiteFriendlyURLByUuidAndGroupId

      public static 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

      public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • getExportActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
    • getIndexableActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

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

      public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getSiteFriendlyURL

      public static 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

      public static 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

      public static 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

      public static List<SiteFriendlyURL> getSiteFriendlyURLs(long companyId, long groupId)
    • getSiteFriendlyURLsByUuidAndCompanyId

      public static 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

      public static 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

      public static int getSiteFriendlyURLsCount()
      Returns the number of site friendly urls.
      Returns:
      the number of site friendly urls
    • updateSiteFriendlyURL

      public static 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

      public static 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

      public static 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
    • getService

      public static SiteFriendlyURLLocalService getService()