com.liferay.portlet.expando.service.persistence
Class ExpandoTableUtil

java.lang.Object
  com.liferay.portlet.expando.service.persistence.ExpandoTableUtil

@ProviderType
public class ExpandoTableUtil
extends Object

The persistence utility for the expando table service. This utility wraps ExpandoTablePersistenceImpl 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

See Also:

ExpandoTablePersistence, ExpandoTablePersistenceImpl

Constructor Summary

ExpandoTableUtil()

Method Summary

static void	cacheResult(ExpandoTable expandoTable) Caches the expando table in the entity cache if it is enabled.
static void	cacheResult(List<ExpandoTable> expandoTables) Caches the expando tables in the entity cache if it is enabled.
static void	clearCache()
static void	clearCache(ExpandoTable expandoTable)
static int	countAll() Returns the number of expando tables.
static int	countByC_C_N(long companyId, long classNameId, String name) Returns the number of expando tables where companyId = ? and classNameId = ? and name = ?.
static int	countByC_C(long companyId, long classNameId) Returns the number of expando tables where companyId = ? and classNameId = ?.
static long	countWithDynamicQuery(DynamicQuery dynamicQuery)
static ExpandoTable	create(long tableId) Creates a new expando table with the primary key.
static ExpandoTable	fetchByC_C_First(long companyId, long classNameId, OrderByComparator orderByComparator) Returns the first expando table in the ordered set where companyId = ? and classNameId = ?.
static ExpandoTable	fetchByC_C_Last(long companyId, long classNameId, OrderByComparator orderByComparator) Returns the last expando table in the ordered set where companyId = ? and classNameId = ?.
static ExpandoTable	fetchByC_C_N(long companyId, long classNameId, String name) Returns the expando table where companyId = ? and classNameId = ? and name = ? or returns null if it could not be found.
static ExpandoTable	fetchByC_C_N(long companyId, long classNameId, String name, boolean retrieveFromCache) Returns the expando table where companyId = ? and classNameId = ? and name = ? or returns null if it could not be found, optionally using the finder cache.
static ExpandoTable	fetchByPrimaryKey(long tableId) Returns the expando table with the primary key or returns null if it could not be found.
static List<ExpandoTable>	findAll() Returns all the expando tables.
static List<ExpandoTable>	findAll(int start, int end) Returns a range of all the expando tables.
static List<ExpandoTable>	findAll(int start, int end, OrderByComparator orderByComparator) Returns an ordered range of all the expando tables.
static ExpandoTable	findByC_C_First(long companyId, long classNameId, OrderByComparator orderByComparator) Returns the first expando table in the ordered set where companyId = ? and classNameId = ?.
static ExpandoTable	findByC_C_Last(long companyId, long classNameId, OrderByComparator orderByComparator) Returns the last expando table in the ordered set where companyId = ? and classNameId = ?.
static ExpandoTable	findByC_C_N(long companyId, long classNameId, String name) Returns the expando table where companyId = ? and classNameId = ? and name = ? or throws a NoSuchTableException if it could not be found.
static ExpandoTable[]	findByC_C_PrevAndNext(long tableId, long companyId, long classNameId, OrderByComparator orderByComparator) Returns the expando tables before and after the current expando table in the ordered set where companyId = ? and classNameId = ?.
static List<ExpandoTable>	findByC_C(long companyId, long classNameId) Returns all the expando tables where companyId = ? and classNameId = ?.
static List<ExpandoTable>	findByC_C(long companyId, long classNameId, int start, int end) Returns a range of all the expando tables where companyId = ? and classNameId = ?.
static List<ExpandoTable>	findByC_C(long companyId, long classNameId, int start, int end, OrderByComparator orderByComparator) Returns an ordered range of all the expando tables where companyId = ? and classNameId = ?.
static ExpandoTable	findByPrimaryKey(long tableId) Returns the expando table with the primary key or throws a NoSuchTableException if it could not be found.
static List<ExpandoTable>	findWithDynamicQuery(DynamicQuery dynamicQuery)
static List<ExpandoTable>	findWithDynamicQuery(DynamicQuery dynamicQuery, int start, int end)
static List<ExpandoTable>	findWithDynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator)
static ExpandoTablePersistence	getPersistence()
static ExpandoTable	remove(long tableId) Removes the expando table with the primary key from the database.
static void	removeAll() Removes all the expando tables from the database.
static ExpandoTable	removeByC_C_N(long companyId, long classNameId, String name) Removes the expando table where companyId = ? and classNameId = ? and name = ? from the database.
static void	removeByC_C(long companyId, long classNameId) Removes all the expando tables where companyId = ? and classNameId = ? from the database.
void	setPersistence(ExpandoTablePersistence persistence) Deprecated. As of 6.2.0
static ExpandoTable	update(ExpandoTable expandoTable)
static ExpandoTable	update(ExpandoTable expandoTable, ServiceContext serviceContext)
static ExpandoTable	updateImpl(ExpandoTable expandoTable)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExpandoTableUtil

