Class ExpandoColumnUtil

Object
com.liferay.expando.kernel.service.persistence.ExpandoColumnUtil

public class ExpandoColumnUtil extends Object
The persistence utility for the expando column service. This utility wraps com.liferay.portlet.expando.service.persistence.impl.ExpandoColumnPersistenceImpl 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

    • ExpandoColumnUtil

      public ExpandoColumnUtil()
  • Method Details

    • clearCache

      public static void clearCache()
      See Also:
    • clearCache

      public static void clearCache(ExpandoColumn expandoColumn)
      See Also:
    • countWithDynamicQuery

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

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

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

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

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

      public static ExpandoColumn update(ExpandoColumn expandoColumn)
      See Also:
    • update

      public static ExpandoColumn update(ExpandoColumn expandoColumn, ServiceContext serviceContext)
      See Also:
    • findByTableId

      public static List<ExpandoColumn> findByTableId(long tableId)
      Returns all the expando columns where tableId = ?.
      Parameters:
      tableId - the table ID
      Returns:
      the matching expando columns
    • findByTableId

      public static List<ExpandoColumn> findByTableId(long tableId, int start, int end)
      Returns a range of all the expando columns where tableId = ?.

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

      Parameters:
      tableId - the table ID
      start - the lower bound of the range of expando columns
      end - the upper bound of the range of expando columns (not inclusive)
      Returns:
      the range of matching expando columns
    • findByTableId

      public static List<ExpandoColumn> findByTableId(long tableId, int start, int end, OrderByComparator<ExpandoColumn> orderByComparator)
      Returns an ordered range of all the expando columns where tableId = ?.

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

      Parameters:
      tableId - the table ID
      start - the lower bound of the range of expando columns
      end - the upper bound of the range of expando columns (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the ordered range of matching expando columns
    • findByTableId

      public static List<ExpandoColumn> findByTableId(long tableId, int start, int end, OrderByComparator<ExpandoColumn> orderByComparator, boolean useFinderCache)
      Returns an ordered range of all the expando columns where tableId = ?.

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

      Parameters:
      tableId - the table ID
      start - the lower bound of the range of expando columns
      end - the upper bound of the range of expando columns (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 expando columns
    • findByTableId_First

      public static ExpandoColumn findByTableId_First(long tableId, OrderByComparator<ExpandoColumn> orderByComparator) throws NoSuchColumnException
      Returns the first expando column in the ordered set where tableId = ?.
      Parameters:
      tableId - the table ID
      orderByComparator - the comparator to order the set by (optionally null)
      Returns:
      the first matching expando column
      Throws:
      NoSuchColumnException - if a matching expando column could not be found
      NoSuchColumnException
    • fetchByTableId_First

      public static ExpandoColumn fetchByTableId_First(long tableId, OrderByComparator<ExpandoColumn> orderByComparator)
      Returns the first expando column in the ordered set where tableId = ?.
      Parameters:
      tableId - the table ID
      orderByComparator - the comparator to order the set by (optionally null)
      Returns:
      the first matching expando column, or null if a matching expando column could not be found
    • findByTableId_Last

      public static ExpandoColumn findByTableId_Last(long tableId, OrderByComparator<ExpandoColumn> orderByComparator) throws NoSuchColumnException
      Returns the last expando column in the ordered set where tableId = ?.
      Parameters:
      tableId - the table ID
      orderByComparator - the comparator to order the set by (optionally null)
      Returns:
      the last matching expando column
      Throws:
      NoSuchColumnException - if a matching expando column could not be found
      NoSuchColumnException
    • fetchByTableId_Last

      public static ExpandoColumn fetchByTableId_Last(long tableId, OrderByComparator<ExpandoColumn> orderByComparator)
      Returns the last expando column in the ordered set where tableId = ?.
      Parameters:
      tableId - the table ID
      orderByComparator - the comparator to order the set by (optionally null)
      Returns:
      the last matching expando column, or null if a matching expando column could not be found
    • findByTableId_PrevAndNext

      public static ExpandoColumn[] findByTableId_PrevAndNext(long columnId, long tableId, OrderByComparator<ExpandoColumn> orderByComparator) throws NoSuchColumnException
      Returns the expando columns before and after the current expando column in the ordered set where tableId = ?.
      Parameters:
      columnId - the primary key of the current expando column
      tableId - the table ID
      orderByComparator - the comparator to order the set by (optionally null)
      Returns:
      the previous, current, and next expando column
      Throws:
      NoSuchColumnException - if a expando column with the primary key could not be found
      NoSuchColumnException
    • filterFindByTableId

      public static List<ExpandoColumn> filterFindByTableId(long tableId)
      Returns all the expando columns that the user has permission to view where tableId = ?.
      Parameters:
      tableId - the table ID
      Returns:
      the matching expando columns that the user has permission to view
    • filterFindByTableId

      public static List<ExpandoColumn> filterFindByTableId(long tableId, int start, int end)
      Returns a range of all the expando columns that the user has permission to view where tableId = ?.

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

      Parameters:
      tableId - the table ID
      start - the lower bound of the range of expando columns
      end - the upper bound of the range of expando columns (not inclusive)
      Returns:
      the range of matching expando columns that the user has permission to view
    • filterFindByTableId

      public static List<ExpandoColumn> filterFindByTableId(long tableId, int start, int end, OrderByComparator<ExpandoColumn> orderByComparator)
      Returns an ordered range of all the expando columns that the user has permissions to view where tableId = ?.

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

      Parameters:
      tableId - the table ID
      start - the lower bound of the range of expando columns
      end - the upper bound of the range of expando columns (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the ordered range of matching expando columns that the user has permission to view
    • filterFindByTableId_PrevAndNext

      public static ExpandoColumn[] filterFindByTableId_PrevAndNext(long columnId, long tableId, OrderByComparator<ExpandoColumn> orderByComparator) throws NoSuchColumnException
      Returns the expando columns before and after the current expando column in the ordered set of expando columns that the user has permission to view where tableId = ?.
      Parameters:
      columnId - the primary key of the current expando column
      tableId - the table ID
      orderByComparator - the comparator to order the set by (optionally null)
      Returns:
      the previous, current, and next expando column
      Throws:
      NoSuchColumnException - if a expando column with the primary key could not be found
      NoSuchColumnException
    • removeByTableId

      public static void removeByTableId(long tableId)
      Removes all the expando columns where tableId = ? from the database.
      Parameters:
      tableId - the table ID
    • countByTableId

      public static int countByTableId(long tableId)
      Returns the number of expando columns where tableId = ?.
      Parameters:
      tableId - the table ID
      Returns:
      the number of matching expando columns
    • filterCountByTableId

      public static int filterCountByTableId(long tableId)
      Returns the number of expando columns that the user has permission to view where tableId = ?.
      Parameters:
      tableId - the table ID
      Returns:
      the number of matching expando columns that the user has permission to view
    • findByT_N

      public static List<ExpandoColumn> findByT_N(long tableId, String[] names)
      Returns all the expando columns where tableId = ? and name = any ?.

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

      Parameters:
      tableId - the table ID
      names - the names
      Returns:
      the matching expando columns
    • findByT_N

      public static List<ExpandoColumn> findByT_N(long tableId, String[] names, int start, int end)
      Returns a range of all the expando columns where tableId = ? and name = any ?.

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

      Parameters:
      tableId - the table ID
      names - the names
      start - the lower bound of the range of expando columns
      end - the upper bound of the range of expando columns (not inclusive)
      Returns:
      the range of matching expando columns
    • findByT_N

      public static List<ExpandoColumn> findByT_N(long tableId, String[] names, int start, int end, OrderByComparator<ExpandoColumn> orderByComparator)
      Returns an ordered range of all the expando columns where tableId = ? and name = any ?.

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

      Parameters:
      tableId - the table ID
      names - the names
      start - the lower bound of the range of expando columns
      end - the upper bound of the range of expando columns (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the ordered range of matching expando columns
    • findByT_N

      public static List<ExpandoColumn> findByT_N(long tableId, String[] names, int start, int end, OrderByComparator<ExpandoColumn> orderByComparator, boolean useFinderCache)
      Returns an ordered range of all the expando columns where tableId = ? and name = ?, optionally using the finder cache.

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

      Parameters:
      tableId - the table ID
      names - the names
      start - the lower bound of the range of expando columns
      end - the upper bound of the range of expando columns (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 expando columns
    • findByT_N

      public static ExpandoColumn findByT_N(long tableId, String name) throws NoSuchColumnException
      Returns the expando column where tableId = ? and name = ? or throws a NoSuchColumnException if it could not be found.
      Parameters:
      tableId - the table ID
      name - the name
      Returns:
      the matching expando column
      Throws:
      NoSuchColumnException - if a matching expando column could not be found
      NoSuchColumnException
    • fetchByT_N

      public static ExpandoColumn fetchByT_N(long tableId, String name)
      Returns the expando column where tableId = ? and name = ? or returns null if it could not be found. Uses the finder cache.
      Parameters:
      tableId - the table ID
      name - the name
      Returns:
      the matching expando column, or null if a matching expando column could not be found
    • fetchByT_N

      public static ExpandoColumn fetchByT_N(long tableId, String name, boolean useFinderCache)
      Returns the expando column where tableId = ? and name = ? or returns null if it could not be found, optionally using the finder cache.
      Parameters:
      tableId - the table ID
      name - the name
      useFinderCache - whether to use the finder cache
      Returns:
      the matching expando column, or null if a matching expando column could not be found
    • removeByT_N

      public static ExpandoColumn removeByT_N(long tableId, String name) throws NoSuchColumnException
      Removes the expando column where tableId = ? and name = ? from the database.
      Parameters:
      tableId - the table ID
      name - the name
      Returns:
      the expando column that was removed
      Throws:
      NoSuchColumnException
    • countByT_N

      public static int countByT_N(long tableId, String name)
      Returns the number of expando columns where tableId = ? and name = ?.
      Parameters:
      tableId - the table ID
      name - the name
      Returns:
      the number of matching expando columns
    • countByT_N

      public static int countByT_N(long tableId, String[] names)
      Returns the number of expando columns where tableId = ? and name = any ?.
      Parameters:
      tableId - the table ID
      names - the names
      Returns:
      the number of matching expando columns
    • filterCountByT_N

      public static int filterCountByT_N(long tableId, String name)
      Returns the number of expando columns that the user has permission to view where tableId = ? and name = ?.
      Parameters:
      tableId - the table ID
      name - the name
      Returns:
      the number of matching expando columns that the user has permission to view
    • filterCountByT_N

      public static int filterCountByT_N(long tableId, String[] names)
      Returns the number of expando columns that the user has permission to view where tableId = ? and name = any ?.
      Parameters:
      tableId - the table ID
      names - the names
      Returns:
      the number of matching expando columns that the user has permission to view
    • cacheResult

      public static void cacheResult(ExpandoColumn expandoColumn)
      Caches the expando column in the entity cache if it is enabled.
      Parameters:
      expandoColumn - the expando column
    • cacheResult

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

      public static ExpandoColumn create(long columnId)
      Creates a new expando column with the primary key. Does not add the expando column to the database.
      Parameters:
      columnId - the primary key for the new expando column
      Returns:
      the new expando column
    • remove

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

      public static ExpandoColumn updateImpl(ExpandoColumn expandoColumn)
    • findByPrimaryKey

      public static ExpandoColumn findByPrimaryKey(long columnId) throws NoSuchColumnException
      Returns the expando column with the primary key or throws a NoSuchColumnException if it could not be found.
      Parameters:
      columnId - the primary key of the expando column
      Returns:
      the expando column
      Throws:
      NoSuchColumnException - if a expando column with the primary key could not be found
      NoSuchColumnException
    • fetchByPrimaryKey

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

      public static List<ExpandoColumn> findAll()
      Returns all the expando columns.
      Returns:
      the expando columns
    • findAll

      public static List<ExpandoColumn> findAll(int start, int end)
      Returns a range of all the expando columns.

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

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

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

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

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

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

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

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

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

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

      public static ExpandoColumnPersistence getPersistence()
    • setPersistence

      public static void setPersistence(ExpandoColumnPersistence persistence)