com.liferay.counter.kernel.service.persistence

Class CounterUtil

Object

com.liferay.counter.kernel.service.persistence.CounterUtil

@ProviderType
public class CounterUtil
extends Object

The persistence utility for the counter service. This utility wraps CounterPersistenceImpl and provides direct access to the database for CRUD operations. This utility should only be used by the service layer, as it must operate within a transaction. Never access this utility in a JSP, controller, model, or other front-end class.

Caching information and settings can be found in portal.properties

Author:

Brian Wing Shun Chan

See Also:

CounterPersistence, CounterPersistenceImpl

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
CounterUtil()

Method Summary

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

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CounterUtil

public CounterUtil()

Method Detail

clearCache

public static void clearCache()

See Also:

BasePersistence.clearCache()

clearCache

public static void clearCache(Counter counter)

See Also:

BasePersistence.clearCache(com.liferay.portal.kernel.model.BaseModel)

countWithDynamicQuery

public static long countWithDynamicQuery(DynamicQuery dynamicQuery)

See Also:

BasePersistence.countWithDynamicQuery(DynamicQuery)

findWithDynamicQuery

public static List<Counter> findWithDynamicQuery(DynamicQuery dynamicQuery)

See Also:

BasePersistence.findWithDynamicQuery(DynamicQuery)

findWithDynamicQuery

public static List<Counter> findWithDynamicQuery(DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end)

See Also:

BasePersistence.findWithDynamicQuery(DynamicQuery, int, int)

findWithDynamicQuery

public static List<Counter> findWithDynamicQuery(DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end,
                                                 OrderByComparator<Counter> orderByComparator)

See Also:

BasePersistence.findWithDynamicQuery(DynamicQuery, int, int, OrderByComparator)

update

public static Counter update(Counter counter)

See Also:

BasePersistence.update(com.liferay.portal.kernel.model.BaseModel)

update

public static Counter update(Counter counter,
                             ServiceContext serviceContext)

See Also:

BasePersistence.update(com.liferay.portal.kernel.model.BaseModel, ServiceContext)

cacheResult

public static void cacheResult(Counter counter)

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

Parameters:

counter - the counter

cacheResult

public static void cacheResult(List<Counter> counters)

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

Parameters:

counters - the counters

create

public static 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

public static 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

public static Counter updateImpl(Counter counter)

findByPrimaryKey

public static 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

public static 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

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

findAll

public static List<Counter> findAll()

Returns all the counters.

Returns:

the counters

findAll

public static 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

public static 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

public static 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

public static void removeAll()

Removes all the counters from the database.

countAll

public static int countAll()

Returns the number of counters.

Returns:

the number of counters

getPersistence

public static CounterPersistence getPersistence()