Interface ObjectViewLocalService

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

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

    • addObjectView

      @Indexable(type=REINDEX) ObjectView addObjectView(long userId, long objectDefinitionId, boolean defaultObjectView, Map<Locale,String> nameMap, List<ObjectViewColumn> objectViewColumns, List<ObjectViewFilterColumn> objectViewFilterColumns, List<ObjectViewSortColumn> objectViewSortColumns) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addObjectView

      @Indexable(type=REINDEX) ObjectView addObjectView(ObjectView objectView)
      Adds the object view to the database. Also notifies the appropriate model listeners.

      Important: Inspect ObjectViewLocalServiceImpl 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:
      objectView - the object view
      Returns:
      the object view that was added
    • createObjectView

      @Transactional(enabled=false) ObjectView createObjectView(long objectViewId)
      Creates a new object view with the primary key. Does not add the object view to the database.
      Parameters:
      objectViewId - the primary key for the new object view
      Returns:
      the new object view
    • 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
    • deleteObjectView

      @Indexable(type=DELETE) ObjectView deleteObjectView(long objectViewId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the object view with the primary key from the database. Also notifies the appropriate model listeners.

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

      @Indexable(type=DELETE) @SystemEvent(type=1) ObjectView deleteObjectView(ObjectView objectView)
      Deletes the object view from the database. Also notifies the appropriate model listeners.

      Important: Inspect ObjectViewLocalServiceImpl 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:
      objectView - the object view
      Returns:
      the object view that was removed
    • deleteObjectViews

      void deleteObjectViews(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.ObjectViewModelImpl.

      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.ObjectViewModelImpl.

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

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectView fetchDefaultObjectView(long objectDefinitionId)
    • fetchObjectView

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectView fetchObjectView(long objectViewId)
    • fetchObjectViewByUuidAndCompanyId

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

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • 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()
    • getObjectView

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectView getObjectView(long objectViewId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the object view with the primary key.
      Parameters:
      objectViewId - the primary key of the object view
      Returns:
      the object view
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a object view with the primary key could not be found
    • getObjectViewByUuidAndCompanyId

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

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectView> getObjectViews(int start, int end)
      Returns a range of all the object views.

      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.ObjectViewModelImpl.

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

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectView> getObjectViews(long objectDefinitionId)
    • getObjectViewsCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getObjectViewsCount()
      Returns the number of object views.
      Returns:
      the number of object views
    • 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
    • unassociateObjectField

      void unassociateObjectField(ObjectField objectField)
    • updateObjectView

      @Indexable(type=REINDEX) ObjectView updateObjectView(long objectViewId, boolean defaultObjectView, Map<Locale,String> nameMap, List<ObjectViewColumn> objectViewColumns, List<ObjectViewFilterColumn> objectViewFilterColumns, List<ObjectViewSortColumn> objectViewSortColumns) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateObjectView

      @Indexable(type=REINDEX) ObjectView updateObjectView(ObjectView objectView)
      Updates the object view in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect ObjectViewLocalServiceImpl 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:
      objectView - the object view
      Returns:
      the object view that was updated