Class PortalPreferencesUtil

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

public class PortalPreferencesUtil extends Object
The persistence utility for the portal preferences service. This utility wraps com.liferay.portal.service.persistence.impl.PortalPreferencesPersistenceImpl 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

    • PortalPreferencesUtil

      public PortalPreferencesUtil()
  • Method Details

    • clearCache

      public static void clearCache()
      See Also:
    • clearCache

      public static void clearCache(PortalPreferences portalPreferences)
      See Also:
    • countWithDynamicQuery

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

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

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

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

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

      public static PortalPreferences update(PortalPreferences portalPreferences)
      See Also:
    • update

      public static PortalPreferences update(PortalPreferences portalPreferences, ServiceContext serviceContext)
      See Also:
    • findByOwnerType

      public static List<PortalPreferences> findByOwnerType(int ownerType)
      Returns all the portal preferenceses where ownerType = ?.
      Parameters:
      ownerType - the owner type
      Returns:
      the matching portal preferenceses
    • findByOwnerType

      public static List<PortalPreferences> findByOwnerType(int ownerType, int start, int end)
      Returns a range of all the portal preferenceses where ownerType = ?.

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

      Parameters:
      ownerType - the owner type
      start - the lower bound of the range of portal preferenceses
      end - the upper bound of the range of portal preferenceses (not inclusive)
      Returns:
      the range of matching portal preferenceses
    • findByOwnerType

      public static List<PortalPreferences> findByOwnerType(int ownerType, int start, int end, OrderByComparator<PortalPreferences> orderByComparator)
      Returns an ordered range of all the portal preferenceses where ownerType = ?.

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

      Parameters:
      ownerType - the owner type
      start - the lower bound of the range of portal preferenceses
      end - the upper bound of the range of portal preferenceses (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the ordered range of matching portal preferenceses
    • findByOwnerType

      public static List<PortalPreferences> findByOwnerType(int ownerType, int start, int end, OrderByComparator<PortalPreferences> orderByComparator, boolean useFinderCache)
      Returns an ordered range of all the portal preferenceses where ownerType = ?.

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

      Parameters:
      ownerType - the owner type
      start - the lower bound of the range of portal preferenceses
      end - the upper bound of the range of portal preferenceses (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 portal preferenceses
    • findByOwnerType_First

      public static PortalPreferences findByOwnerType_First(int ownerType, OrderByComparator<PortalPreferences> orderByComparator) throws NoSuchPreferencesException
      Returns the first portal preferences in the ordered set where ownerType = ?.
      Parameters:
      ownerType - the owner type
      orderByComparator - the comparator to order the set by (optionally null)
      Returns:
      the first matching portal preferences
      Throws:
      NoSuchPreferencesException - if a matching portal preferences could not be found
      NoSuchPreferencesException
    • fetchByOwnerType_First

      public static PortalPreferences fetchByOwnerType_First(int ownerType, OrderByComparator<PortalPreferences> orderByComparator)
      Returns the first portal preferences in the ordered set where ownerType = ?.
      Parameters:
      ownerType - the owner type
      orderByComparator - the comparator to order the set by (optionally null)
      Returns:
      the first matching portal preferences, or null if a matching portal preferences could not be found
    • findByOwnerType_Last

      public static PortalPreferences findByOwnerType_Last(int ownerType, OrderByComparator<PortalPreferences> orderByComparator) throws NoSuchPreferencesException
      Returns the last portal preferences in the ordered set where ownerType = ?.
      Parameters:
      ownerType - the owner type
      orderByComparator - the comparator to order the set by (optionally null)
      Returns:
      the last matching portal preferences
      Throws:
      NoSuchPreferencesException - if a matching portal preferences could not be found
      NoSuchPreferencesException
    • fetchByOwnerType_Last

      public static PortalPreferences fetchByOwnerType_Last(int ownerType, OrderByComparator<PortalPreferences> orderByComparator)
      Returns the last portal preferences in the ordered set where ownerType = ?.
      Parameters:
      ownerType - the owner type
      orderByComparator - the comparator to order the set by (optionally null)
      Returns:
      the last matching portal preferences, or null if a matching portal preferences could not be found
    • findByOwnerType_PrevAndNext

      public static PortalPreferences[] findByOwnerType_PrevAndNext(long portalPreferencesId, int ownerType, OrderByComparator<PortalPreferences> orderByComparator) throws NoSuchPreferencesException
      Returns the portal preferenceses before and after the current portal preferences in the ordered set where ownerType = ?.
      Parameters:
      portalPreferencesId - the primary key of the current portal preferences
      ownerType - the owner type
      orderByComparator - the comparator to order the set by (optionally null)
      Returns:
      the previous, current, and next portal preferences
      Throws:
      NoSuchPreferencesException - if a portal preferences with the primary key could not be found
      NoSuchPreferencesException
    • removeByOwnerType

      public static void removeByOwnerType(int ownerType)
      Removes all the portal preferenceses where ownerType = ? from the database.
      Parameters:
      ownerType - the owner type
    • countByOwnerType

      public static int countByOwnerType(int ownerType)
      Returns the number of portal preferenceses where ownerType = ?.
      Parameters:
      ownerType - the owner type
      Returns:
      the number of matching portal preferenceses
    • findByO_O

      public static PortalPreferences findByO_O(long ownerId, int ownerType) throws NoSuchPreferencesException
      Returns the portal preferences where ownerId = ? and ownerType = ? or throws a NoSuchPreferencesException if it could not be found.
      Parameters:
      ownerId - the owner ID
      ownerType - the owner type
      Returns:
      the matching portal preferences
      Throws:
      NoSuchPreferencesException - if a matching portal preferences could not be found
      NoSuchPreferencesException
    • fetchByO_O

      public static PortalPreferences fetchByO_O(long ownerId, int ownerType)
      Returns the portal preferences where ownerId = ? and ownerType = ? or returns null if it could not be found. Uses the finder cache.
      Parameters:
      ownerId - the owner ID
      ownerType - the owner type
      Returns:
      the matching portal preferences, or null if a matching portal preferences could not be found
    • fetchByO_O

      public static PortalPreferences fetchByO_O(long ownerId, int ownerType, boolean useFinderCache)
      Returns the portal preferences where ownerId = ? and ownerType = ? or returns null if it could not be found, optionally using the finder cache.
      Parameters:
      ownerId - the owner ID
      ownerType - the owner type
      useFinderCache - whether to use the finder cache
      Returns:
      the matching portal preferences, or null if a matching portal preferences could not be found
    • removeByO_O

      public static PortalPreferences removeByO_O(long ownerId, int ownerType) throws NoSuchPreferencesException
      Removes the portal preferences where ownerId = ? and ownerType = ? from the database.
      Parameters:
      ownerId - the owner ID
      ownerType - the owner type
      Returns:
      the portal preferences that was removed
      Throws:
      NoSuchPreferencesException
    • countByO_O

      public static int countByO_O(long ownerId, int ownerType)
      Returns the number of portal preferenceses where ownerId = ? and ownerType = ?.
      Parameters:
      ownerId - the owner ID
      ownerType - the owner type
      Returns:
      the number of matching portal preferenceses
    • cacheResult

      public static void cacheResult(PortalPreferences portalPreferences)
      Caches the portal preferences in the entity cache if it is enabled.
      Parameters:
      portalPreferences - the portal preferences
    • cacheResult

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

      public static PortalPreferences create(long portalPreferencesId)
      Creates a new portal preferences with the primary key. Does not add the portal preferences to the database.
      Parameters:
      portalPreferencesId - the primary key for the new portal preferences
      Returns:
      the new portal preferences
    • remove

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

      public static PortalPreferences updateImpl(PortalPreferences portalPreferences)
    • findByPrimaryKey

      public static PortalPreferences findByPrimaryKey(long portalPreferencesId) throws NoSuchPreferencesException
      Returns the portal preferences with the primary key or throws a NoSuchPreferencesException if it could not be found.
      Parameters:
      portalPreferencesId - the primary key of the portal preferences
      Returns:
      the portal preferences
      Throws:
      NoSuchPreferencesException - if a portal preferences with the primary key could not be found
      NoSuchPreferencesException
    • fetchByPrimaryKey

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

      public static List<PortalPreferences> findAll()
      Returns all the portal preferenceses.
      Returns:
      the portal preferenceses
    • findAll

      public static List<PortalPreferences> findAll(int start, int end)
      Returns a range of all the portal preferenceses.

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

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

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

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

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

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

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

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

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

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

      public static PortalPreferencesPersistence getPersistence()
    • setPersistence

      public static void setPersistence(PortalPreferencesPersistence persistence)