Interface CPDisplayLayoutLocalService

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

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

    • addCPDisplayLayout

      @Indexable(type=REINDEX) CPDisplayLayout addCPDisplayLayout(CPDisplayLayout cpDisplayLayout)
      Adds the cp display layout to the database. Also notifies the appropriate model listeners.

      Important: Inspect CPDisplayLayoutLocalServiceImpl 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:
      cpDisplayLayout - the cp display layout
      Returns:
      the cp display layout that was added
    • addCPDisplayLayout

      @Indexable(type=REINDEX) CPDisplayLayout addCPDisplayLayout(long userId, long groupId, Class<?> clazz, long classPK, String layoutPageTemplateEntryUuid, String layoutUuid) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createCPDisplayLayout

      @Transactional(enabled=false) CPDisplayLayout createCPDisplayLayout(long CPDisplayLayoutId)
      Creates a new cp display layout with the primary key. Does not add the cp display layout to the database.
      Parameters:
      CPDisplayLayoutId - the primary key for the new cp display layout
      Returns:
      the new cp display layout
    • 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
    • deleteCPDisplayLayout

      @Indexable(type=DELETE) CPDisplayLayout deleteCPDisplayLayout(Class<?> clazz, long classPK)
    • deleteCPDisplayLayout

      @Indexable(type=DELETE) CPDisplayLayout deleteCPDisplayLayout(CPDisplayLayout cpDisplayLayout)
      Deletes the cp display layout from the database. Also notifies the appropriate model listeners.

      Important: Inspect CPDisplayLayoutLocalServiceImpl 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:
      cpDisplayLayout - the cp display layout
      Returns:
      the cp display layout that was removed
    • deleteCPDisplayLayout

      @Indexable(type=DELETE) CPDisplayLayout deleteCPDisplayLayout(long CPDisplayLayoutId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the cp display layout with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect CPDisplayLayoutLocalServiceImpl 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:
      CPDisplayLayoutId - the primary key of the cp display layout
      Returns:
      the cp display layout that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a cp display layout with the primary key could not be found
    • deleteCPDisplayLayouts

      void deleteCPDisplayLayouts(Class<?> clazz, long classPK)
    • 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.commerce.product.model.impl.CPDisplayLayoutModelImpl.

      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.commerce.product.model.impl.CPDisplayLayoutModelImpl.

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

      @Transactional(propagation=SUPPORTS, readOnly=true) CPDisplayLayout fetchCPDisplayLayout(long CPDisplayLayoutId)
    • fetchCPDisplayLayout

      @Transactional(propagation=SUPPORTS, readOnly=true) CPDisplayLayout fetchCPDisplayLayout(long groupId, Class<?> clazz, long classPK)
    • fetchCPDisplayLayoutByUuidAndGroupId

      @Transactional(propagation=SUPPORTS, readOnly=true) CPDisplayLayout fetchCPDisplayLayoutByUuidAndGroupId(String uuid, long groupId)
      Returns the cp display layout matching the UUID and group.
      Parameters:
      uuid - the cp display layout's UUID
      groupId - the primary key of the group
      Returns:
      the matching cp display layout, or null if a matching cp display layout could not be found
    • getActionableDynamicQuery

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

      @Transactional(propagation=SUPPORTS, readOnly=true) CPDisplayLayout getCPDisplayLayout(long CPDisplayLayoutId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the cp display layout with the primary key.
      Parameters:
      CPDisplayLayoutId - the primary key of the cp display layout
      Returns:
      the cp display layout
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a cp display layout with the primary key could not be found
    • getCPDisplayLayoutByUuidAndGroupId

      @Transactional(propagation=SUPPORTS, readOnly=true) CPDisplayLayout getCPDisplayLayoutByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the cp display layout matching the UUID and group.
      Parameters:
      uuid - the cp display layout's UUID
      groupId - the primary key of the group
      Returns:
      the matching cp display layout
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching cp display layout could not be found
    • getCPDisplayLayouts

      @Transactional(propagation=SUPPORTS, readOnly=true) List<CPDisplayLayout> getCPDisplayLayouts(int start, int end)
      Returns a range of all the cp display layouts.

      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.commerce.product.model.impl.CPDisplayLayoutModelImpl.

      Parameters:
      start - the lower bound of the range of cp display layouts
      end - the upper bound of the range of cp display layouts (not inclusive)
      Returns:
      the range of cp display layouts
    • getCPDisplayLayoutsByGroupIdAndLayoutPageTemplateEntryUuid

      @Transactional(propagation=SUPPORTS, readOnly=true) List<CPDisplayLayout> getCPDisplayLayoutsByGroupIdAndLayoutPageTemplateEntryUuid(long groupId, String layoutPageTemplateEntryUuid)
    • getCPDisplayLayoutsByGroupIdAndLayoutPageTemplateEntryUuid

      @Transactional(propagation=SUPPORTS, readOnly=true) List<CPDisplayLayout> getCPDisplayLayoutsByGroupIdAndLayoutPageTemplateEntryUuid(long groupId, String layoutPageTemplateEntryUuid, int start, int end)
    • getCPDisplayLayoutsByGroupIdAndLayoutUuid

      @Transactional(propagation=SUPPORTS, readOnly=true) List<CPDisplayLayout> getCPDisplayLayoutsByGroupIdAndLayoutUuid(long groupId, String layoutUuid)
    • getCPDisplayLayoutsByGroupIdAndLayoutUuid

      @Transactional(propagation=SUPPORTS, readOnly=true) List<CPDisplayLayout> getCPDisplayLayoutsByGroupIdAndLayoutUuid(long groupId, String layoutUuid, int start, int end)
    • getCPDisplayLayoutsByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) List<CPDisplayLayout> getCPDisplayLayoutsByUuidAndCompanyId(String uuid, long companyId)
      Returns all the cp display layouts matching the UUID and company.
      Parameters:
      uuid - the UUID of the cp display layouts
      companyId - the primary key of the company
      Returns:
      the matching cp display layouts, or an empty list if no matches were found
    • getCPDisplayLayoutsByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) List<CPDisplayLayout> getCPDisplayLayoutsByUuidAndCompanyId(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CPDisplayLayout> orderByComparator)
      Returns a range of cp display layouts matching the UUID and company.
      Parameters:
      uuid - the UUID of the cp display layouts
      companyId - the primary key of the company
      start - the lower bound of the range of cp display layouts
      end - the upper bound of the range of cp display layouts (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the range of matching cp display layouts, or an empty list if no matches were found
    • getCPDisplayLayoutsCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getCPDisplayLayoutsCount()
      Returns the number of cp display layouts.
      Returns:
      the number of cp display layouts
    • 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()
    • 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
    • searchCPDisplayLayout

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.search.BaseModelSearchResult<CPDisplayLayout> searchCPDisplayLayout(long companyId, long groupId, String className, Integer type, String keywords, int start, int end, com.liferay.portal.kernel.search.Sort sort) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateCPDisplayLayout

      @Indexable(type=REINDEX) CPDisplayLayout updateCPDisplayLayout(CPDisplayLayout cpDisplayLayout)
      Updates the cp display layout in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect CPDisplayLayoutLocalServiceImpl 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:
      cpDisplayLayout - the cp display layout
      Returns:
      the cp display layout that was updated
    • updateCPDisplayLayout

      @Indexable(type=REINDEX) CPDisplayLayout updateCPDisplayLayout(long cpDisplayLayoutId, long classPK, String layoutPageTemplateEntryUuid, String layoutUuid) 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<CPDisplayLayout> getCTPersistence()
      Specified by:
      getCTPersistence in interface com.liferay.portal.kernel.service.change.tracking.CTService<CPDisplayLayout>
    • getModelClass

      @Transactional(enabled=false) Class<CPDisplayLayout> getModelClass()
      Specified by:
      getModelClass in interface com.liferay.portal.kernel.service.change.tracking.CTService<CPDisplayLayout>
    • 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<CPDisplayLayout>,R,E> updateUnsafeFunction) throws E
      Specified by:
      updateWithUnsafeFunction in interface com.liferay.portal.kernel.service.change.tracking.CTService<CPDisplayLayout>
      Throws:
      E extends Throwable