Interface PortletItemLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
PortletItemLocalServiceWrapper

Provides the local service interface for PortletItem. 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.
Author:
Brian Wing Shun Chan
See Also:
{$generated.description}
  • Method Details

    • addPortletItem

      PortletItem addPortletItem(long userId, long groupId, String name, String portletId, String className) throws PortalException
      Throws:
      PortalException
    • addPortletItem

      @Indexable(type=REINDEX) PortletItem addPortletItem(PortletItem portletItem)
      Adds the portlet item to the database. Also notifies the appropriate model listeners.

      Important: Inspect PortletItemLocalServiceImpl 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:
      portletItem - the portlet item
      Returns:
      the portlet item that was added
    • createPersistedModel

      PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
      Specified by:
      createPersistedModel in interface PersistedModelLocalService
      Throws:
      PortalException
    • createPortletItem

      @Transactional(enabled=false) PortletItem createPortletItem(long portletItemId)
      Creates a new portlet item with the primary key. Does not add the portlet item to the database.
      Parameters:
      portletItemId - the primary key for the new portlet item
      Returns:
      the new portlet item
    • deletePersistedModel

      PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
      Specified by:
      deletePersistedModel in interface PersistedModelLocalService
      Throws:
      PortalException
    • deletePortletItem

      @Indexable(type=DELETE) PortletItem deletePortletItem(long portletItemId) throws PortalException
      Deletes the portlet item with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect PortletItemLocalServiceImpl 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:
      portletItemId - the primary key of the portlet item
      Returns:
      the portlet item that was removed
      Throws:
      PortalException - if a portlet item with the primary key could not be found
    • deletePortletItem

      @Indexable(type=DELETE) PortletItem deletePortletItem(PortletItem portletItem)
      Deletes the portlet item from the database. Also notifies the appropriate model listeners.

      Important: Inspect PortletItemLocalServiceImpl 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:
      portletItem - the portlet item
      Returns:
      the portlet item that was removed
    • dslQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQuery in interface PersistedModelLocalService
    • dslQueryCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQueryCount in interface PersistedModelLocalService
    • dynamicQuery

    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(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(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.portal.model.impl.PortletItemModelImpl.

      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(DynamicQuery dynamicQuery, int start, int end, 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.portal.model.impl.PortletItemModelImpl.

      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(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(DynamicQuery dynamicQuery, 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
    • fetchPortletItem

      @Transactional(propagation=SUPPORTS, readOnly=true) PortletItem fetchPortletItem(long portletItemId)
    • getActionableDynamicQuery

    • getIndexableActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

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

      @Transactional(propagation=SUPPORTS, readOnly=true) PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
      Specified by:
      getPersistedModel in interface PersistedModelLocalService
      Throws:
      PortalException
    • getPortletItem

      @Transactional(propagation=SUPPORTS, readOnly=true) PortletItem getPortletItem(long portletItemId) throws PortalException
      Returns the portlet item with the primary key.
      Parameters:
      portletItemId - the primary key of the portlet item
      Returns:
      the portlet item
      Throws:
      PortalException - if a portlet item with the primary key could not be found
    • getPortletItem

      @Transactional(propagation=SUPPORTS, readOnly=true) PortletItem getPortletItem(long groupId, String name, String portletId, String className) throws PortalException
      Throws:
      PortalException
    • getPortletItems

      @Transactional(propagation=SUPPORTS, readOnly=true) List<PortletItem> getPortletItems(int start, int end)
      Returns a range of all the portlet items.

      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.portal.model.impl.PortletItemModelImpl.

      Parameters:
      start - the lower bound of the range of portlet items
      end - the upper bound of the range of portlet items (not inclusive)
      Returns:
      the range of portlet items
    • getPortletItems

      @Transactional(propagation=SUPPORTS, readOnly=true) List<PortletItem> getPortletItems(long groupId, String className)
    • getPortletItems

      @Transactional(propagation=SUPPORTS, readOnly=true) List<PortletItem> getPortletItems(long groupId, String portletId, String className)
    • getPortletItemsCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getPortletItemsCount()
      Returns the number of portlet items.
      Returns:
      the number of portlet items
    • updatePortletItem

      PortletItem updatePortletItem(long userId, long groupId, String name, String portletId, String className) throws PortalException
      Throws:
      PortalException
    • updatePortletItem

      @Indexable(type=REINDEX) PortletItem updatePortletItem(PortletItem portletItem)
      Updates the portlet item in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect PortletItemLocalServiceImpl 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:
      portletItem - the portlet item
      Returns:
      the portlet item that was updated