Class LayoutSEOEntryLocalServiceUtil

java.lang.Object
com.liferay.layout.seo.service.LayoutSEOEntryLocalServiceUtil

public class LayoutSEOEntryLocalServiceUtil extends Object
Provides the local service utility for LayoutSEOEntry. This utility wraps com.liferay.layout.seo.service.impl.LayoutSEOEntryLocalServiceImpl 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

    • LayoutSEOEntryLocalServiceUtil

      public LayoutSEOEntryLocalServiceUtil()
  • Method Details

    • addLayoutSEOEntry

      public static LayoutSEOEntry addLayoutSEOEntry(LayoutSEOEntry layoutSEOEntry)
      Adds the layout seo entry to the database. Also notifies the appropriate model listeners.

      Important: Inspect LayoutSEOEntryLocalServiceImpl 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:
      layoutSEOEntry - the layout seo entry
      Returns:
      the layout seo entry that was added
    • copyLayoutSEOEntry

      public static LayoutSEOEntry copyLayoutSEOEntry(long userId, long groupId, boolean privateLayout, long sourceLayoutId, boolean canonicalURLEnabled, Map<Locale,String> canonicalURLMap, long copyDDMStorageId, boolean openGraphDescriptionEnabled, Map<Locale,String> openGraphDescriptionMap, Map<Locale,String> openGraphImageAltMap, long openGraphImageFileEntryId, boolean openGraphTitleEnabled, Map<Locale,String> openGraphTitleMap, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createLayoutSEOEntry

      public static LayoutSEOEntry createLayoutSEOEntry(long layoutSEOEntryId)
      Creates a new layout seo entry with the primary key. Does not add the layout seo entry to the database.
      Parameters:
      layoutSEOEntryId - the primary key for the new layout seo entry
      Returns:
      the new layout seo 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
    • deleteLayoutSEOEntry

      public static LayoutSEOEntry deleteLayoutSEOEntry(LayoutSEOEntry layoutSEOEntry)
      Deletes the layout seo entry from the database. Also notifies the appropriate model listeners.

      Important: Inspect LayoutSEOEntryLocalServiceImpl 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:
      layoutSEOEntry - the layout seo entry
      Returns:
      the layout seo entry that was removed
    • deleteLayoutSEOEntry

      public static LayoutSEOEntry deleteLayoutSEOEntry(long layoutSEOEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the layout seo entry with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect LayoutSEOEntryLocalServiceImpl 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:
      layoutSEOEntryId - the primary key of the layout seo entry
      Returns:
      the layout seo entry that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a layout seo entry with the primary key could not be found
    • deleteLayoutSEOEntry

      public static void deleteLayoutSEOEntry(long groupId, boolean privateLayout, long layoutId) throws NoSuchEntryException
      Throws:
      NoSuchEntryException
    • deleteLayoutSEOEntry

      public static void deleteLayoutSEOEntry(String uuid, long groupId) throws NoSuchEntryException
      Throws:
      NoSuchEntryException
    • 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.layout.seo.model.impl.LayoutSEOEntryModelImpl.

      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.layout.seo.model.impl.LayoutSEOEntryModelImpl.

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

      public static LayoutSEOEntry fetchLayoutSEOEntry(long layoutSEOEntryId)
    • fetchLayoutSEOEntry

      public static LayoutSEOEntry fetchLayoutSEOEntry(long groupId, boolean privateLayout, long layoutId)
    • fetchLayoutSEOEntryByUuidAndGroupId

      public static LayoutSEOEntry fetchLayoutSEOEntryByUuidAndGroupId(String uuid, long groupId)
      Returns the layout seo entry matching the UUID and group.
      Parameters:
      uuid - the layout seo entry's UUID
      groupId - the primary key of the group
      Returns:
      the matching layout seo entry, or null if a matching layout seo entry 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()
    • getLayoutSEOEntries

      public static List<LayoutSEOEntry> getLayoutSEOEntries(int start, int end)
      Returns a range of all the layout seo 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.layout.seo.model.impl.LayoutSEOEntryModelImpl.

      Parameters:
      start - the lower bound of the range of layout seo entries
      end - the upper bound of the range of layout seo entries (not inclusive)
      Returns:
      the range of layout seo entries
    • getLayoutSEOEntriesByUuidAndCompanyId

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

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

      public static int getLayoutSEOEntriesCount()
      Returns the number of layout seo entries.
      Returns:
      the number of layout seo entries
    • getLayoutSEOEntry

      public static LayoutSEOEntry getLayoutSEOEntry(long layoutSEOEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the layout seo entry with the primary key.
      Parameters:
      layoutSEOEntryId - the primary key of the layout seo entry
      Returns:
      the layout seo entry
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a layout seo entry with the primary key could not be found
    • getLayoutSEOEntryByUuidAndGroupId

      public static LayoutSEOEntry getLayoutSEOEntryByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the layout seo entry matching the UUID and group.
      Parameters:
      uuid - the layout seo entry's UUID
      groupId - the primary key of the group
      Returns:
      the matching layout seo entry
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching layout seo entry could not be found
    • 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
    • updateCustomMetaTags

      public static LayoutSEOEntry updateCustomMetaTags(long userId, long groupId, boolean privateLayout, long layoutId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateLayoutSEOEntry

      public static LayoutSEOEntry updateLayoutSEOEntry(LayoutSEOEntry layoutSEOEntry)
      Updates the layout seo entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect LayoutSEOEntryLocalServiceImpl 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:
      layoutSEOEntry - the layout seo entry
      Returns:
      the layout seo entry that was updated
    • updateLayoutSEOEntry

      public static LayoutSEOEntry updateLayoutSEOEntry(long userId, long groupId, boolean privateLayout, long layoutId, boolean canonicalURLEnabled, Map<Locale,String> canonicalURLMap, boolean openGraphDescriptionEnabled, Map<Locale,String> openGraphDescriptionMap, Map<Locale,String> openGraphImageAltMap, long openGraphImageFileEntryId, boolean openGraphTitleEnabled, Map<Locale,String> openGraphTitleMap, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateLayoutSEOEntry

      public static LayoutSEOEntry updateLayoutSEOEntry(long userId, long groupId, boolean privateLayout, long layoutId, boolean openGraphDescriptionEnabled, Map<Locale,String> openGraphDescriptionMap, Map<Locale,String> openGraphImageAltMap, long openGraphImageFileEntryId, boolean openGraphTitleEnabled, Map<Locale,String> openGraphTitleMap, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateLayoutSEOEntry

      public static LayoutSEOEntry updateLayoutSEOEntry(long userId, long groupId, boolean privateLayout, long layoutId, boolean canonicalURLEnabled, Map<Locale,String> canonicalURLMap, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getService

      public static LayoutSEOEntryLocalService getService()