com.liferay.counter.service.persistence
Interface CounterPersistence

All Superinterfaces:

BasePersistence<Counter>

All Known Implementing Classes:

CounterPersistenceImpl

public interface CounterPersistence
extends BasePersistence<Counter>

The persistence interface for the counter service.

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

Caching information and settings can be found in portal.properties

See Also:

CounterPersistenceImpl, CounterUtil

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

Method Summary

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() Counts all the counters.
Counter	create(String name) Creates a new counter with the primary key.
Counter	fetchByPrimaryKey(String name) Finds the counter with the primary key or returns null if it could not be found.
List<Counter>	findAll() Finds all the counters.
List<Counter>	findAll(int start, int end) Finds a range of all the counters.
List<Counter>	findAll(int start, int end, OrderByComparator orderByComparator) Finds an ordered range of all the counters.
Counter	findByPrimaryKey(String name) Finds 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, 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(Counter counter)

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

Parameters:

counter - the counter to cache

cacheResult

void cacheResult(List<Counter> counters)

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

Parameters:

counters - the counters to cache

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,
                      SystemException

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

Parameters:

name - the primary key of the counter to remove

Returns:

the counter that was removed

Throws:

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

SystemException - if a system exception occurred

updateImpl

Counter updateImpl(Counter counter,
                   boolean merge)
                   throws SystemException

Throws:

SystemException

findByPrimaryKey

Counter findByPrimaryKey(String name)
                         throws NoSuchCounterException,
                                SystemException

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

Parameters:

name - the primary key of the counter to find

Returns:

the counter

Throws:

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

SystemException - if a system exception occurred

fetchByPrimaryKey

Counter fetchByPrimaryKey(String name)
                          throws SystemException

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

Parameters:

name - the primary key of the counter to find

Returns:

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

Throws:

SystemException - if a system exception occurred

findAll

List<Counter> findAll()
                      throws SystemException

Finds all the counters.

Returns:

the counters

Throws:

SystemException - if a system exception occurred

findAll

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

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

Parameters:

start - the lower bound of the range of counters to return

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

Returns:

the range of counters

Throws:

SystemException - if a system exception occurred

findAll

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

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

Parameters:

start - the lower bound of the range of counters to return

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

orderByComparator - the comparator to order the results by

Returns:

the ordered range of counters

Throws:

SystemException - if a system exception occurred

removeAll

void removeAll()
               throws SystemException

Removes all the counters from the database.

Throws:

SystemException - if a system exception occurred

countAll

int countAll()
             throws SystemException

Counts all the counters.

Returns:

the number of counters

Throws:

SystemException - if a system exception occurred