com.liferay.portal.kernel.service.persistence

Interface ClusterGroupPersistence

All Superinterfaces:

BasePersistence<ClusterGroup>

@ProviderType
public interface ClusterGroupPersistence
extends BasePersistence<ClusterGroup>

The persistence interface for the cluster group service.

Caching information and settings can be found in portal.properties

Author:

Brian Wing Shun Chan

See Also:

ClusterGroupPersistenceImpl, ClusterGroupUtil

{$generated.description}

Method Summary

Modifier and Type	Method and Description
void	cacheResult(ClusterGroup clusterGroup) Caches the cluster group in the entity cache if it is enabled.
void	cacheResult(List<ClusterGroup> clusterGroups) Caches the cluster groups in the entity cache if it is enabled.
int	countAll() Returns the number of cluster groups.
ClusterGroup	create(long clusterGroupId) Creates a new cluster group with the primary key.
ClusterGroup	fetchByPrimaryKey(long clusterGroupId) Returns the cluster group with the primary key or returns null if it could not be found.
Map<Serializable,ClusterGroup>	fetchByPrimaryKeys(Set<Serializable> primaryKeys)
List<ClusterGroup>	findAll() Returns all the cluster groups.
List<ClusterGroup>	findAll(int start, int end) Returns a range of all the cluster groups.
List<ClusterGroup>	findAll(int start, int end, OrderByComparator<ClusterGroup> orderByComparator) Returns an ordered range of all the cluster groups.
List<ClusterGroup>	findAll(int start, int end, OrderByComparator<ClusterGroup> orderByComparator, boolean retrieveFromCache) Returns an ordered range of all the cluster groups.
ClusterGroup	findByPrimaryKey(long clusterGroupId) Returns the cluster group with the primary key or throws a NoSuchClusterGroupException if it could not be found.
ClusterGroup	remove(long clusterGroupId) Removes the cluster group with the primary key from the database.
void	removeAll() Removes all the cluster groups from the database.
ClusterGroup	updateImpl(ClusterGroup clusterGroup)

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

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

Method Detail

cacheResult

void cacheResult(ClusterGroup clusterGroup)

Caches the cluster group in the entity cache if it is enabled.

Parameters:

clusterGroup - the cluster group

cacheResult

void cacheResult(List<ClusterGroup> clusterGroups)

Caches the cluster groups in the entity cache if it is enabled.

Parameters:

clusterGroups - the cluster groups

create

ClusterGroup create(long clusterGroupId)

Creates a new cluster group with the primary key. Does not add the cluster group to the database.

Parameters:

clusterGroupId - the primary key for the new cluster group

Returns:

the new cluster group

remove

ClusterGroup remove(long clusterGroupId)
             throws NoSuchClusterGroupException

Removes the cluster group with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

clusterGroupId - the primary key of the cluster group

Returns:

the cluster group that was removed

Throws:

NoSuchClusterGroupException - if a cluster group with the primary key could not be found

updateImpl

ClusterGroup updateImpl(ClusterGroup clusterGroup)

findByPrimaryKey

ClusterGroup findByPrimaryKey(long clusterGroupId)
                       throws NoSuchClusterGroupException

Returns the cluster group with the primary key or throws a NoSuchClusterGroupException if it could not be found.

Parameters:

clusterGroupId - the primary key of the cluster group

Returns:

the cluster group

Throws:

NoSuchClusterGroupException - if a cluster group with the primary key could not be found

fetchByPrimaryKey

ClusterGroup fetchByPrimaryKey(long clusterGroupId)

Returns the cluster group with the primary key or returns null if it could not be found.

Parameters:

clusterGroupId - the primary key of the cluster group

Returns:

the cluster group, or null if a cluster group with the primary key could not be found

fetchByPrimaryKeys

Map<Serializable,ClusterGroup> fetchByPrimaryKeys(Set<Serializable> primaryKeys)

Specified by:

fetchByPrimaryKeys in interface BasePersistence<ClusterGroup>

findAll

List<ClusterGroup> findAll()

Returns all the cluster groups.

Returns:

the cluster groups

findAll

List<ClusterGroup> findAll(int start,
                           int end)

Returns a range of all the cluster groups.

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 ClusterGroupModelImpl. 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 cluster groups

end - the upper bound of the range of cluster groups (not inclusive)

Returns:

the range of cluster groups

findAll

List<ClusterGroup> findAll(int start,
                           int end,
                           OrderByComparator<ClusterGroup> orderByComparator)

Returns an ordered range of all the cluster groups.

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 ClusterGroupModelImpl. 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 cluster groups

end - the upper bound of the range of cluster groups (not inclusive)

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

Returns:

the ordered range of cluster groups

findAll

List<ClusterGroup> findAll(int start,
                           int end,
                           OrderByComparator<ClusterGroup> orderByComparator,
                           boolean retrieveFromCache)

Returns an ordered range of all the cluster groups.

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 ClusterGroupModelImpl. 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 cluster groups

end - the upper bound of the range of cluster groups (not inclusive)

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

retrieveFromCache - whether to retrieve from the finder cache

Returns:

the ordered range of cluster groups

removeAll

void removeAll()

Removes all the cluster groups from the database.

countAll

int countAll()

Returns the number of cluster groups.

Returns:

the number of cluster groups