com.liferay.portlet.expando.service.persistence

Interface ExpandoColumnPersistence

All Superinterfaces:

BasePersistence<ExpandoColumn>

@ProviderType
public interface ExpandoColumnPersistence
extends BasePersistence<ExpandoColumn>

The persistence interface for the expando column service.

Caching information and settings can be found in portal.properties

Author:

Brian Wing Shun Chan

See Also:

ExpandoColumnPersistenceImpl, ExpandoColumnUtil

Generated:

Method Summary

Methods

Modifier and Type	Method and Description
void	cacheResult(ExpandoColumn expandoColumn) Caches the expando column in the entity cache if it is enabled.
void	cacheResult(java.util.List<ExpandoColumn> expandoColumns) Caches the expando columns in the entity cache if it is enabled.
int	countAll() Returns the number of expando columns.
int	countByT_N(long tableId, java.lang.String name) Returns the number of expando columns where tableId = ? and name = ?.
int	countByT_N(long tableId, java.lang.String[] names) Returns the number of expando columns where tableId = ? and name = any ?.
int	countByTableId(long tableId) Returns the number of expando columns where tableId = ?.
ExpandoColumn	create(long columnId) Creates a new expando column with the primary key.
ExpandoColumn	fetchByPrimaryKey(long columnId) Returns the expando column with the primary key or returns null if it could not be found.
ExpandoColumn	fetchByT_N(long tableId, java.lang.String name) Returns the expando column where tableId = ? and name = ? or returns null if it could not be found.
ExpandoColumn	fetchByT_N(long tableId, java.lang.String name, boolean retrieveFromCache) Returns the expando column where tableId = ? and name = ? or returns null if it could not be found, optionally using the finder cache.
ExpandoColumn	fetchByTableId_First(long tableId, OrderByComparator orderByComparator) Returns the first expando column in the ordered set where tableId = ?.
ExpandoColumn	fetchByTableId_Last(long tableId, OrderByComparator orderByComparator) Returns the last expando column in the ordered set where tableId = ?.
int	filterCountByT_N(long tableId, java.lang.String name) Returns the number of expando columns that the user has permission to view where tableId = ? and name = ?.
int	filterCountByT_N(long tableId, java.lang.String[] names) Returns the number of expando columns that the user has permission to view where tableId = ? and name = any ?.
int	filterCountByTableId(long tableId) Returns the number of expando columns that the user has permission to view where tableId = ?.
ExpandoColumn[]	filterFindByTableId_PrevAndNext(long columnId, long tableId, OrderByComparator orderByComparator) 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 = ?.
java.util.List<ExpandoColumn>	filterFindByTableId(long tableId) Returns all the expando columns that the user has permission to view where tableId = ?.
java.util.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 = ?.
java.util.List<ExpandoColumn>	filterFindByTableId(long tableId, int start, int end, OrderByComparator orderByComparator) Returns an ordered range of all the expando columns that the user has permissions to view where tableId = ?.
java.util.List<ExpandoColumn>	findAll() Returns all the expando columns.
java.util.List<ExpandoColumn>	findAll(int start, int end) Returns a range of all the expando columns.
java.util.List<ExpandoColumn>	findAll(int start, int end, OrderByComparator orderByComparator) Returns an ordered range of all the expando columns.
ExpandoColumn	findByPrimaryKey(long columnId) Returns the expando column with the primary key or throws a NoSuchColumnException if it could not be found.
ExpandoColumn	findByT_N(long tableId, java.lang.String name) Returns the expando column where tableId = ? and name = ? or throws a NoSuchColumnException if it could not be found.
java.util.List<ExpandoColumn>	findByT_N(long tableId, java.lang.String[] names) Returns all the expando columns where tableId = ? and name = any ?.
java.util.List<ExpandoColumn>	findByT_N(long tableId, java.lang.String[] names, int start, int end) Returns a range of all the expando columns where tableId = ? and name = any ?.
java.util.List<ExpandoColumn>	findByT_N(long tableId, java.lang.String[] names, int start, int end, OrderByComparator orderByComparator) Returns an ordered range of all the expando columns where tableId = ? and name = any ?.
ExpandoColumn	findByTableId_First(long tableId, OrderByComparator orderByComparator) Returns the first expando column in the ordered set where tableId = ?.
ExpandoColumn	findByTableId_Last(long tableId, OrderByComparator orderByComparator) Returns the last expando column in the ordered set where tableId = ?.
ExpandoColumn[]	findByTableId_PrevAndNext(long columnId, long tableId, OrderByComparator orderByComparator) Returns the expando columns before and after the current expando column in the ordered set where tableId = ?.
java.util.List<ExpandoColumn>	findByTableId(long tableId) Returns all the expando columns where tableId = ?.
java.util.List<ExpandoColumn>	findByTableId(long tableId, int start, int end) Returns a range of all the expando columns where tableId = ?.
java.util.List<ExpandoColumn>	findByTableId(long tableId, int start, int end, OrderByComparator orderByComparator) Returns an ordered range of all the expando columns where tableId = ?.
ExpandoColumn	remove(long columnId) Removes the expando column with the primary key from the database.
void	removeAll() Removes all the expando columns from the database.
ExpandoColumn	removeByT_N(long tableId, java.lang.String name) Removes the expando column where tableId = ? and name = ? from the database.
void	removeByTableId(long tableId) Removes all the expando columns where tableId = ? from the database.
ExpandoColumn	updateImpl(ExpandoColumn expandoColumn)

