Interface DDMStructureLayoutLocalService

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

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

    • addDDMStructureLayout

      @Indexable(type=REINDEX) DDMStructureLayout addDDMStructureLayout(DDMStructureLayout ddmStructureLayout)
      Adds the ddm structure layout to the database. Also notifies the appropriate model listeners.

      Important: Inspect DDMStructureLayoutLocalServiceImpl 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:
      ddmStructureLayout - the ddm structure layout
      Returns:
      the ddm structure layout that was added
    • addStructureLayout

      @Deprecated DDMStructureLayout addStructureLayout(long userId, long groupId, long structureVersionId, DDMFormLayout ddmFormLayout, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addStructureLayout

      DDMStructureLayout addStructureLayout(long userId, long groupId, long classNameId, String structureLayoutKey, long structureVersionId, DDMFormLayout ddmFormLayout, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addStructureLayout

      @Indexable(type=REINDEX) DDMStructureLayout addStructureLayout(long userId, long groupId, long classNameId, String structureLayoutKey, long structureVersionId, Map<Locale,String> name, Map<Locale,String> description, String definition, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createDDMStructureLayout

      @Transactional(enabled=false) DDMStructureLayout createDDMStructureLayout(long structureLayoutId)
      Creates a new ddm structure layout with the primary key. Does not add the ddm structure layout to the database.
      Parameters:
      structureLayoutId - the primary key for the new ddm structure layout
      Returns:
      the new ddm structure 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
    • deleteDDMStructureLayout

      @Indexable(type=DELETE) DDMStructureLayout deleteDDMStructureLayout(DDMStructureLayout ddmStructureLayout)
      Deletes the ddm structure layout from the database. Also notifies the appropriate model listeners.

      Important: Inspect DDMStructureLayoutLocalServiceImpl 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:
      ddmStructureLayout - the ddm structure layout
      Returns:
      the ddm structure layout that was removed
    • deleteDDMStructureLayout

      @Indexable(type=DELETE) DDMStructureLayout deleteDDMStructureLayout(long structureLayoutId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the ddm structure layout with the primary key from the database. Also notifies the appropriate model listeners.

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

      void deleteDDMStructureLayouts(long classNameId, DDMStructureVersion ddmStructureVersion) 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
    • deleteStructureLayout

      @SystemEvent(type=1) void deleteStructureLayout(DDMStructureLayout structureLayout)
    • deleteStructureLayout

      void deleteStructureLayout(long structureLayoutId) throws com.liferay.portal.kernel.exception.PortalException
      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.dynamic.data.mapping.model.impl.DDMStructureLayoutModelImpl.

      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.dynamic.data.mapping.model.impl.DDMStructureLayoutModelImpl.

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

      @Transactional(propagation=SUPPORTS, readOnly=true) DDMStructureLayout fetchDDMStructureLayout(long structureLayoutId)
    • fetchDDMStructureLayoutByUuidAndGroupId

      @Transactional(propagation=SUPPORTS, readOnly=true) DDMStructureLayout fetchDDMStructureLayoutByUuidAndGroupId(String uuid, long groupId)
      Returns the ddm structure layout matching the UUID and group.
      Parameters:
      uuid - the ddm structure layout's UUID
      groupId - the primary key of the group
      Returns:
      the matching ddm structure layout, or null if a matching ddm structure layout could not be found
    • fetchStructureLayout

      @Transactional(propagation=SUPPORTS, readOnly=true) DDMStructureLayout fetchStructureLayout(long structureLayoutId)
    • fetchStructureLayout

      @Transactional(propagation=SUPPORTS, readOnly=true) DDMStructureLayout fetchStructureLayout(long groupId, long classNameId, String structureLayoutKey)
    • getActionableDynamicQuery

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

      @Transactional(propagation=SUPPORTS, readOnly=true) DDMStructureLayout getDDMStructureLayout(long structureLayoutId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the ddm structure layout with the primary key.
      Parameters:
      structureLayoutId - the primary key of the ddm structure layout
      Returns:
      the ddm structure layout
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a ddm structure layout with the primary key could not be found
    • getDDMStructureLayoutByUuidAndGroupId

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

      @Transactional(propagation=SUPPORTS, readOnly=true) List<DDMStructureLayout> getDDMStructureLayouts(int start, int end)
      Returns a range of all the ddm structure 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.dynamic.data.mapping.model.impl.DDMStructureLayoutModelImpl.

      Parameters:
      start - the lower bound of the range of ddm structure layouts
      end - the upper bound of the range of ddm structure layouts (not inclusive)
      Returns:
      the range of ddm structure layouts
    • getDDMStructureLayoutsByUuidAndCompanyId

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

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

      @Transactional(propagation=SUPPORTS, readOnly=true) int getDDMStructureLayoutsCount()
      Returns the number of ddm structure layouts.
      Returns:
      the number of ddm structure 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
    • getStructureLayout

      @Transactional(propagation=SUPPORTS, readOnly=true) DDMStructureLayout getStructureLayout(long structureLayoutId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getStructureLayout

      @Transactional(propagation=SUPPORTS, readOnly=true) DDMStructureLayout getStructureLayout(long groupId, long classNameId, String structureLayoutKey) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getStructureLayoutByStructureVersionId

      @Transactional(propagation=SUPPORTS, readOnly=true) DDMStructureLayout getStructureLayoutByStructureVersionId(long structureVersionId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getStructureLayoutDDMFormLayout

      @Transactional(propagation=SUPPORTS, readOnly=true) DDMFormLayout getStructureLayoutDDMFormLayout(DDMStructureLayout structureLayout)
    • getStructureLayouts

      @Transactional(propagation=SUPPORTS, readOnly=true) List<DDMStructureLayout> getStructureLayouts(long groupId, int start, int end) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getStructureLayouts

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

      @Transactional(propagation=SUPPORTS, readOnly=true) List<DDMStructureLayout> getStructureLayouts(long groupId, long classNameId, long structureVersionId)
    • getStructureLayouts

      @Transactional(propagation=SUPPORTS, readOnly=true) List<DDMStructureLayout> getStructureLayouts(long groupId, long classNameId, long structureVersionId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructureLayout> orderByComparator)
    • getStructureLayoutsCount

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

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

      @Transactional(propagation=SUPPORTS, readOnly=true) int getStructureLayoutsCount(long groupId, long classNameId, long structureVersionId)
    • search

      @Transactional(propagation=SUPPORTS, readOnly=true) List<DDMStructureLayout> search(long companyId, long[] groupIds, long classNameId, String keywords, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructureLayout> orderByComparator) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • searchCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int searchCount(long companyId, long[] groupIds, long classNameId, String keywords) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateDDMStructureLayout

      @Indexable(type=REINDEX) DDMStructureLayout updateDDMStructureLayout(DDMStructureLayout ddmStructureLayout)
      Updates the ddm structure layout in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect DDMStructureLayoutLocalServiceImpl 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:
      ddmStructureLayout - the ddm structure layout
      Returns:
      the ddm structure layout that was updated
    • updateStructureLayout

      DDMStructureLayout updateStructureLayout(long structureLayoutId, DDMFormLayout ddmFormLayout, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateStructureLayout

      @Indexable(type=REINDEX) DDMStructureLayout updateStructureLayout(long structureLayoutId, long structureVersionId, Map<Locale,String> name, Map<Locale,String> description, String definition, com.liferay.portal.kernel.service.ServiceContext serviceContext) 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<DDMStructureLayout> getCTPersistence()
      Specified by:
      getCTPersistence in interface com.liferay.portal.kernel.service.change.tracking.CTService<DDMStructureLayout>
    • getModelClass

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