Object
com.liferay.portal.kernel.service.persistence.PortletUtil

public class PortletUtil extends Object
The persistence utility for the portlet service. This utility wraps com.liferay.portal.service.persistence.impl.PortletPersistenceImpl and provides direct access to the database for CRUD operations. This utility should only be used by the service layer, as it must operate within a transaction. Never access this utility in a JSP, controller, model, or other front-end class.

Caching information and settings can be found in portal.properties

Author:
Brian Wing Shun Chan
See Also:
{$generated.description}
  • Constructor Details

    • PortletUtil

      public PortletUtil()
  • Method Details

    • clearCache

      public static void clearCache()
      See Also:
    • clearCache

      public static void clearCache(Portlet portlet)
      See Also:
    • countWithDynamicQuery

      public static long countWithDynamicQuery(DynamicQuery dynamicQuery)
      See Also:
    • fetchByPrimaryKeys

      public static Map<Serializable,Portlet> fetchByPrimaryKeys(Set<Serializable> primaryKeys)
      See Also:
    • findWithDynamicQuery

      public static List<Portlet> findWithDynamicQuery(DynamicQuery dynamicQuery)
      See Also:
    • findWithDynamicQuery

      public static List<Portlet> findWithDynamicQuery(DynamicQuery dynamicQuery, int start, int end)
      See Also:
    • findWithDynamicQuery

      public static List<Portlet> findWithDynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<Portlet> orderByComparator)
      See Also:
    • update

      public static Portlet update(Portlet portlet)
      See Also:
    • update

      public static Portlet update(Portlet portlet, ServiceContext serviceContext)
      See Also:
    • findByCompanyId

      public static List<Portlet> findByCompanyId(long companyId)
      Returns all the portlets where companyId = ?.
      Parameters:
      companyId - the company ID
      Returns:
      the matching portlets
    • findByCompanyId

      public static List<Portlet> findByCompanyId(long companyId, int start, int end)
      Returns a range of all the portlets where companyId = ?.

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

      Parameters:
      companyId - the company ID
      start - the lower bound of the range of portlets
      end - the upper bound of the range of portlets (not inclusive)
      Returns:
      the range of matching portlets
    • findByCompanyId

      public static List<Portlet> findByCompanyId(long companyId, int start, int end, OrderByComparator<Portlet> orderByComparator)
      Returns an ordered range of all the portlets where companyId = ?.

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

      Parameters:
      companyId - the company ID
      start - the lower bound of the range of portlets
      end - the upper bound of the range of portlets (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the ordered range of matching portlets
    • findByCompanyId

      public static List<Portlet> findByCompanyId(long companyId, int start, int end, OrderByComparator<Portlet> orderByComparator, boolean useFinderCache)
      Returns an ordered range of all the portlets where companyId = ?.

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

      Parameters:
      companyId - the company ID
      start - the lower bound of the range of portlets
      end - the upper bound of the range of portlets (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      useFinderCache - whether to use the finder cache
      Returns:
      the ordered range of matching portlets
    • findByCompanyId_First

      public static Portlet findByCompanyId_First(long companyId, OrderByComparator<Portlet> orderByComparator) throws NoSuchPortletException
      Returns the first portlet in the ordered set where companyId = ?.
      Parameters:
      companyId - the company ID
      orderByComparator - the comparator to order the set by (optionally null)
      Returns:
      the first matching portlet
      Throws:
      NoSuchPortletException - if a matching portlet could not be found
      NoSuchPortletException
    • fetchByCompanyId_First

      public static Portlet fetchByCompanyId_First(long companyId, OrderByComparator<Portlet> orderByComparator)
      Returns the first portlet in the ordered set where companyId = ?.
      Parameters:
      companyId - the company ID
      orderByComparator - the comparator to order the set by (optionally null)
      Returns:
      the first matching portlet, or null if a matching portlet could not be found
    • findByCompanyId_Last

      public static Portlet findByCompanyId_Last(long companyId, OrderByComparator<Portlet> orderByComparator) throws NoSuchPortletException
      Returns the last portlet in the ordered set where companyId = ?.
      Parameters:
      companyId - the company ID
      orderByComparator - the comparator to order the set by (optionally null)
      Returns:
      the last matching portlet
      Throws:
      NoSuchPortletException - if a matching portlet could not be found
      NoSuchPortletException
    • fetchByCompanyId_Last

      public static Portlet fetchByCompanyId_Last(long companyId, OrderByComparator<Portlet> orderByComparator)
      Returns the last portlet in the ordered set where companyId = ?.
      Parameters:
      companyId - the company ID
      orderByComparator - the comparator to order the set by (optionally null)
      Returns:
      the last matching portlet, or null if a matching portlet could not be found
    • findByCompanyId_PrevAndNext

      public static Portlet[] findByCompanyId_PrevAndNext(long id, long companyId, OrderByComparator<Portlet> orderByComparator) throws NoSuchPortletException
      Returns the portlets before and after the current portlet in the ordered set where companyId = ?.
      Parameters:
      id - the primary key of the current portlet
      companyId - the company ID
      orderByComparator - the comparator to order the set by (optionally null)
      Returns:
      the previous, current, and next portlet
      Throws:
      NoSuchPortletException - if a portlet with the primary key could not be found
      NoSuchPortletException
    • removeByCompanyId

      public static void removeByCompanyId(long companyId)
      Removes all the portlets where companyId = ? from the database.
      Parameters:
      companyId - the company ID
    • countByCompanyId

      public static int countByCompanyId(long companyId)
      Returns the number of portlets where companyId = ?.
      Parameters:
      companyId - the company ID
      Returns:
      the number of matching portlets
    • findByC_P

      public static Portlet findByC_P(long companyId, String portletId) throws NoSuchPortletException
      Returns the portlet where companyId = ? and portletId = ? or throws a NoSuchPortletException if it could not be found.
      Parameters:
      companyId - the company ID
      portletId - the portlet ID
      Returns:
      the matching portlet
      Throws:
      NoSuchPortletException - if a matching portlet could not be found
      NoSuchPortletException
    • fetchByC_P

      public static Portlet fetchByC_P(long companyId, String portletId)
      Returns the portlet where companyId = ? and portletId = ? or returns null if it could not be found. Uses the finder cache.
      Parameters:
      companyId - the company ID
      portletId - the portlet ID
      Returns:
      the matching portlet, or null if a matching portlet could not be found
    • fetchByC_P

      public static Portlet fetchByC_P(long companyId, String portletId, boolean useFinderCache)
      Returns the portlet where companyId = ? and portletId = ? or returns null if it could not be found, optionally using the finder cache.
      Parameters:
      companyId - the company ID
      portletId - the portlet ID
      useFinderCache - whether to use the finder cache
      Returns:
      the matching portlet, or null if a matching portlet could not be found
    • removeByC_P

      public static Portlet removeByC_P(long companyId, String portletId) throws NoSuchPortletException
      Removes the portlet where companyId = ? and portletId = ? from the database.
      Parameters:
      companyId - the company ID
      portletId - the portlet ID
      Returns:
      the portlet that was removed
      Throws:
      NoSuchPortletException
    • countByC_P

      public static int countByC_P(long companyId, String portletId)
      Returns the number of portlets where companyId = ? and portletId = ?.
      Parameters:
      companyId - the company ID
      portletId - the portlet ID
      Returns:
      the number of matching portlets
    • cacheResult

      public static void cacheResult(Portlet portlet)
      Caches the portlet in the entity cache if it is enabled.
      Parameters:
      portlet - the portlet
    • cacheResult

      public static void cacheResult(List<Portlet> portlets)
      Caches the portlets in the entity cache if it is enabled.
      Parameters:
      portlets - the portlets
    • create

      public static Portlet create(long id)
      Creates a new portlet with the primary key. Does not add the portlet to the database.
      Parameters:
      id - the primary key for the new portlet
      Returns:
      the new portlet
    • remove

      public static Portlet remove(long id) throws NoSuchPortletException
      Removes the portlet with the primary key from the database. Also notifies the appropriate model listeners.
      Parameters:
      id - the primary key of the portlet
      Returns:
      the portlet that was removed
      Throws:
      NoSuchPortletException - if a portlet with the primary key could not be found
      NoSuchPortletException
    • updateImpl

      public static Portlet updateImpl(Portlet portlet)
    • findByPrimaryKey

      public static Portlet findByPrimaryKey(long id) throws NoSuchPortletException
      Returns the portlet with the primary key or throws a NoSuchPortletException if it could not be found.
      Parameters:
      id - the primary key of the portlet
      Returns:
      the portlet
      Throws:
      NoSuchPortletException - if a portlet with the primary key could not be found
      NoSuchPortletException
    • fetchByPrimaryKey

      public static Portlet fetchByPrimaryKey(long id)
      Returns the portlet with the primary key or returns null if it could not be found.
      Parameters:
      id - the primary key of the portlet
      Returns:
      the portlet, or null if a portlet with the primary key could not be found
    • findAll

      public static List<Portlet> findAll()
      Returns all the portlets.
      Returns:
      the portlets
    • findAll

      public static List<Portlet> findAll(int start, int end)
      Returns a range of all the portlets.

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

      Parameters:
      start - the lower bound of the range of portlets
      end - the upper bound of the range of portlets (not inclusive)
      Returns:
      the range of portlets
    • findAll

      public static List<Portlet> findAll(int start, int end, OrderByComparator<Portlet> orderByComparator)
      Returns an ordered range of all the portlets.

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

      Parameters:
      start - the lower bound of the range of portlets
      end - the upper bound of the range of portlets (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the ordered range of portlets
    • findAll

      public static List<Portlet> findAll(int start, int end, OrderByComparator<Portlet> orderByComparator, boolean useFinderCache)
      Returns an ordered range of all the portlets.

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

      Parameters:
      start - the lower bound of the range of portlets
      end - the upper bound of the range of portlets (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      useFinderCache - whether to use the finder cache
      Returns:
      the ordered range of portlets
    • removeAll

      public static void removeAll()
      Removes all the portlets from the database.
    • countAll

      public static int countAll()
      Returns the number of portlets.
      Returns:
      the number of portlets
    • getPersistence

      public static PortletPersistence getPersistence()
    • setPersistence

      public static void setPersistence(PortletPersistence persistence)