public ExpandoTableUtil()

Method Detail

clearCache

public static void clearCache()

See Also:

BasePersistence.clearCache()

clearCache

public static void clearCache(ExpandoTable expandoTable)

See Also:

BasePersistence.clearCache(com.liferay.portal.model.BaseModel)

countWithDynamicQuery

public static long countWithDynamicQuery(DynamicQuery dynamicQuery)
                                  throws SystemException

Throws:

SystemException

See Also:

BasePersistence.countWithDynamicQuery(DynamicQuery)

findWithDynamicQuery

public static List<ExpandoTable> findWithDynamicQuery(DynamicQuery dynamicQuery)
                                               throws SystemException

Throws:

SystemException

See Also:

BasePersistence.findWithDynamicQuery(DynamicQuery)

findWithDynamicQuery

public static List<ExpandoTable> findWithDynamicQuery(DynamicQuery dynamicQuery,
                                                      int start,
                                                      int end)
                                               throws SystemException

Throws:

SystemException

See Also:

BasePersistence.findWithDynamicQuery(DynamicQuery, int, int)

findWithDynamicQuery

public static List<ExpandoTable> findWithDynamicQuery(DynamicQuery dynamicQuery,
                                                      int start,
                                                      int end,
                                                      OrderByComparator orderByComparator)
                                               throws SystemException

Throws:

SystemException

See Also:

BasePersistence.findWithDynamicQuery(DynamicQuery, int, int, OrderByComparator)

update

public static ExpandoTable update(ExpandoTable expandoTable)
                           throws SystemException

Throws:

SystemException

See Also:

BasePersistence.update(com.liferay.portal.model.BaseModel)

update

public static ExpandoTable update(ExpandoTable expandoTable,
                                  ServiceContext serviceContext)
                           throws SystemException

Throws:

SystemException

See Also:

BasePersistence.update(com.liferay.portal.model.BaseModel, ServiceContext)

findByC_C

public static List<ExpandoTable> findByC_C(long companyId,
                                           long classNameId)
                                    throws SystemException

Returns all the expando tables where companyId = ? and classNameId = ?.

Parameters:

companyId - the company ID

classNameId - the class name ID

Returns:

the matching expando tables

Throws:

SystemException - if a system exception occurred

findByC_C

public static List<ExpandoTable> findByC_C(long companyId,
                                           long classNameId,
                                           int start,
                                           int end)
                                    throws SystemException

Returns a range of all the expando tables where companyId = ? and classNameId = ?.

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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ExpandoTableModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

companyId - the company ID

classNameId - the class name ID

start - the lower bound of the range of expando tables

end - the upper bound of the range of expando tables (not inclusive)

Returns:

the range of matching expando tables

Throws:

SystemException - if a system exception occurred

findByC_C

public static List<ExpandoTable> findByC_C(long companyId,
                                           long classNameId,
                                           int start,
                                           int end,
                                           OrderByComparator orderByComparator)
                                    throws SystemException

Returns an ordered range of all the expando tables where companyId = ? and classNameId = ?.

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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ExpandoTableModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

companyId - the company ID

classNameId - the class name ID

start - the lower bound of the range of expando tables

