Interface ObjectLayoutLocalService

All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService
All Known Implementing Classes:
ObjectLayoutLocalServiceWrapper

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

    • addObjectLayout

      @Indexable(type=REINDEX) ObjectLayout addObjectLayout(long userId, long objectDefinitionId, boolean defaultObjectLayout, Map<Locale,String> nameMap, List<ObjectLayoutTab> objectLayoutTabs) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addObjectLayout

      @Indexable(type=REINDEX) ObjectLayout addObjectLayout(ObjectLayout objectLayout)
      Adds the object layout to the database. Also notifies the appropriate model listeners.

      Important: Inspect ObjectLayoutLocalServiceImpl 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:
      objectLayout - the object layout
      Returns:
      the object layout that was added
    • createObjectLayout

      @Transactional(enabled=false) ObjectLayout createObjectLayout(long objectLayoutId)
      Creates a new object layout with the primary key. Does not add the object layout to the database.
      Parameters:
      objectLayoutId - the primary key for the new object layout
      Returns:
      the new object 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
    • deleteObjectLayout

      @Indexable(type=DELETE) ObjectLayout deleteObjectLayout(long objectLayoutId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the object layout with the primary key from the database. Also notifies the appropriate model listeners.

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

      @Indexable(type=DELETE) @SystemEvent(type=1) ObjectLayout deleteObjectLayout(ObjectLayout objectLayout) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the object layout from the database. Also notifies the appropriate model listeners.

      Important: Inspect ObjectLayoutLocalServiceImpl 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:
      objectLayout - the object layout
      Returns:
      the object layout that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteObjectLayouts

      void deleteObjectLayouts(long objectDefinitionId) 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.object.model.impl.ObjectLayoutModelImpl.

      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.object.model.impl.ObjectLayoutModelImpl.

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

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectLayout fetchDefaultObjectLayout(long objectDefinitionId)
    • fetchObjectLayout

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectLayout fetchObjectLayout(long objectLayoutId)
    • fetchObjectLayoutByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectLayout fetchObjectLayoutByUuidAndCompanyId(String uuid, long companyId)
      Returns the object layout with the matching UUID and company.
      Parameters:
      uuid - the object layout's UUID
      companyId - the primary key of the company
      Returns:
      the matching object layout, or null if a matching object layout could not be found
    • getActionableDynamicQuery

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

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectLayout getDefaultObjectLayout(long objectDefinitionId) 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()
    • getObjectLayout

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectLayout getObjectLayout(long objectLayoutId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the object layout with the primary key.
      Parameters:
      objectLayoutId - the primary key of the object layout
      Returns:
      the object layout
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a object layout with the primary key could not be found
    • getObjectLayoutByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectLayout getObjectLayoutByUuidAndCompanyId(String uuid, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the object layout with the matching UUID and company.
      Parameters:
      uuid - the object layout's UUID
      companyId - the primary key of the company
      Returns:
      the matching object layout
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching object layout could not be found
    • getObjectLayouts

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectLayout> getObjectLayouts(int start, int end)
      Returns a range of all the object 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.object.model.impl.ObjectLayoutModelImpl.

      Parameters:
      start - the lower bound of the range of object layouts
      end - the upper bound of the range of object layouts (not inclusive)
      Returns:
      the range of object layouts
    • getObjectLayouts

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectLayout> getObjectLayouts(long objectDefinitionId)
    • getObjectLayouts

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectLayout> getObjectLayouts(long objectDefinitionId, int start, int end)
    • getObjectLayoutsCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getObjectLayoutsCount()
      Returns the number of object layouts.
      Returns:
      the number of object layouts
    • getObjectLayoutsCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getObjectLayoutsCount(long objectDefinitionId)
    • getObjectLayoutsMap

      @Transactional(propagation=SUPPORTS, readOnly=true) Map<Long,List<ObjectLayout>> getObjectLayoutsMap(long companyId)
    • 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
    • updateObjectLayout

      @Indexable(type=REINDEX) ObjectLayout updateObjectLayout(long objectLayoutId, boolean defaultObjectLayout, Map<Locale,String> nameMap, List<ObjectLayoutTab> objectLayoutTabs) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateObjectLayout

      @Indexable(type=REINDEX) ObjectLayout updateObjectLayout(ObjectLayout objectLayout)
      Updates the object layout in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect ObjectLayoutLocalServiceImpl 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:
      objectLayout - the object layout
      Returns:
      the object layout that was updated