Class ObjectViewLocalServiceUtil

java.lang.Object
com.liferay.object.service.ObjectViewLocalServiceUtil

public class ObjectViewLocalServiceUtil extends Object
Provides the local service utility for ObjectView. This utility wraps com.liferay.object.service.impl.ObjectViewLocalServiceImpl and is an access point for service operations in application layer code running on the local server. 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:
  • Constructor Details

    • ObjectViewLocalServiceUtil

      public ObjectViewLocalServiceUtil()
  • Method Details

    • addObjectView

      public static 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

      public static 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

      public static 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

      public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteObjectView

      public static 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

      public static 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

      public static void deleteObjectViews(long objectDefinitionId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deletePersistedModel

      public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • dslQuery

      public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dslQueryCount

      public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dynamicQuery

      public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

      public static <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

      public static <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

      public static <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

      public static 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

      public static 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

      public static ObjectView fetchDefaultObjectView(long objectDefinitionId)
    • fetchObjectView

      public static ObjectView fetchObjectView(long objectViewId)
    • fetchObjectViewByUuidAndCompanyId

      public static 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

      public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • getExportActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
    • getIndexableActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getObjectView

      public static 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

      public static 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

      public static 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

      public static List<ObjectView> getObjectViews(long objectDefinitionId)
    • getObjectViewsCount

      public static int getObjectViewsCount()
      Returns the number of object views.
      Returns:
      the number of object views
    • getOSGiServiceIdentifier

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

      public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • unassociateObjectField

      public static void unassociateObjectField(ObjectField objectField)
    • updateObjectView

      public static 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

      public static 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
    • getService

      public static ObjectViewLocalService getService()