Class ClassNameUtil

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

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

    • ClassNameUtil

      public ClassNameUtil()
  • Method Details

    • clearCache

      public static void clearCache()
      See Also:
    • clearCache

      public static void clearCache(ClassName className)
      See Also:
    • countWithDynamicQuery

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

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

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

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

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

      public static ClassName update(ClassName className)
      See Also:
    • update

      public static ClassName update(ClassName className, ServiceContext serviceContext)
      See Also:
    • findByValue

      public static ClassName findByValue(String value) throws NoSuchClassNameException
      Returns the class name where value = ? or throws a NoSuchClassNameException if it could not be found.
      Parameters:
      value - the value
      Returns:
      the matching class name
      Throws:
      NoSuchClassNameException - if a matching class name could not be found
      NoSuchClassNameException
    • fetchByValue

      public static ClassName fetchByValue(String value)
      Returns the class name where value = ? or returns null if it could not be found. Uses the finder cache.
      Parameters:
      value - the value
      Returns:
      the matching class name, or null if a matching class name could not be found
    • fetchByValue

      public static ClassName fetchByValue(String value, boolean useFinderCache)
      Returns the class name where value = ? or returns null if it could not be found, optionally using the finder cache.
      Parameters:
      value - the value
      useFinderCache - whether to use the finder cache
      Returns:
      the matching class name, or null if a matching class name could not be found
    • removeByValue

      public static ClassName removeByValue(String value) throws NoSuchClassNameException
      Removes the class name where value = ? from the database.
      Parameters:
      value - the value
      Returns:
      the class name that was removed
      Throws:
      NoSuchClassNameException
    • countByValue

      public static int countByValue(String value)
      Returns the number of class names where value = ?.
      Parameters:
      value - the value
      Returns:
      the number of matching class names
    • cacheResult

      public static void cacheResult(ClassName className)
      Caches the class name in the entity cache if it is enabled.
      Parameters:
      className - the class name
    • cacheResult

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

      public static ClassName create(long classNameId)
      Creates a new class name with the primary key. Does not add the class name to the database.
      Parameters:
      classNameId - the primary key for the new class name
      Returns:
      the new class name
    • remove

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

      public static ClassName updateImpl(ClassName className)
    • findByPrimaryKey

      public static ClassName findByPrimaryKey(long classNameId) throws NoSuchClassNameException
      Returns the class name with the primary key or throws a NoSuchClassNameException if it could not be found.
      Parameters:
      classNameId - the primary key of the class name
      Returns:
      the class name
      Throws:
      NoSuchClassNameException - if a class name with the primary key could not be found
      NoSuchClassNameException
    • fetchByPrimaryKey

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

      public static List<ClassName> findAll()
      Returns all the class names.
      Returns:
      the class names
    • findAll

      public static List<ClassName> findAll(int start, int end)
      Returns a range of all the class names.

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

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

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

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

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

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

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

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

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

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

      public static ClassNamePersistence getPersistence()
    • setPersistence

      public static void setPersistence(ClassNamePersistence persistence)