Class LayoutUtilityPageEntryLocalServiceUtil

java.lang.Object
com.liferay.layout.utility.page.service.LayoutUtilityPageEntryLocalServiceUtil

public class LayoutUtilityPageEntryLocalServiceUtil extends Object
Provides the local service utility for LayoutUtilityPageEntry. This utility wraps com.liferay.layout.utility.page.service.impl.LayoutUtilityPageEntryLocalServiceImpl 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

    • LayoutUtilityPageEntryLocalServiceUtil

      public LayoutUtilityPageEntryLocalServiceUtil()
  • Method Details

    • addLayoutUtilityPageEntry

      public static LayoutUtilityPageEntry addLayoutUtilityPageEntry(LayoutUtilityPageEntry layoutUtilityPageEntry)
      Adds the layout utility page entry to the database. Also notifies the appropriate model listeners.

      Important: Inspect LayoutUtilityPageEntryLocalServiceImpl 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:
      layoutUtilityPageEntry - the layout utility page entry
      Returns:
      the layout utility page entry that was added
    • addLayoutUtilityPageEntry

      public static LayoutUtilityPageEntry addLayoutUtilityPageEntry(String externalReferenceCode, long userId, long groupId, long plid, long previewFileEntryId, boolean defaultLayoutUtilityPageEntry, String name, String type, long masterLayoutPlid, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • copyLayoutUtilityPageEntry

      public static LayoutUtilityPageEntry copyLayoutUtilityPageEntry(long userId, long groupId, long sourceLayoutUtilityPageEntryId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws Exception
      Throws:
      Exception
    • createLayoutUtilityPageEntry

      public static LayoutUtilityPageEntry createLayoutUtilityPageEntry(long LayoutUtilityPageEntryId)
      Creates a new layout utility page entry with the primary key. Does not add the layout utility page entry to the database.
      Parameters:
      LayoutUtilityPageEntryId - the primary key for the new layout utility page entry
      Returns:
      the new layout utility page 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
    • deleteLayoutUtilityPageEntry

      public static LayoutUtilityPageEntry deleteLayoutUtilityPageEntry(LayoutUtilityPageEntry layoutUtilityPageEntry) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the layout utility page entry from the database. Also notifies the appropriate model listeners.

      Important: Inspect LayoutUtilityPageEntryLocalServiceImpl 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:
      layoutUtilityPageEntry - the layout utility page entry
      Returns:
      the layout utility page entry that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteLayoutUtilityPageEntry

      public static LayoutUtilityPageEntry deleteLayoutUtilityPageEntry(long LayoutUtilityPageEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the layout utility page entry with the primary key from the database. Also notifies the appropriate model listeners.

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

      public static LayoutUtilityPageEntry deleteLayoutUtilityPageEntry(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.utility.page.model.impl.LayoutUtilityPageEntryModelImpl.

      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.utility.page.model.impl.LayoutUtilityPageEntryModelImpl.

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

      public static LayoutUtilityPageEntry fetchDefaultLayoutUtilityPageEntry(long groupId, String type)
    • fetchLayoutUtilityPageEntry

      public static LayoutUtilityPageEntry fetchLayoutUtilityPageEntry(long LayoutUtilityPageEntryId)
    • fetchLayoutUtilityPageEntry

      public static LayoutUtilityPageEntry fetchLayoutUtilityPageEntry(long groupId, String name, String type)
    • fetchLayoutUtilityPageEntryByExternalReferenceCode

      public static LayoutUtilityPageEntry fetchLayoutUtilityPageEntryByExternalReferenceCode(String externalReferenceCode, long groupId)
    • fetchLayoutUtilityPageEntryByPlid

      public static LayoutUtilityPageEntry fetchLayoutUtilityPageEntryByPlid(long plid)
    • fetchLayoutUtilityPageEntryByUuidAndGroupId

      public static LayoutUtilityPageEntry fetchLayoutUtilityPageEntryByUuidAndGroupId(String uuid, long groupId)
      Returns the layout utility page entry matching the UUID and group.
      Parameters:
      uuid - the layout utility page entry's UUID
      groupId - the primary key of the group
      Returns:
      the matching layout utility page entry, or null if a matching layout utility page entry could not be found
    • getActionableDynamicQuery

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

      public static LayoutUtilityPageEntry getDefaultLayoutUtilityPageEntry(long groupId, String type) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • 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()
    • getLayoutUtilityPageEntries

      public static List<LayoutUtilityPageEntry> getLayoutUtilityPageEntries(int start, int end)
      Returns a range of all the layout utility page 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.utility.page.model.impl.LayoutUtilityPageEntryModelImpl.

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

      public static List<LayoutUtilityPageEntry> getLayoutUtilityPageEntries(long groupId)
    • getLayoutUtilityPageEntries

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

      public static List<LayoutUtilityPageEntry> getLayoutUtilityPageEntries(long groupId, String type, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<LayoutUtilityPageEntry> orderByComparator)
    • getLayoutUtilityPageEntries

      public static List<LayoutUtilityPageEntry> getLayoutUtilityPageEntries(long groupId, String keyword, String[] types, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<LayoutUtilityPageEntry> orderByComparator)
    • getLayoutUtilityPageEntries

      public static List<LayoutUtilityPageEntry> getLayoutUtilityPageEntries(long groupId, String[] types, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<LayoutUtilityPageEntry> orderByComparator)
    • getLayoutUtilityPageEntriesByUuidAndCompanyId

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

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

      public static int getLayoutUtilityPageEntriesCount()
      Returns the number of layout utility page entries.
      Returns:
      the number of layout utility page entries
    • getLayoutUtilityPageEntriesCount

      public static int getLayoutUtilityPageEntriesCount(long groupId)
    • getLayoutUtilityPageEntriesCount

      public static int getLayoutUtilityPageEntriesCount(long groupId, String keyword, String[] types)
    • getLayoutUtilityPageEntriesCount

      public static int getLayoutUtilityPageEntriesCount(long groupId, String[] types)
    • getLayoutUtilityPageEntry

      public static LayoutUtilityPageEntry getLayoutUtilityPageEntry(long LayoutUtilityPageEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the layout utility page entry with the primary key.
      Parameters:
      LayoutUtilityPageEntryId - the primary key of the layout utility page entry
      Returns:
      the layout utility page entry
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a layout utility page entry with the primary key could not be found
    • getLayoutUtilityPageEntryByExternalReferenceCode

      public static LayoutUtilityPageEntry getLayoutUtilityPageEntryByExternalReferenceCode(String externalReferenceCode, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getLayoutUtilityPageEntryByUuidAndGroupId

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

      public static LayoutUtilityPageEntry setDefaultLayoutUtilityPageEntry(long layoutUtilityPageEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateLayoutUtilityPageEntry

      public static LayoutUtilityPageEntry updateLayoutUtilityPageEntry(LayoutUtilityPageEntry layoutUtilityPageEntry)
      Updates the layout utility page entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect LayoutUtilityPageEntryLocalServiceImpl 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:
      layoutUtilityPageEntry - the layout utility page entry
      Returns:
      the layout utility page entry that was updated
    • updateLayoutUtilityPageEntry

      public static LayoutUtilityPageEntry updateLayoutUtilityPageEntry(long layoutUtilityPageEntryId, long previewFileEntryId)
    • updateLayoutUtilityPageEntry

      public static LayoutUtilityPageEntry updateLayoutUtilityPageEntry(long layoutUtilityPageEntryId, String name) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getService

      public static LayoutUtilityPageEntryLocalService getService()