Interface LayoutUtilityPageEntryLocalService

All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.change.tracking.CTService<LayoutUtilityPageEntry>, com.liferay.portal.kernel.service.PersistedModelLocalService
All Known Implementing Classes:
LayoutUtilityPageEntryLocalServiceWrapper

@CTAware @ProviderType @Transactional(isolation=PORTAL, rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class}) public interface LayoutUtilityPageEntryLocalService extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.change.tracking.CTService<LayoutUtilityPageEntry>, com.liferay.portal.kernel.service.PersistedModelLocalService
Provides the local service interface for LayoutUtilityPageEntry. 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:
  • Method Details

    • addLayoutUtilityPageEntry

      @Indexable(type=REINDEX) 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

      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

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

      @Transactional(enabled=false) 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

      com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      createPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteLayoutUtilityPageEntry

      @Indexable(type=DELETE) @SystemEvent(type=1) 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

      @Indexable(type=DELETE) 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

      LayoutUtilityPageEntry deleteLayoutUtilityPageEntry(String externalReferenceCode, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deletePersistedModel

      com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • dslQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQuery in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dslQueryCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQueryCount in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <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

      @Transactional(propagation=SUPPORTS, readOnly=true) <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

      @Transactional(propagation=SUPPORTS, readOnly=true) <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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) LayoutUtilityPageEntry fetchDefaultLayoutUtilityPageEntry(long groupId, String type)
    • fetchLayoutUtilityPageEntry

      @Transactional(propagation=SUPPORTS, readOnly=true) LayoutUtilityPageEntry fetchLayoutUtilityPageEntry(long LayoutUtilityPageEntryId)
    • fetchLayoutUtilityPageEntry

      @Transactional(propagation=SUPPORTS, readOnly=true) LayoutUtilityPageEntry fetchLayoutUtilityPageEntry(long groupId, String name, String type)
    • fetchLayoutUtilityPageEntryByExternalReferenceCode

      @Transactional(propagation=SUPPORTS, readOnly=true) LayoutUtilityPageEntry fetchLayoutUtilityPageEntryByExternalReferenceCode(String externalReferenceCode, long groupId)
    • fetchLayoutUtilityPageEntryByPlid

      @Transactional(propagation=SUPPORTS, readOnly=true) LayoutUtilityPageEntry fetchLayoutUtilityPageEntryByPlid(long plid)
    • fetchLayoutUtilityPageEntryByUuidAndGroupId

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • getDefaultLayoutUtilityPageEntry

      @Transactional(propagation=SUPPORTS, readOnly=true) LayoutUtilityPageEntry getDefaultLayoutUtilityPageEntry(long groupId, String type) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getExportActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
    • getIndexableActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getLayoutUtilityPageEntries

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) List<LayoutUtilityPageEntry> getLayoutUtilityPageEntries(long groupId)
    • getLayoutUtilityPageEntries

      @Transactional(propagation=SUPPORTS, readOnly=true) List<LayoutUtilityPageEntry> getLayoutUtilityPageEntries(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<LayoutUtilityPageEntry> orderByComparator)
    • getLayoutUtilityPageEntries

      @Transactional(propagation=SUPPORTS, readOnly=true) List<LayoutUtilityPageEntry> getLayoutUtilityPageEntries(long groupId, String type, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<LayoutUtilityPageEntry> orderByComparator)
    • getLayoutUtilityPageEntries

      @Transactional(propagation=SUPPORTS, readOnly=true) List<LayoutUtilityPageEntry> getLayoutUtilityPageEntries(long groupId, String keyword, String[] types, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<LayoutUtilityPageEntry> orderByComparator)
    • getLayoutUtilityPageEntries

      @Transactional(propagation=SUPPORTS, readOnly=true) List<LayoutUtilityPageEntry> getLayoutUtilityPageEntries(long groupId, String[] types, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<LayoutUtilityPageEntry> orderByComparator)
    • getLayoutUtilityPageEntriesByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) int getLayoutUtilityPageEntriesCount()
      Returns the number of layout utility page entries.
      Returns:
      the number of layout utility page entries
    • getLayoutUtilityPageEntriesCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getLayoutUtilityPageEntriesCount(long groupId)
    • getLayoutUtilityPageEntriesCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getLayoutUtilityPageEntriesCount(long groupId, String keyword, String[] types)
    • getLayoutUtilityPageEntriesCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getLayoutUtilityPageEntriesCount(long groupId, String[] types)
    • getLayoutUtilityPageEntry

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) LayoutUtilityPageEntry getLayoutUtilityPageEntryByExternalReferenceCode(String externalReferenceCode, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getLayoutUtilityPageEntryByUuidAndGroupId

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • getPersistedModel

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • setDefaultLayoutUtilityPageEntry

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

      @Indexable(type=REINDEX) 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

      LayoutUtilityPageEntry updateLayoutUtilityPageEntry(long layoutUtilityPageEntryId, long previewFileEntryId)
    • updateLayoutUtilityPageEntry

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

      @Transactional(enabled=false) com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<LayoutUtilityPageEntry> getCTPersistence()
      Specified by:
      getCTPersistence in interface com.liferay.portal.kernel.service.change.tracking.CTService<LayoutUtilityPageEntry>
    • getModelClass

      @Transactional(enabled=false) Class<LayoutUtilityPageEntry> getModelClass()
      Specified by:
      getModelClass in interface com.liferay.portal.kernel.service.change.tracking.CTService<LayoutUtilityPageEntry>
    • updateWithUnsafeFunction

      @Transactional(rollbackFor=java.lang.Throwable.class) <R, E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<LayoutUtilityPageEntry>,R,E> updateUnsafeFunction) throws E
      Specified by:
      updateWithUnsafeFunction in interface com.liferay.portal.kernel.service.change.tracking.CTService<LayoutUtilityPageEntry>
      Throws:
      E extends Throwable