Class FriendlyURLEntryLocalServiceUtil

java.lang.Object
com.liferay.friendly.url.service.FriendlyURLEntryLocalServiceUtil

public class FriendlyURLEntryLocalServiceUtil extends Object
Provides the local service utility for FriendlyURLEntry. This utility wraps com.liferay.friendly.url.service.impl.FriendlyURLEntryLocalServiceImpl 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

    • FriendlyURLEntryLocalServiceUtil

      public FriendlyURLEntryLocalServiceUtil()
  • Method Details

    • addFriendlyURLEntry

      public static FriendlyURLEntry addFriendlyURLEntry(FriendlyURLEntry friendlyURLEntry)
      Adds the friendly url entry to the database. Also notifies the appropriate model listeners.

      Important: Inspect FriendlyURLEntryLocalServiceImpl 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:
      friendlyURLEntry - the friendly url entry
      Returns:
      the friendly url entry that was added
    • addFriendlyURLEntry

      public static FriendlyURLEntry addFriendlyURLEntry(long groupId, Class<?> clazz, long classPK, String urlTitle, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addFriendlyURLEntry

      public static FriendlyURLEntry addFriendlyURLEntry(long groupId, long classNameId, long classPK, Map<String,String> urlTitleMap, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addFriendlyURLEntry

      public static FriendlyURLEntry addFriendlyURLEntry(long groupId, long classNameId, long classPK, String defaultLanguageId, Map<String,String> urlTitleMap, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addFriendlyURLEntry

      public static FriendlyURLEntry addFriendlyURLEntry(long groupId, long classNameId, long classPK, String urlTitle, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createFriendlyURLEntry

      public static FriendlyURLEntry createFriendlyURLEntry(long friendlyURLEntryId)
      Creates a new friendly url entry with the primary key. Does not add the friendly url entry to the database.
      Parameters:
      friendlyURLEntryId - the primary key for the new friendly url entry
      Returns:
      the new friendly url entry
    • 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
    • deleteCompanyFriendlyURLEntries

      public static void deleteCompanyFriendlyURLEntries(long companyId, long classNameId)
    • deleteFriendlyURLEntry

      public static FriendlyURLEntry deleteFriendlyURLEntry(FriendlyURLEntry friendlyURLEntry)
      Deletes the friendly url entry from the database. Also notifies the appropriate model listeners.

      Important: Inspect FriendlyURLEntryLocalServiceImpl 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:
      friendlyURLEntry - the friendly url entry
      Returns:
      the friendly url entry that was removed
    • deleteFriendlyURLEntry

      public static FriendlyURLEntry deleteFriendlyURLEntry(long friendlyURLEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the friendly url entry with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect FriendlyURLEntryLocalServiceImpl 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:
      friendlyURLEntryId - the primary key of the friendly url entry
      Returns:
      the friendly url entry that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a friendly url entry with the primary key could not be found
    • deleteFriendlyURLEntry

      public static void deleteFriendlyURLEntry(long groupId, Class<?> clazz, long classPK)
    • deleteFriendlyURLEntry

      public static void deleteFriendlyURLEntry(long groupId, long classNameId, long classPK)
    • deleteFriendlyURLLocalizationEntry

      public static void deleteFriendlyURLLocalizationEntry(long friendlyURLEntryId, String languageId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteGroupFriendlyURLEntries

      public static void deleteGroupFriendlyURLEntries(long groupId, long classNameId)
    • 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
    • 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.friendly.url.model.impl.FriendlyURLEntryModelImpl.

      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.friendly.url.model.impl.FriendlyURLEntryModelImpl.

      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
    • fetchFriendlyURLEntry

      public static FriendlyURLEntry fetchFriendlyURLEntry(long friendlyURLEntryId)
    • fetchFriendlyURLEntry

      public static FriendlyURLEntry fetchFriendlyURLEntry(long groupId, Class<?> clazz, String urlTitle)
    • fetchFriendlyURLEntry

      public static FriendlyURLEntry fetchFriendlyURLEntry(long groupId, long classNameId, String urlTitle)
    • fetchFriendlyURLEntryByUuidAndGroupId

      public static FriendlyURLEntry fetchFriendlyURLEntryByUuidAndGroupId(String uuid, long groupId)
      Returns the friendly url entry matching the UUID and group.
      Parameters:
      uuid - the friendly url entry's UUID
      groupId - the primary key of the group
      Returns:
      the matching friendly url entry, or null if a matching friendly url entry could not be found
    • fetchFriendlyURLEntryLocalization

      public static FriendlyURLEntryLocalization fetchFriendlyURLEntryLocalization(long groupId, long classNameId, String urlTitle)
    • fetchFriendlyURLEntryLocalization

      public static FriendlyURLEntryLocalization fetchFriendlyURLEntryLocalization(long groupId, long classNameId, String languageId, String urlTitle)
    • fetchFriendlyURLEntryLocalization

      public static FriendlyURLEntryLocalization fetchFriendlyURLEntryLocalization(long friendlyURLEntryId, String languageId)
    • fetchMainFriendlyURLEntry

      public static FriendlyURLEntry fetchMainFriendlyURLEntry(long classNameId, long classPK)
    • 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)
    • getFriendlyURLEntries

      public static List<FriendlyURLEntry> getFriendlyURLEntries(int start, int end)
      Returns a range of all the friendly url entries.

      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.friendly.url.model.impl.FriendlyURLEntryModelImpl.

      Parameters:
      start - the lower bound of the range of friendly url entries
      end - the upper bound of the range of friendly url entries (not inclusive)
      Returns:
      the range of friendly url entries
    • getFriendlyURLEntries

      public static List<FriendlyURLEntry> getFriendlyURLEntries(long groupId, long classNameId, long classPK)
    • getFriendlyURLEntriesByUuidAndCompanyId

      public static List<FriendlyURLEntry> getFriendlyURLEntriesByUuidAndCompanyId(String uuid, long companyId)
      Returns all the friendly url entries matching the UUID and company.
      Parameters:
      uuid - the UUID of the friendly url entries
      companyId - the primary key of the company
      Returns:
      the matching friendly url entries, or an empty list if no matches were found
    • getFriendlyURLEntriesByUuidAndCompanyId

      public static List<FriendlyURLEntry> getFriendlyURLEntriesByUuidAndCompanyId(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<FriendlyURLEntry> orderByComparator)
      Returns a range of friendly url entries matching the UUID and company.
      Parameters:
      uuid - the UUID of the friendly url entries
      companyId - the primary key of the company
      start - the lower bound of the range of friendly url entries
      end - the upper bound of the range of friendly url entries (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the range of matching friendly url entries, or an empty list if no matches were found
    • getFriendlyURLEntriesCount

      public static int getFriendlyURLEntriesCount()
      Returns the number of friendly url entries.
      Returns:
      the number of friendly url entries
    • getFriendlyURLEntry

      public static FriendlyURLEntry getFriendlyURLEntry(long friendlyURLEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the friendly url entry with the primary key.
      Parameters:
      friendlyURLEntryId - the primary key of the friendly url entry
      Returns:
      the friendly url entry
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a friendly url entry with the primary key could not be found
    • getFriendlyURLEntryByUuidAndGroupId

      public static FriendlyURLEntry getFriendlyURLEntryByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the friendly url entry matching the UUID and group.
      Parameters:
      uuid - the friendly url entry's UUID
      groupId - the primary key of the group
      Returns:
      the matching friendly url entry
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching friendly url entry could not be found
    • getFriendlyURLEntryLocalization

      public static FriendlyURLEntryLocalization getFriendlyURLEntryLocalization(long groupId, long classNameId, String urlTitle) throws NoSuchFriendlyURLEntryLocalizationException
      Throws:
      NoSuchFriendlyURLEntryLocalizationException
    • getFriendlyURLEntryLocalization

      public static FriendlyURLEntryLocalization getFriendlyURLEntryLocalization(long groupId, long classNameId, String languageId, String urlTitle) throws NoSuchFriendlyURLEntryLocalizationException
      Throws:
      NoSuchFriendlyURLEntryLocalizationException
    • getFriendlyURLEntryLocalization

      public static FriendlyURLEntryLocalization getFriendlyURLEntryLocalization(long friendlyURLEntryId, String languageId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getFriendlyURLEntryLocalizations

      public static List<FriendlyURLEntryLocalization> getFriendlyURLEntryLocalizations(long friendlyURLEntryId)
    • getFriendlyURLEntryLocalizations

      public static List<FriendlyURLEntryLocalization> getFriendlyURLEntryLocalizations(long groupId, long classNameId, long classPK, String languageId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<FriendlyURLEntryLocalization> orderByComparator)
    • getIndexableActionableDynamicQuery

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

      public static FriendlyURLEntry getMainFriendlyURLEntry(Class<?> clazz, long classPK) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getMainFriendlyURLEntry

      public static FriendlyURLEntry getMainFriendlyURLEntry(long classNameId, long classPK) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • 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
    • getUniqueUrlTitle

      public static String getUniqueUrlTitle(long groupId, long classNameId, long classPK, String urlTitle, String languageId)
    • setMainFriendlyURLEntry

      public static void setMainFriendlyURLEntry(FriendlyURLEntry friendlyURLEntry)
    • updateFriendlyURLEntry

      public static FriendlyURLEntry updateFriendlyURLEntry(FriendlyURLEntry friendlyURLEntry)
      Updates the friendly url entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect FriendlyURLEntryLocalServiceImpl 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:
      friendlyURLEntry - the friendly url entry
      Returns:
      the friendly url entry that was updated
    • updateFriendlyURLEntry

      public static FriendlyURLEntry updateFriendlyURLEntry(long friendlyURLEntryId, long classNameId, long classPK, String defaultLanguageId, Map<String,String> urlTitleMap) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateFriendlyURLEntry

      public static FriendlyURLEntry updateFriendlyURLEntry(long friendlyURLEntryId, long classNameId, long classPK, String defaultLanguageId, Map<String,String> urlTitleMap, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateFriendlyURLEntryLocalization

      public static FriendlyURLEntryLocalization updateFriendlyURLEntryLocalization(FriendlyURLEntry friendlyURLEntry, String languageId, String urlTitle) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateFriendlyURLEntryLocalizations

      public static List<FriendlyURLEntryLocalization> updateFriendlyURLEntryLocalizations(FriendlyURLEntry friendlyURLEntry, Map<String,String> urlTitleMap) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateFriendlyURLLocalization

      public static FriendlyURLEntryLocalization updateFriendlyURLLocalization(FriendlyURLEntryLocalization friendlyURLEntryLocalization)
    • updateFriendlyURLLocalization

      public static FriendlyURLEntryLocalization updateFriendlyURLLocalization(long friendlyURLLocalizationId, String urlTitle) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • validate

      public static void validate(long groupId, long classNameId, long classPK, Map<String,String> urlTitleMap) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • validate

      public static void validate(long groupId, long classNameId, long classPK, String urlTitle) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • validate

      public static void validate(long groupId, long classNameId, long classPK, String languageId, String urlTitle) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • validate

      public static void validate(long groupId, long classNameId, String urlTitle) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getService

      public static FriendlyURLEntryLocalService getService()