Class PortletItemLocalServiceUtil

Object
com.liferay.portal.kernel.service.PortletItemLocalServiceUtil

public class PortletItemLocalServiceUtil extends Object
Provides the local service utility for PortletItem. This utility wraps com.liferay.portal.service.impl.PortletItemLocalServiceImpl 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.
Author:
Brian Wing Shun Chan
See Also:
{$generated.description}
  • Constructor Details

    • PortletItemLocalServiceUtil

      public PortletItemLocalServiceUtil()
  • Method Details

    • addPortletItem

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

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

      public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
      Throws:
      PortalException
    • createPortletItem

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

      public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
      Throws:
      PortalException
    • deletePortletItem

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

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

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

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

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

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

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

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

      public static PortletItem fetchPortletItem(long portletItemId)
    • getActionableDynamicQuery

      public static ActionableDynamicQuery getActionableDynamicQuery()
    • getIndexableActionableDynamicQuery

      public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

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

      public static PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
      Throws:
      PortalException
    • getPortletItem

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

      public static PortletItem getPortletItem(long groupId, String name, String portletId, String className) throws PortalException
      Throws:
      PortalException
    • getPortletItems

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

      public static List<PortletItem> getPortletItems(long groupId, String className)
    • getPortletItems

      public static List<PortletItem> getPortletItems(long groupId, String portletId, String className)
    • getPortletItemsCount

      public static int getPortletItemsCount()
      Returns the number of portlet items.
      Returns:
      the number of portlet items
    • updatePortletItem

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

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

      public static PortletItemLocalService getService()
    • setService

      public static void setService(PortletItemLocalService service)