Liferay 6.1.2-ce-ga3

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

All Superinterfaces:
BasePersistence<ExpandoTable>

public interface ExpandoTablePersistence
extends BasePersistence<ExpandoTable>

The persistence interface for the expando table service.

Caching information and settings can be found in portal.properties

See Also:
ExpandoTablePersistenceImpl, ExpandoTableUtil

Method Summary
 void cacheResult(ExpandoTable expandoTable)
          Caches the expando table in the entity cache if it is enabled.
 void cacheResult(List<ExpandoTable> expandoTables)
          Caches the expando tables in the entity cache if it is enabled.
 int countAll()
          Returns the number of expando tables.
 int countByC_C_N(long companyId, long classNameId, String name)
          Returns the number of expando tables where companyId = ? and classNameId = ? and name = ?.
 int countByC_C(long companyId, long classNameId)
          Returns the number of expando tables where companyId = ? and classNameId = ?.
 ExpandoTable create(long tableId)
          Creates a new expando table with the primary key.
 ExpandoTable fetchByC_C_First(long companyId, long classNameId, OrderByComparator orderByComparator)
          Returns the first expando table in the ordered set where companyId = ? and classNameId = ?.
 ExpandoTable fetchByC_C_Last(long companyId, long classNameId, OrderByComparator orderByComparator)
          Returns the last expando table in the ordered set where companyId = ? and classNameId = ?.
 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.
 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.
 ExpandoTable fetchByPrimaryKey(long tableId)
          Returns the expando table with the primary key or returns null if it could not be found.
 List<ExpandoTable> findAll()
          Returns all the expando tables.
 List<ExpandoTable> findAll(int start, int end)
          Returns a range of all the expando tables.
 List<ExpandoTable> findAll(int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the expando tables.
 ExpandoTable findByC_C_First(long companyId, long classNameId, OrderByComparator orderByComparator)
          Returns the first expando table in the ordered set where companyId = ? and classNameId = ?.
 ExpandoTable findByC_C_Last(long companyId, long classNameId, OrderByComparator orderByComparator)
          Returns the last expando table in the ordered set where companyId = ? and classNameId = ?.
 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.
 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 = ?.
 List<ExpandoTable> findByC_C(long companyId, long classNameId)
          Returns all the expando tables where companyId = ? and classNameId = ?.
 List<ExpandoTable> findByC_C(long companyId, long classNameId, int start, int end)
          Returns a range of all the expando tables where companyId = ? and classNameId = ?.
 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 = ?.
 ExpandoTable findByPrimaryKey(long tableId)
          Returns the expando table with the primary key or throws a NoSuchTableException if it could not be found.
 ExpandoTable remove(long tableId)
          Removes the expando table with the primary key from the database.
 void removeAll()
          Removes all the expando tables from the database.
 ExpandoTable removeByC_C_N(long companyId, long classNameId, String name)
          Removes the expando table where companyId = ? and classNameId = ? and name = ? from the database.
 void removeByC_C(long companyId, long classNameId)
          Removes all the expando tables where companyId = ? and classNameId = ? from the database.
 ExpandoTable updateImpl(ExpandoTable expandoTable, boolean merge)
           
 
Methods inherited from interface com.liferay.portal.service.persistence.BasePersistence
clearCache, clearCache, clearCache, closeSession, countWithDynamicQuery, fetchByPrimaryKey, findByPrimaryKey, findWithDynamicQuery, findWithDynamicQuery, findWithDynamicQuery, getDataSource, getListeners, openSession, processException, registerListener, remove, remove, setDataSource, unregisterListener, update, update
 

Method Detail

cacheResult

void cacheResult(ExpandoTable expandoTable)
Caches the expando table in the entity cache if it is enabled.

Parameters:
expandoTable - the expando table

cacheResult

void cacheResult(List<ExpandoTable> expandoTables)
Caches the expando tables in the entity cache if it is enabled.

Parameters:
expandoTables - the expando tables

create

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

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

ExpandoTable updateImpl(ExpandoTable expandoTable,
                        boolean merge)
                        throws SystemException
Throws:
SystemException

findByPrimaryKey

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

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

findByC_C

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

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.

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

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.

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

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

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

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

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

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

findByC_C_N

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

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

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

findAll

List<ExpandoTable> findAll()
                           throws SystemException
Returns all the expando tables.

Returns:
the expando tables
Throws:
SystemException - if a system exception occurred

findAll

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.

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

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.

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

removeByC_C

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

removeByC_C_N

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

removeAll

void removeAll()
               throws SystemException
Removes all the expando tables from the database.

Throws:
SystemException - if a system exception occurred

countByC_C

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

countByC_C_N

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

countAll

int countAll()
             throws SystemException
Returns the number of expando tables.

Returns:
the number of expando tables
Throws:
SystemException - if a system exception occurred

Liferay 6.1.2-ce-ga3