com.liferay.counter.kernel.service.persistence

Interface CounterPersistence

All Superinterfaces:

BasePersistence<Counter>

@ProviderType
public interface CounterPersistence
extends BasePersistence<Counter>

The persistence interface for the counter service.

Caching information and settings can be found in portal.properties

Author:

Brian Wing Shun Chan

See Also:

CounterPersistenceImpl, CounterUtil

{$generated.description}

Method Summary

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

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(Counter counter)

Caches the counter in the entity cache if it is enabled.

Parameters:

counter - the counter

cacheResult

void cacheResult(List<Counter> counters)

Caches the counters in the entity cache if it is enabled.

Parameters:

counters - the counters

create

Counter create(String name)

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

Parameters:

name - the primary key for the new counter

Returns:

the new counter

remove

Counter remove(String name)
        throws NoSuchCounterException

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

Parameters:

name - the primary key of the counter

Returns:

the counter that was removed

Throws:

NoSuchCounterException - if a counter with the primary key could not be found

updateImpl

Counter updateImpl(Counter counter)

findByPrimaryKey

Counter findByPrimaryKey(String name)
                  throws NoSuchCounterException

Returns the counter with the primary key or throws a NoSuchCounterException if it could not be found.

Parameters:

name - the primary key of the counter

Returns:

the counter

Throws:

NoSuchCounterException - if a counter with the primary key could not be found

fetchByPrimaryKey

Counter fetchByPrimaryKey(String name)

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

Parameters:

name - the primary key of the counter

Returns:

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

fetchByPrimaryKeys

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

Specified by:

fetchByPrimaryKeys in interface BasePersistence<Counter>

findAll

List<Counter> findAll()

Returns all the counters.

Returns:

the counters

findAll

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

Returns a range of all the counters.

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 CounterModelImpl. 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 counters

end - the upper bound of the range of counters (not inclusive)

Returns:

the range of counters

findAll

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

Returns an ordered range of all the counters.

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 CounterModelImpl. 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 counters

end - the upper bound of the range of counters (not inclusive)

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

Returns:

the ordered range of counters

findAll

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

Returns an ordered range of all the counters.

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 CounterModelImpl. 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 counters

end - the upper bound of the range of counters (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 counters

removeAll

void removeAll()

Removes all the counters from the database.

countAll

int countAll()

Returns the number of counters.

Returns:

the number of counters