Liferay 6.1.2-ce-ga3

com.liferay.portal.service.persistence
Interface ListTypePersistence

All Superinterfaces:
BasePersistence<ListType>
All Known Implementing Classes:
ListTypePersistenceImpl

public interface ListTypePersistence
extends BasePersistence<ListType>

The persistence interface for the list type service.

Caching information and settings can be found in portal.properties

See Also:
ListTypePersistenceImpl, ListTypeUtil
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 void cacheResult(List<ListType> listTypes)
          Caches the list types in the entity cache if it is enabled.
 void cacheResult(ListType listType)
          Caches the list type in the entity cache if it is enabled.
 int countAll()
          Returns the number of list types.
 int countByType(String type)
          Returns the number of list types where type = ?.
 ListType create(int listTypeId)
          Creates a new list type with the primary key.
 ListType fetchByPrimaryKey(int listTypeId)
          Returns the list type with the primary key or returns null if it could not be found.
 ListType fetchByType_First(String type, OrderByComparator orderByComparator)
          Returns the first list type in the ordered set where type = ?.
 ListType fetchByType_Last(String type, OrderByComparator orderByComparator)
          Returns the last list type in the ordered set where type = ?.
 List<ListType> findAll()
          Returns all the list types.
 List<ListType> findAll(int start, int end)
          Returns a range of all the list types.
 List<ListType> findAll(int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the list types.
 ListType findByPrimaryKey(int listTypeId)
          Returns the list type with the primary key or throws a NoSuchListTypeException if it could not be found.
 ListType findByType_First(String type, OrderByComparator orderByComparator)
          Returns the first list type in the ordered set where type = ?.
 ListType findByType_Last(String type, OrderByComparator orderByComparator)
          Returns the last list type in the ordered set where type = ?.
 ListType[] findByType_PrevAndNext(int listTypeId, String type, OrderByComparator orderByComparator)
          Returns the list types before and after the current list type in the ordered set where type = ?.
 List<ListType> findByType(String type)
          Returns all the list types where type = ?.
 List<ListType> findByType(String type, int start, int end)
          Returns a range of all the list types where type = ?.
 List<ListType> findByType(String type, int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the list types where type = ?.
 ListType remove(int listTypeId)
          Removes the list type with the primary key from the database.
 void removeAll()
          Removes all the list types from the database.
 void removeByType(String type)
          Removes all the list types where type = ? from the database.
 ListType updateImpl(ListType listType, 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(ListType listType)
Caches the list type in the entity cache if it is enabled.

Parameters:
listType - the list type

cacheResult

void cacheResult(List<ListType> listTypes)
Caches the list types in the entity cache if it is enabled.

Parameters:
listTypes - the list types

create

ListType create(int listTypeId)
Creates a new list type with the primary key. Does not add the list type to the database.

Parameters:
listTypeId - the primary key for the new list type
Returns:
the new list type

remove

ListType remove(int listTypeId)
                throws NoSuchListTypeException,
                       SystemException
Removes the list type with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
listTypeId - the primary key of the list type
Returns:
the list type that was removed
Throws:
NoSuchListTypeException - if a list type with the primary key could not be found
SystemException - if a system exception occurred

updateImpl

ListType updateImpl(ListType listType,
                    boolean merge)
                    throws SystemException
Throws:
SystemException

findByPrimaryKey

ListType findByPrimaryKey(int listTypeId)
                          throws NoSuchListTypeException,
                                 SystemException
Returns the list type with the primary key or throws a NoSuchListTypeException if it could not be found.

Parameters:
listTypeId - the primary key of the list type
Returns:
the list type
Throws:
NoSuchListTypeException - if a list type with the primary key could not be found
SystemException - if a system exception occurred

fetchByPrimaryKey

ListType fetchByPrimaryKey(int listTypeId)
                           throws SystemException
Returns the list type with the primary key or returns null if it could not be found.

Parameters:
listTypeId - the primary key of the list type
Returns:
the list type, or null if a list type with the primary key could not be found
Throws:
SystemException - if a system exception occurred

findByType

List<ListType> findByType(String type)
                          throws SystemException
Returns all the list types where type = ?.

Parameters:
type - the type
Returns:
the matching list types
Throws:
SystemException - if a system exception occurred

findByType

List<ListType> findByType(String type,
                          int start,
                          int end)
                          throws SystemException
Returns a range of all the list types where type = ?.

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:
type - the type
start - the lower bound of the range of list types
end - the upper bound of the range of list types (not inclusive)
Returns:
the range of matching list types
Throws:
SystemException - if a system exception occurred

findByType

List<ListType> findByType(String type,
                          int start,
                          int end,
                          OrderByComparator orderByComparator)
                          throws SystemException
Returns an ordered range of all the list types where type = ?.

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:
type - the type
start - the lower bound of the range of list types
end - the upper bound of the range of list types (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of matching list types
Throws:
SystemException - if a system exception occurred

findByType_First

ListType findByType_First(String type,
                          OrderByComparator orderByComparator)
                          throws NoSuchListTypeException,
                                 SystemException
Returns the first list type in the ordered set where type = ?.

Parameters:
type - the type
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the first matching list type
Throws:
NoSuchListTypeException - if a matching list type could not be found
SystemException - if a system exception occurred

fetchByType_First

ListType fetchByType_First(String type,
                           OrderByComparator orderByComparator)
                           throws SystemException
Returns the first list type in the ordered set where type = ?.

Parameters:
type - the type
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the first matching list type, or null if a matching list type could not be found
Throws:
SystemException - if a system exception occurred

findByType_Last

ListType findByType_Last(String type,
                         OrderByComparator orderByComparator)
                         throws NoSuchListTypeException,
                                SystemException
Returns the last list type in the ordered set where type = ?.

Parameters:
type - the type
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the last matching list type
Throws:
NoSuchListTypeException - if a matching list type could not be found
SystemException - if a system exception occurred

fetchByType_Last

ListType fetchByType_Last(String type,
                          OrderByComparator orderByComparator)
                          throws SystemException
Returns the last list type in the ordered set where type = ?.

Parameters:
type - the type
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the last matching list type, or null if a matching list type could not be found
Throws:
SystemException - if a system exception occurred

findByType_PrevAndNext

ListType[] findByType_PrevAndNext(int listTypeId,
                                  String type,
                                  OrderByComparator orderByComparator)
                                  throws NoSuchListTypeException,
                                         SystemException
Returns the list types before and after the current list type in the ordered set where type = ?.

Parameters:
listTypeId - the primary key of the current list type
type - the type
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the previous, current, and next list type
Throws:
NoSuchListTypeException - if a list type with the primary key could not be found
SystemException - if a system exception occurred

findAll

List<ListType> findAll()
                       throws SystemException
Returns all the list types.

Returns:
the list types
Throws:
SystemException - if a system exception occurred

findAll

List<ListType> findAll(int start,
                       int end)
                       throws SystemException
Returns a range of all the list types.

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 list types
end - the upper bound of the range of list types (not inclusive)
Returns:
the range of list types
Throws:
SystemException - if a system exception occurred

findAll

List<ListType> findAll(int start,
                       int end,
                       OrderByComparator orderByComparator)
                       throws SystemException
Returns an ordered range of all the list types.

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 list types
end - the upper bound of the range of list types (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of list types
Throws:
SystemException - if a system exception occurred

removeByType

void removeByType(String type)
                  throws SystemException
Removes all the list types where type = ? from the database.

Parameters:
type - the type
Throws:
SystemException - if a system exception occurred

removeAll

void removeAll()
               throws SystemException
Removes all the list types from the database.

Throws:
SystemException - if a system exception occurred

countByType

int countByType(String type)
                throws SystemException
Returns the number of list types where type = ?.

Parameters:
type - the type
Returns:
the number of matching list types
Throws:
SystemException - if a system exception occurred

countAll

int countAll()
             throws SystemException
Returns the number of list types.

Returns:
the number of list types
Throws:
SystemException - if a system exception occurred

Liferay 6.1.2-ce-ga3