com.liferay.portlet.expando.service.persistence
Interface ExpandoColumnPersistence

All Superinterfaces:

BasePersistence<ExpandoColumn>

All Known Implementing Classes:

ExpandoColumnPersistenceImpl

public interface ExpandoColumnPersistence
extends BasePersistence<ExpandoColumn>

The persistence interface for the expando column service.

Never modify or reference this interface directly. Always use ExpandoColumnUtil to access the expando column persistence. Modify service.xml and rerun ServiceBuilder to regenerate this interface.

Caching information and settings can be found in portal.properties

See Also:

ExpandoColumnPersistenceImpl, ExpandoColumnUtil

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary

void	cacheResult(ExpandoColumn expandoColumn) Caches the expando column in the entity cache if it is enabled.
void	cacheResult(List<ExpandoColumn> expandoColumns) Caches the expando columns in the entity cache if it is enabled.
int	countAll() Counts all the expando columns.
int	countByT_N(long tableId, String name) Counts all the expando columns where tableId = ? and name = ?.
int	countByTableId(long tableId) Counts all the expando columns where tableId = ?.
ExpandoColumn	create(long columnId) Creates a new expando column with the primary key.
ExpandoColumn	fetchByPrimaryKey(long columnId) Finds the expando column with the primary key or returns null if it could not be found.
ExpandoColumn	fetchByT_N(long tableId, String name) Finds the expando column where tableId = ? and name = ? or returns null if it could not be found.
ExpandoColumn	fetchByT_N(long tableId, String name, boolean retrieveFromCache) Finds the expando column where tableId = ? and name = ? or returns null if it could not be found, optionally using the finder cache.
List<ExpandoColumn>	findAll() Finds all the expando columns.
List<ExpandoColumn>	findAll(int start, int end) Finds a range of all the expando columns.
List<ExpandoColumn>	findAll(int start, int end, OrderByComparator orderByComparator) Finds an ordered range of all the expando columns.
ExpandoColumn	findByPrimaryKey(long columnId) Finds the expando column with the primary key or throws a NoSuchColumnException if it could not be found.
ExpandoColumn	findByT_N(long tableId, String name) Finds the expando column where tableId = ? and name = ? or throws a NoSuchColumnException if it could not be found.
ExpandoColumn	findByTableId_First(long tableId, OrderByComparator orderByComparator) Finds the first expando column in the ordered set where tableId = ?.
ExpandoColumn	findByTableId_Last(long tableId, OrderByComparator orderByComparator) Finds the last expando column in the ordered set where tableId = ?.
ExpandoColumn[]	findByTableId_PrevAndNext(long columnId, long tableId, OrderByComparator orderByComparator) Finds the expando columns before and after the current expando column in the ordered set where tableId = ?.
List<ExpandoColumn>	findByTableId(long tableId) Finds all the expando columns where tableId = ?.
List<ExpandoColumn>	findByTableId(long tableId, int start, int end) Finds a range of all the expando columns where tableId = ?.
List<ExpandoColumn>	findByTableId(long tableId, int start, int end, OrderByComparator orderByComparator) Finds 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.
void	removeByT_N(long tableId, 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, boolean merge)

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

clearCache, clearCache, countWithDynamicQuery, fetchByPrimaryKey, findByPrimaryKey, findWithDynamicQuery, findWithDynamicQuery, findWithDynamicQuery, getDataSource, getListeners, registerListener, remove, remove, setDataSource, unregisterListener, update, update

Method Detail

cacheResult

void cacheResult(ExpandoColumn expandoColumn)

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

Parameters:

expandoColumn - the expando column to cache

cacheResult

void cacheResult(List<ExpandoColumn> expandoColumns)

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

Parameters:

expandoColumns - the expando columns to cache

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 to remove

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,
                         boolean merge)
                         throws SystemException

Throws:

SystemException

findByPrimaryKey

ExpandoColumn findByPrimaryKey(long columnId)
                               throws SystemException,
                                      NoSuchColumnException

Finds 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 to find

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

Finds 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 to find

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

findByTableId

