Class LayoutPageTemplateStructureLocalServiceUtil

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

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

    • LayoutPageTemplateStructureLocalServiceUtil

      public LayoutPageTemplateStructureLocalServiceUtil()
  • Method Details

    • addLayoutPageTemplateStructure

      public static LayoutPageTemplateStructure addLayoutPageTemplateStructure(LayoutPageTemplateStructure layoutPageTemplateStructure)
      Adds the layout page template structure to the database. Also notifies the appropriate model listeners.

      Important: Inspect LayoutPageTemplateStructureLocalServiceImpl 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:
      layoutPageTemplateStructure - the layout page template structure
      Returns:
      the layout page template structure that was added
    • addLayoutPageTemplateStructure

      public static LayoutPageTemplateStructure addLayoutPageTemplateStructure(long userId, long groupId, long plid, long segmentsExperienceId, String data, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createLayoutPageTemplateStructure

      public static LayoutPageTemplateStructure createLayoutPageTemplateStructure(long layoutPageTemplateStructureId)
      Creates a new layout page template structure with the primary key. Does not add the layout page template structure to the database.
      Parameters:
      layoutPageTemplateStructureId - the primary key for the new layout page template structure
      Returns:
      the new layout page template structure
    • 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
    • deleteLayoutPageTemplateStructure

      public static LayoutPageTemplateStructure deleteLayoutPageTemplateStructure(LayoutPageTemplateStructure layoutPageTemplateStructure)
      Deletes the layout page template structure from the database. Also notifies the appropriate model listeners.

      Important: Inspect LayoutPageTemplateStructureLocalServiceImpl 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:
      layoutPageTemplateStructure - the layout page template structure
      Returns:
      the layout page template structure that was removed
    • deleteLayoutPageTemplateStructure

      public static LayoutPageTemplateStructure deleteLayoutPageTemplateStructure(long layoutPageTemplateStructureId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the layout page template structure with the primary key from the database. Also notifies the appropriate model listeners.

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

      public static LayoutPageTemplateStructure deleteLayoutPageTemplateStructure(long groupId, long plid) 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.LayoutPageTemplateStructureModelImpl.

      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.LayoutPageTemplateStructureModelImpl.

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

      public static LayoutPageTemplateStructure fetchLayoutPageTemplateStructure(long layoutPageTemplateStructureId)
    • fetchLayoutPageTemplateStructure

      public static LayoutPageTemplateStructure fetchLayoutPageTemplateStructure(long groupId, long plid)
    • fetchLayoutPageTemplateStructureByUuidAndGroupId

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

      public static LayoutPageTemplateStructure getLayoutPageTemplateStructure(long layoutPageTemplateStructureId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the layout page template structure with the primary key.
      Parameters:
      layoutPageTemplateStructureId - the primary key of the layout page template structure
      Returns:
      the layout page template structure
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a layout page template structure with the primary key could not be found
    • getLayoutPageTemplateStructureByUuidAndGroupId

      public static LayoutPageTemplateStructure getLayoutPageTemplateStructureByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the layout page template structure matching the UUID and group.
      Parameters:
      uuid - the layout page template structure's UUID
      groupId - the primary key of the group
      Returns:
      the matching layout page template structure
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching layout page template structure could not be found
    • getLayoutPageTemplateStructures

      public static List<LayoutPageTemplateStructure> getLayoutPageTemplateStructures(int start, int end)
      Returns a range of all the layout page template structures.

      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.LayoutPageTemplateStructureModelImpl.

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

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

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

      public static int getLayoutPageTemplateStructuresCount()
      Returns the number of layout page template structures.
      Returns:
      the number of layout page template structures
    • 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
    • updateLayoutPageTemplateStructure

      public static LayoutPageTemplateStructure updateLayoutPageTemplateStructure(LayoutPageTemplateStructure layoutPageTemplateStructure)
      Updates the layout page template structure in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect LayoutPageTemplateStructureLocalServiceImpl 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:
      layoutPageTemplateStructure - the layout page template structure
      Returns:
      the layout page template structure that was updated
    • updateLayoutPageTemplateStructureData

      public static LayoutPageTemplateStructure updateLayoutPageTemplateStructureData(long groupId, long plid, long segmentsExperienceId, String data) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateLayoutPageTemplateStructureData

      public static LayoutPageTemplateStructure updateLayoutPageTemplateStructureData(long groupId, long plid, String data) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getService

      public static LayoutPageTemplateStructureLocalService getService()