Methods inherited from interface com.liferay.portal.service.persistence.BasePersistence

clearCache, clearCache, clearCache, closeSession, countWithDynamicQuery, countWithDynamicQuery, fetchByPrimaryKey, findByPrimaryKey, findWithDynamicQuery, findWithDynamicQuery, findWithDynamicQuery, flush, getCurrentSession, getDataSource, getListeners, getModelClass, openSession, processException, registerListener, remove, remove, setDataSource, unregisterListener, update, update, update, update

Method Detail

findByTableId

java.util.List<ExpandoColumn> findByTableId(long tableId)
                                            throws SystemException

Returns all the expando columns where tableId = ?.

Parameters:

tableId - the table ID

Returns:

the matching expando columns

Throws:

SystemException - if a system exception occurred

findByTableId

java.util.List<ExpandoColumn> findByTableId(long tableId,
                                          int start,
                                          int end)
                                            throws SystemException

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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ExpandoColumnModelImpl. 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:

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

Throws:

SystemException - if a system exception occurred

findByTableId

java.util.List<ExpandoColumn> findByTableId(long tableId,
                                          int start,
                                          int end,
                                          OrderByComparator orderByComparator)
                                            throws SystemException

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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ExpandoColumnModelImpl. 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:

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

Throws:

SystemException - if a system exception occurred

findByTableId_First

ExpandoColumn findByTableId_First(long tableId,
                                OrderByComparator orderByComparator)
                                  throws SystemException,
                                         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

SystemException - if a system exception occurred

fetchByTableId_First

ExpandoColumn fetchByTableId_First(long tableId,
                                 OrderByComparator orderByComparator)
                                   throws SystemException

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

Throws:

SystemException - if a system exception occurred

findByTableId_Last

ExpandoColumn findByTableId_Last(long tableId,
                               OrderByComparator orderByComparator)
                                 throws SystemException,
                                        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

SystemException - if a system exception occurred

fetchByTableId_Last

ExpandoColumn fetchByTableId_Last(long tableId,
                                OrderByComparator orderByComparator)
                                  throws SystemException

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

Throws:

SystemException - if a system exception occurred

findByTableId_PrevAndNext

ExpandoColumn[] findByTableId_PrevAndNext(long columnId,
                                        long tableId,
                                        OrderByComparator orderByComparator)
                                          throws SystemException,
                                                 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

SystemException - if a system exception occurred

filterFindByTableId

java.util.List<ExpandoColumn> filterFindByTableId(long tableId)
                                                  throws SystemException

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

Throws:

SystemException - if a system exception occurred

filterFindByTableId

java.util.List<ExpandoColumn> filterFindByTableId(long tableId,
                                                int start,
                                                int end)
                                                  throws SystemException

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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ExpandoColumnModelImpl. 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:

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

Throws:

SystemException - if a system exception occurred

filterFindByTableId

java.util.List<ExpandoColumn> filterFindByTableId(long tableId,
                                                int start,
                                                int end,
                                                OrderByComparator orderByComparator)
                                                  throws SystemException

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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ExpandoColumnModelImpl. 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:

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

Throws:

SystemException - if a system exception occurred

filterFindByTableId_PrevAndNext

ExpandoColumn[] filterFindByTableId_PrevAndNext(long columnId,
                                              long tableId,
                                              OrderByComparator orderByComparator)
                                                throws SystemException,
                                                       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

SystemException - if a system exception occurred

removeByTableId

void removeByTableId(long tableId)
                     throws SystemException

Removes all the expando columns where tableId = ? from the database.

Parameters:

tableId - the table ID

Throws:

SystemException - if a system exception occurred

countByTableId