List<ExpandoColumn> findByTableId(long tableId)
                                  throws SystemException

Finds all the expando columns where tableId = ?.

Parameters:

tableId - the table id to search with

Returns:

the matching expando columns

Throws:

SystemException - if a system exception occurred

findByTableId

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

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

Parameters:

tableId - the table id to search with

start - the lower bound of the range of expando columns to return

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

Returns:

the range of matching expando columns

Throws:

SystemException - if a system exception occurred

findByTableId

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

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

Parameters:

tableId - the table id to search with

start - the lower bound of the range of expando columns to return

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

orderByComparator - the comparator to order the results by

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

Finds the first expando column in the ordered set 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.

Parameters:

tableId - the table id to search with

orderByComparator - the comparator to order the set by

Returns:

the first matching expando column

Throws:

NoSuchColumnException - if a matching expando column could not be found

SystemException - if a system exception occurred

findByTableId_Last

ExpandoColumn findByTableId_Last(long tableId,
                                 OrderByComparator orderByComparator)
                                 throws SystemException,
                                        NoSuchColumnException

Finds the last expando column in the ordered set 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.

Parameters:

tableId - the table id to search with

orderByComparator - the comparator to order the set by

Returns:

the last matching expando column

Throws:

NoSuchColumnException - if a matching expando column could not be found

SystemException - if a system exception occurred

findByTableId_PrevAndNext

ExpandoColumn[] findByTableId_PrevAndNext(long columnId,
                                          long tableId,
                                          OrderByComparator orderByComparator)
                                          throws SystemException,
                                                 NoSuchColumnException

Finds the expando columns before and after the current expando column in the ordered set 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.

Parameters:

columnId - the primary key of the current expando column

tableId - the table id to search with

orderByComparator - the comparator to order the set by

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

findByT_N

ExpandoColumn findByT_N(long tableId,
                        String name)
                        throws SystemException,
                               NoSuchColumnException

Finds the expando column where tableId = ? and name = ? or throws a NoSuchColumnException if it could not be found.

Parameters:

tableId - the table id to search with

name - the name to search with

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,
                         String name)
                         throws SystemException

Finds 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 to search with

name - the name to search with

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,
                         String name,
                         boolean retrieveFromCache)
                         throws SystemException

Finds 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 to search with

name - the name to search with

Returns:

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

Throws:

SystemException - if a system exception occurred

findAll

List<ExpandoColumn> findAll()
                            throws SystemException

Finds all the expando columns.

Returns:

the expando columns

Throws:

SystemException - if a system exception occurred

findAll

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

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

Parameters:

start - the lower bound of the range of expando columns to return

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

Returns:

the range of expando columns

Throws:

SystemException - if a system exception occurred

findAll

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

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

Parameters:

start - the lower bound of the range of expando columns to return

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

orderByComparator - the comparator to order the results by

Returns:

the ordered range of expando columns

Throws:

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 to search with

Throws:

SystemException - if a system exception occurred

removeByT_N

void removeByT_N(long tableId,
                 String name)
                 throws SystemException,
                        NoSuchColumnException

Removes the expando column where tableId = ? and name = ? from the database.

Parameters:

tableId - the table id to search with

name - the name to search with

Throws:

SystemException - if a system exception occurred

NoSuchColumnException

removeAll

void removeAll()
               throws SystemException

Removes all the expando columns from the database.

Throws:

SystemException - if a system exception occurred

countByTableId

int countByTableId(long tableId)
                   throws SystemException

Counts all the expando columns where tableId = ?.

Parameters:

tableId - the table id to search with

Returns:

the number of matching expando columns

Throws:

SystemException - if a system exception occurred

countByT_N

int countByT_N(long tableId,
               String name)
               throws SystemException

Counts all the expando columns where tableId = ? and name = ?.

Parameters:

tableId - the table id to search with

name - the name to search with

Returns:

the number of matching expando columns

Throws:

SystemException - if a system exception occurred

countAll

int countAll()
             throws SystemException

Counts all the expando columns.

Returns:

the number of expando columns

Throws:

SystemException - if a system exception occurred