Class LayoutPageTemplateEntryLocalServiceUtil

java.lang.Object
com.liferay.layout.page.template.service.LayoutPageTemplateEntryLocalServiceUtil

public class LayoutPageTemplateEntryLocalServiceUtil extends Object
Provides the local service utility for LayoutPageTemplateEntry. This utility wraps com.liferay.layout.page.template.service.impl.LayoutPageTemplateEntryLocalServiceImpl 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

    • LayoutPageTemplateEntryLocalServiceUtil

      public LayoutPageTemplateEntryLocalServiceUtil()
  • Method Details

    • addGlobalLayoutPageTemplateEntry

      public static LayoutPageTemplateEntry addGlobalLayoutPageTemplateEntry(com.liferay.portal.kernel.model.LayoutPrototype layoutPrototype) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addLayoutPageTemplateEntry

      public static LayoutPageTemplateEntry addLayoutPageTemplateEntry(LayoutPageTemplateEntry layoutPageTemplateEntry)
      Adds the layout page template entry to the database. Also notifies the appropriate model listeners.

      Important: Inspect LayoutPageTemplateEntryLocalServiceImpl 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:
      layoutPageTemplateEntry - the layout page template entry
      Returns:
      the layout page template entry that was added
    • addLayoutPageTemplateEntry

      public static LayoutPageTemplateEntry addLayoutPageTemplateEntry(com.liferay.portal.kernel.model.LayoutPrototype layoutPrototype) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addLayoutPageTemplateEntry

      public static LayoutPageTemplateEntry addLayoutPageTemplateEntry(String externalReferenceCode, long userId, long groupId, long layoutPageTemplateCollectionId, String layoutPageTemplateEntryKey, long classNameId, long classTypeId, String name, int type, long previewFileEntryId, boolean defaultTemplate, long layoutPrototypeId, long plid, long masterLayoutPlid, int status, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addLayoutPageTemplateEntry

      public static LayoutPageTemplateEntry addLayoutPageTemplateEntry(String externalReferenceCode, long userId, long groupId, long layoutPageTemplateCollectionId, String layoutPageTemplateEntryKey, long classNameId, long classTypeId, String name, int type, long masterLayoutPlid, int status, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addLayoutPageTemplateEntry

      public static LayoutPageTemplateEntry addLayoutPageTemplateEntry(String externalReferenceCode, long userId, long groupId, long layoutPageTemplateCollectionId, String layoutPageTemplateEntryKey, String name, int type, long masterLayoutPlid, int status, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • copyLayoutPageTemplateEntry

      public static LayoutPageTemplateEntry copyLayoutPageTemplateEntry(long userId, long groupId, long layoutPageTemplateCollectionId, long sourceLayoutPageTemplateEntryId, boolean copyPermissions, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws Exception
      Throws:
      Exception
    • createLayoutPageTemplateEntry

      public static LayoutPageTemplateEntry createLayoutPageTemplateEntry(long layoutPageTemplateEntryId)
      Creates a new layout page template entry with the primary key. Does not add the layout page template entry to the database.
      Parameters:
      layoutPageTemplateEntryId - the primary key for the new layout page template entry
      Returns:
      the new layout page template 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
    • deleteLayoutPageTemplateEntry

      public static LayoutPageTemplateEntry deleteLayoutPageTemplateEntry(LayoutPageTemplateEntry layoutPageTemplateEntry) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the layout page template entry from the database. Also notifies the appropriate model listeners.

      Important: Inspect LayoutPageTemplateEntryLocalServiceImpl 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:
      layoutPageTemplateEntry - the layout page template entry
      Returns:
      the layout page template entry that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteLayoutPageTemplateEntry

      public static LayoutPageTemplateEntry deleteLayoutPageTemplateEntry(long layoutPageTemplateEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the layout page template entry with the primary key from the database. Also notifies the appropriate model listeners.

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

      public static LayoutPageTemplateEntry deleteLayoutPageTemplateEntry(String externalReferenceCode, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • 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.page.template.model.impl.LayoutPageTemplateEntryModelImpl.

      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.page.template.model.impl.LayoutPageTemplateEntryModelImpl.

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

      public static LayoutPageTemplateEntry fetchDefaultLayoutPageTemplateEntry(long groupId, long classNameId, long classTypeId)
    • fetchFirstLayoutPageTemplateEntry

      public static LayoutPageTemplateEntry fetchFirstLayoutPageTemplateEntry(long layoutPrototypeId)
    • fetchLayoutPageTemplateEntry

      public static LayoutPageTemplateEntry fetchLayoutPageTemplateEntry(long layoutPageTemplateEntryId)
    • fetchLayoutPageTemplateEntry

      public static LayoutPageTemplateEntry fetchLayoutPageTemplateEntry(long groupId, long layoutPageTemplateCollectionId, String name, int type)
    • fetchLayoutPageTemplateEntry

      public static LayoutPageTemplateEntry fetchLayoutPageTemplateEntry(long groupId, String layoutPageTemplateEntryKey)
    • fetchLayoutPageTemplateEntryByExternalReferenceCode

      public static LayoutPageTemplateEntry fetchLayoutPageTemplateEntryByExternalReferenceCode(String externalReferenceCode, long groupId)
    • fetchLayoutPageTemplateEntryByPlid

      public static LayoutPageTemplateEntry fetchLayoutPageTemplateEntryByPlid(long plid)
    • fetchLayoutPageTemplateEntryByUuidAndGroupId

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

      public static LayoutPageTemplateEntry getFirstLayoutPageTemplateEntry(long layoutPrototypeId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getIndexableActionableDynamicQuery

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

      public static List<LayoutPageTemplateEntry> getLayoutPageTemplateEntries(int start, int end)
      Returns a range of all the layout page template 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.page.template.model.impl.LayoutPageTemplateEntryModelImpl.

      Parameters:
      start - the lower bound of the range of layout page template entries
      end - the upper bound of the range of layout page template entries (not inclusive)
      Returns:
      the range of layout page template entries
    • getLayoutPageTemplateEntries

      public static List<LayoutPageTemplateEntry> getLayoutPageTemplateEntries(long groupId)
    • getLayoutPageTemplateEntries

      public static List<LayoutPageTemplateEntry> getLayoutPageTemplateEntries(long groupId, int status)
    • getLayoutPageTemplateEntries

      public static List<LayoutPageTemplateEntry> getLayoutPageTemplateEntries(long groupId, long layoutPageTemplateCollectionId)
    • getLayoutPageTemplateEntries

      public static List<LayoutPageTemplateEntry> getLayoutPageTemplateEntries(long groupId, long layoutPageTemplateCollectionId, int status)
    • getLayoutPageTemplateEntries

      public static List<LayoutPageTemplateEntry> getLayoutPageTemplateEntries(long groupId, long layoutPageTemplateCollectionId, int start, int end)
    • getLayoutPageTemplateEntries

      public static List<LayoutPageTemplateEntry> getLayoutPageTemplateEntries(long groupId, long layoutPageTemplateCollectionId, int status, int start, int end)
    • getLayoutPageTemplateEntries

      public static List<LayoutPageTemplateEntry> getLayoutPageTemplateEntries(long groupId, long layoutPageTemplateCollectionId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<LayoutPageTemplateEntry> orderByComparator)
    • getLayoutPageTemplateEntries

      public static List<LayoutPageTemplateEntry> getLayoutPageTemplateEntries(long groupId, long layoutPageTemplateCollectionId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<LayoutPageTemplateEntry> orderByComparator)
    • getLayoutPageTemplateEntries

      public static List<LayoutPageTemplateEntry> getLayoutPageTemplateEntries(long groupId, long layoutPageTemplateCollectionId, String name, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<LayoutPageTemplateEntry> orderByComparator)
    • getLayoutPageTemplateEntries

      public static List<LayoutPageTemplateEntry> getLayoutPageTemplateEntries(long groupId, long layoutPageTemplateCollectionId, String name, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<LayoutPageTemplateEntry> orderByComparator)
    • getLayoutPageTemplateEntriesByLayoutPrototypeId

      public static List<LayoutPageTemplateEntry> getLayoutPageTemplateEntriesByLayoutPrototypeId(long layoutPrototypeId)
    • getLayoutPageTemplateEntriesByUuidAndCompanyId

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

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

      public static int getLayoutPageTemplateEntriesCount()
      Returns the number of layout page template entries.
      Returns:
      the number of layout page template entries
    • getLayoutPageTemplateEntry

      public static LayoutPageTemplateEntry getLayoutPageTemplateEntry(long layoutPageTemplateEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the layout page template entry with the primary key.
      Parameters:
      layoutPageTemplateEntryId - the primary key of the layout page template entry
      Returns:
      the layout page template entry
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a layout page template entry with the primary key could not be found
    • getLayoutPageTemplateEntry

      public static LayoutPageTemplateEntry getLayoutPageTemplateEntry(long groupId, String layoutPageTemplateEntryKey) throws NoSuchPageTemplateEntryException
      Throws:
      NoSuchPageTemplateEntryException
    • getLayoutPageTemplateEntryByExternalReferenceCode

      public static LayoutPageTemplateEntry getLayoutPageTemplateEntryByExternalReferenceCode(String externalReferenceCode, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getLayoutPageTemplateEntryByUuidAndGroupId

      public static LayoutPageTemplateEntry getLayoutPageTemplateEntryByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the layout page template entry matching the UUID and group.
      Parameters:
      uuid - the layout page template entry's UUID
      groupId - the primary key of the group
      Returns:
      the matching layout page template entry
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching layout page template 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
    • getUniqueLayoutPageTemplateEntryName

      public static String getUniqueLayoutPageTemplateEntryName(long groupId, long layoutPageTemplateCollectionId, String name, int type)
    • updateLayoutPageTemplateEntry

      public static LayoutPageTemplateEntry updateLayoutPageTemplateEntry(LayoutPageTemplateEntry layoutPageTemplateEntry)
      Updates the layout page template entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect LayoutPageTemplateEntryLocalServiceImpl 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:
      layoutPageTemplateEntry - the layout page template entry
      Returns:
      the layout page template entry that was updated
    • updateLayoutPageTemplateEntry

      public static LayoutPageTemplateEntry updateLayoutPageTemplateEntry(long layoutPageTemplateEntryId, boolean defaultTemplate) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateLayoutPageTemplateEntry

      public static LayoutPageTemplateEntry updateLayoutPageTemplateEntry(long layoutPageTemplateEntryId, long previewFileEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateLayoutPageTemplateEntry

      public static LayoutPageTemplateEntry updateLayoutPageTemplateEntry(long layoutPageTemplateEntryId, long classNameId, long classTypeId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateLayoutPageTemplateEntry

      public static LayoutPageTemplateEntry updateLayoutPageTemplateEntry(long userId, long layoutPageTemplateEntryId, String name, int status) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateLayoutPageTemplateEntry

      public static LayoutPageTemplateEntry updateLayoutPageTemplateEntry(long layoutPageTemplateEntryId, String name) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateStatus

      public static LayoutPageTemplateEntry updateStatus(long userId, long layoutPageTemplateEntryId, int status) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getService

      public static LayoutPageTemplateEntryLocalService getService()