int countByTableId(long tableId)
                   throws SystemException

Returns the number of expando columns where tableId = ?.

Parameters:

tableId - the table ID

Returns:

the number of matching expando columns

Throws:

SystemException - if a system exception occurred

filterCountByTableId

int filterCountByTableId(long tableId)
                         throws SystemException

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

Throws:

SystemException - if a system exception occurred

findByT_N

java.util.List<ExpandoColumn> findByT_N(long tableId,
                                      java.lang.String[] names)
                                        throws SystemException

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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ExpandoColumnModelImpl. 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:

tableId - the table ID

names - the names

Returns:

the matching expando columns

Throws:

SystemException - if a system exception occurred

findByT_N

java.util.List<ExpandoColumn> findByT_N(long tableId,
                                      java.lang.String[] names,
                                      int start,
                                      int end)
                                        throws SystemException

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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ExpandoColumnModelImpl. 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:

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

Throws:

SystemException - if a system exception occurred

findByT_N

java.util.List<ExpandoColumn> findByT_N(long tableId,
                                      java.lang.String[] names,
                                      int start,
                                      int end,
                                      OrderByComparator orderByComparator)
                                        throws SystemException

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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ExpandoColumnModelImpl. 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:

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

Throws:

SystemException - if a system exception occurred

findByT_N

ExpandoColumn findByT_N(long tableId,
                      java.lang.String name)
                        throws SystemException,
                               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

SystemException - if a system exception occurred

fetchByT_N

ExpandoColumn fetchByT_N(long tableId,
                       java.lang.String name)
                         throws SystemException

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

Throws:

SystemException - if a system exception occurred

fetchByT_N

ExpandoColumn fetchByT_N(long tableId,
                       java.lang.String name,
                       boolean retrieveFromCache)
                         throws SystemException

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

retrieveFromCache - whether to use the finder cache

Returns:

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

Throws:

SystemException - if a system exception occurred

removeByT_N

ExpandoColumn removeByT_N(long tableId,
                        java.lang.String name)
                          throws SystemException,
                                 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:

SystemException - if a system exception occurred

NoSuchColumnException

countByT_N

int countByT_N(long tableId,
             java.lang.String name)
               throws SystemException

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

Throws:

SystemException - if a system exception occurred

countByT_N

int countByT_N(long tableId,
             java.lang.String[] names)
               throws SystemException

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

Throws:

SystemException - if a system exception occurred

filterCountByT_N

int filterCountByT_N(long tableId,
                   java.lang.String name)
                     throws SystemException

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

Throws:

SystemException - if a system exception occurred

filterCountByT_N

int filterCountByT_N(long tableId,
                   java.lang.String[] names)
                     throws SystemException

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

Throws:

SystemException - if a system exception occurred

cacheResult

void cacheResult(ExpandoColumn expandoColumn)

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

Parameters:

expandoColumn - the expando column

cacheResult

void cacheResult(java.util.List<ExpandoColumn> expandoColumns)

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

Parameters:

expandoColumns - the expando columns

create

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

ExpandoColumn remove(long columnId)
                     throws SystemException,
                            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

SystemException - if a system exception occurred

updateImpl

ExpandoColumn updateImpl(ExpandoColumn expandoColumn)
                         throws SystemException

Throws:

SystemException

findByPrimaryKey

ExpandoColumn findByPrimaryKey(long columnId)
                               throws SystemException,
                                      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

SystemException - if a system exception occurred

fetchByPrimaryKey

ExpandoColumn fetchByPrimaryKey(long columnId)
                                throws SystemException

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

Throws:

SystemException - if a system exception occurred

findAll

java.util.List<ExpandoColumn> findAll()
                                      throws SystemException

Returns all the expando columns.

Returns:

the expando columns

Throws:

SystemException - if a system exception occurred

findAll

java.util.List<ExpandoColumn> findAll(int start,
                                    int end)
                                      throws SystemException

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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ExpandoColumnModelImpl. 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 columns

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

Returns:

the range of expando columns

Throws:

SystemException - if a system exception occurred

findAll

java.util.List<ExpandoColumn> findAll(int start,
                                    int end,
                                    OrderByComparator orderByComparator)
                                      throws SystemException

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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ExpandoColumnModelImpl. 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 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

Throws:

SystemException - if a system exception occurred

removeAll

void removeAll()
               throws SystemException

Removes all the expando columns from the database.

Throws:

SystemException - if a system exception occurred

countAll

int countAll()
             throws SystemException

Returns the number of expando columns.

Returns:

the number of expando columns

Throws:

SystemException - if a system exception occurred