end - the upper bound of the range of expando tables (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching expando tables

Throws:

SystemException - if a system exception occurred

findByC_C_First

public static ExpandoTable findByC_C_First(long companyId,
                                           long classNameId,
                                           OrderByComparator orderByComparator)
                                    throws SystemException,
                                           NoSuchTableException

Returns the first expando table in the ordered set where companyId = ? and classNameId = ?.

Parameters:

companyId - the company ID

classNameId - the class name ID

orderByComparator - the comparator to order the set by (optionally null)

Returns:

the first matching expando table

Throws:

NoSuchTableException - if a matching expando table could not be found

SystemException - if a system exception occurred

fetchByC_C_First

public static ExpandoTable fetchByC_C_First(long companyId,
                                            long classNameId,
                                            OrderByComparator orderByComparator)
                                     throws SystemException

Returns the first expando table in the ordered set where companyId = ? and classNameId = ?.

Parameters:

companyId - the company ID

classNameId - the class name ID

orderByComparator - the comparator to order the set by (optionally null)

Returns:

the first matching expando table, or null if a matching expando table could not be found

Throws:

SystemException - if a system exception occurred

findByC_C_Last

public static ExpandoTable findByC_C_Last(long companyId,
                                          long classNameId,
                                          OrderByComparator orderByComparator)
                                   throws SystemException,
                                          NoSuchTableException

Returns the last expando table in the ordered set where companyId = ? and classNameId = ?.

Parameters:

companyId - the company ID

classNameId - the class name ID

orderByComparator - the comparator to order the set by (optionally null)

Returns:

the last matching expando table

Throws:

NoSuchTableException - if a matching expando table could not be found

SystemException - if a system exception occurred

fetchByC_C_Last

public static ExpandoTable fetchByC_C_Last(long companyId,
                                           long classNameId,
                                           OrderByComparator orderByComparator)
                                    throws SystemException

Returns the last expando table in the ordered set where companyId = ? and classNameId = ?.

Parameters:

companyId - the company ID

classNameId - the class name ID

orderByComparator - the comparator to order the set by (optionally null)

Returns:

the last matching expando table, or null if a matching expando table could not be found

Throws:

SystemException - if a system exception occurred

findByC_C_PrevAndNext

public static ExpandoTable[] findByC_C_PrevAndNext(long tableId,
                                                   long companyId,
                                                   long classNameId,
                                                   OrderByComparator orderByComparator)
                                            throws SystemException,
                                                   NoSuchTableException

Returns the expando tables before and after the current expando table in the ordered set where companyId = ? and classNameId = ?.

Parameters:

tableId - the primary key of the current expando table

companyId - the company ID

classNameId - the class name ID

orderByComparator - the comparator to order the set by (optionally null)

Returns:

the previous, current, and next expando table

Throws:

NoSuchTableException - if a expando table with the primary key could not be found

SystemException - if a system exception occurred

removeByC_C

public static void removeByC_C(long companyId,
                               long classNameId)
                        throws SystemException

Removes all the expando tables where companyId = ? and classNameId = ? from the database.

Parameters:

companyId - the company ID

classNameId - the class name ID

Throws:

SystemException - if a system exception occurred

countByC_C

public static int countByC_C(long companyId,
                             long classNameId)
                      throws SystemException

Returns the number of expando tables where companyId = ? and classNameId = ?.

Parameters:

companyId - the company ID

classNameId - the class name ID

Returns:

the number of matching expando tables

Throws:

SystemException - if a system exception occurred

findByC_C_N

public static ExpandoTable findByC_C_N(long companyId,
                                       long classNameId,
                                       String name)
                                throws SystemException,
                                       NoSuchTableException

Returns the expando table where companyId = ? and classNameId = ? and name = ? or throws a NoSuchTableException if it could not be found.

Parameters:

companyId - the company ID

classNameId - the class name ID

name - the name

Returns:

the matching expando table

Throws:

NoSuchTableException - if a matching expando table could not be found

SystemException - if a system exception occurred

fetchByC_C_N

public static ExpandoTable fetchByC_C_N(long companyId,
                                        long classNameId,
                                        String name)
                                 throws SystemException

Returns the expando table where companyId = ? and classNameId = ? and name = ? or returns null if it could not be found. Uses the finder cache.

Parameters:

companyId - the company ID

classNameId - the class name ID

name - the name

Returns:

the matching expando table, or null if a matching expando table could not be found

Throws:

SystemException - if a system exception occurred

fetchByC_C_N

public static ExpandoTable fetchByC_C_N(long companyId,
                                        long classNameId,
                                        String name,
                                        boolean retrieveFromCache)
                                 throws SystemException

Returns the expando table where companyId = ? and classNameId = ? and name = ? or returns null if it could not be found, optionally using the finder cache.

Parameters:

companyId - the company ID

classNameId - the class name ID

name - the name

retrieveFromCache - whether to use the finder cache

Returns:

the matching expando table, or null if a matching expando table could not be found

Throws:

SystemException - if a system exception occurred

removeByC_C_N

public static ExpandoTable removeByC_C_N(long companyId,
                                         long classNameId,
                                         String name)
                                  throws SystemException,
                                         NoSuchTableException

Removes the expando table where companyId = ? and classNameId = ? and name = ? from the database.

Parameters:

companyId - the company ID

classNameId - the class name ID

name - the name

Returns:

the expando table that was removed

Throws:

SystemException - if a system exception occurred

NoSuchTableException

countByC_C_N

public static int countByC_C_N(long companyId,
                               long classNameId,
                               String name)
                        throws SystemException

Returns the number of expando tables where companyId = ? and classNameId = ? and name = ?.

Parameters:

companyId - the company ID

classNameId - the class name ID

name - the name

Returns:

the number of matching expando tables

Throws:

SystemException - if a system exception occurred

cacheResult

public static void cacheResult(ExpandoTable expandoTable)

Caches the expando table in the entity cache if it is enabled.

Parameters:

expandoTable - the expando table

cacheResult

public static void cacheResult(List<ExpandoTable> expandoTables)

Caches the expando tables in the entity cache if it is enabled.

Parameters:

expandoTables - the expando tables

create

public static ExpandoTable create(long tableId)

Creates a new expando table with the primary key. Does not add the expando table to the database.

Parameters:

tableId - the primary key for the new expando table

Returns:

the new expando table

remove

public static ExpandoTable remove(long tableId)
                           throws SystemException,
                                  NoSuchTableException

Removes the expando table with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

tableId - the primary key of the expando table

Returns:

the expando table that was removed

Throws:

NoSuchTableException - if a expando table with the primary key could not be found

SystemException - if a system exception occurred

updateImpl

public static ExpandoTable updateImpl(ExpandoTable expandoTable)
                               throws SystemException

Throws:

SystemException

findByPrimaryKey

public static ExpandoTable findByPrimaryKey(long tableId)
                                     throws SystemException,
                                            NoSuchTableException

Returns the expando table with the primary key or throws a NoSuchTableException if it could not be found.

Parameters:

tableId - the primary key of the expando table

Returns:

the expando table

Throws:

NoSuchTableException - if a expando table with the primary key could not be found

SystemException - if a system exception occurred

fetchByPrimaryKey

public static ExpandoTable fetchByPrimaryKey(long tableId)
                                      throws SystemException

Returns the expando table with the primary key or returns null if it could not be found.

Parameters:

tableId - the primary key of the expando table

Returns:

the expando table, or null if a expando table with the primary key could not be found

Throws:

SystemException - if a system exception occurred

findAll

public static List<ExpandoTable> findAll()
                                  throws SystemException

Returns all the expando tables.

Returns:

the expando tables

Throws:

SystemException - if a system exception occurred

findAll

public static List<ExpandoTable> findAll(int start,
                                         int end)
                                  throws SystemException

Returns a range of all the expando tables.

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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ExpandoTableModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

start - the lower bound of the range of expando tables

end - the upper bound of the range of expando tables (not inclusive)

Returns:

the range of expando tables

Throws:

SystemException - if a system exception occurred

findAll

public static List<ExpandoTable> findAll(int start,
                                         int end,
                                         OrderByComparator orderByComparator)
                                  throws SystemException

Returns an ordered range of all the expando tables.

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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ExpandoTableModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

start - the lower bound of the range of expando tables

end - the upper bound of the range of expando tables (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of expando tables

Throws:

SystemException - if a system exception occurred

removeAll

public static void removeAll()
                      throws SystemException

Removes all the expando tables from the database.

Throws:

SystemException - if a system exception occurred

countAll

public static int countAll()
                    throws SystemException

Returns the number of expando tables.

Returns:

the number of expando tables

Throws:

SystemException - if a system exception occurred

getPersistence

public static ExpandoTablePersistence getPersistence()

setPersistence

public void setPersistence(ExpandoTablePersistence persistence)

Deprecated. As of 6.2.0