com.liferay.counter.service
Class CounterLocalServiceUtil

java.lang.Object
  com.liferay.counter.service.CounterLocalServiceUtil

public class CounterLocalServiceUtil
extends Object

The utility for the counter local service. This utility wraps com.liferay.counter.service.impl.CounterLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

See Also:

CounterLocalService, com.liferay.counter.service.base.CounterLocalServiceBaseImpl, com.liferay.counter.service.impl.CounterLocalServiceImpl

Constructor Summary

CounterLocalServiceUtil()

Method Summary

static Counter	addCounter(Counter counter) Adds the counter to the database.
static Counter	createCounter(String name) Creates a new counter with the primary key.
static Counter	deleteCounter(Counter counter) Deletes the counter from the database.
static Counter	deleteCounter(String name) Deletes the counter with the primary key from the database.
static DynamicQuery	dynamicQuery()
static List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows that match the dynamic query.
static Counter	fetchCounter(String name)
static String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static Counter	getCounter(String name) Returns the counter with the primary key.
static List<Counter>	getCounters(int start, int end) Returns a range of all the counters.
static int	getCountersCount() Returns the number of counters.
static List<String>	getNames()
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static CounterLocalService	getService()
static long	increment()
static long	increment(String name)
static long	increment(String name, int size)
static void	rename(String oldName, String newName)
static void	reset(String name)
static void	reset(String name, long size)
static void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(CounterLocalService service) Deprecated.
static Counter	updateCounter(Counter counter) Updates the counter in the database or adds it if it does not yet exist.
static Counter	updateCounter(Counter counter, boolean merge) Updates the counter in the database or adds it if it does not yet exist.

Methods inherited from class java.lang.Object

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

Constructor Detail

CounterLocalServiceUtil

public CounterLocalServiceUtil()

Method Detail

addCounter

public static Counter addCounter(Counter counter)
                          throws SystemException

Adds the counter to the database. Also notifies the appropriate model listeners.

Parameters:

counter - the counter

Returns:

the counter that was added

Throws:

SystemException - if a system exception occurred

createCounter

public static Counter createCounter(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

deleteCounter

public static Counter deleteCounter(String name)
                             throws PortalException,
                                    SystemException

Deletes 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:

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

SystemException - if a system exception occurred

deleteCounter

public static Counter deleteCounter(Counter counter)
                             throws SystemException

Deletes the counter from the database. Also notifies the appropriate model listeners.

Parameters:

counter - the counter

Returns:

the counter that was removed

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end)
                         throws SystemException

Performs a dynamic query on the database and returns a range of the matching rows.

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:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

Returns:

the range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                         throws SystemException

Performs a dynamic query on the database and returns an ordered range of the matching rows.

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:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

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

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchCounter

public static Counter fetchCounter(String name)
                            throws SystemException

Throws:

SystemException

getCounter

public static Counter getCounter(String name)
                          throws PortalException,
                                 SystemException

Returns the counter with the primary key.

Parameters:

name - the primary key of the counter

Returns:

the counter

Throws:

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

SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getCounters

public static List<Counter> getCounters(int start,
                                        int end)
                                 throws SystemException

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.

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

Throws:

SystemException - if a system exception occurred

getCountersCount

public static int getCountersCount()
                            throws SystemException

Returns the number of counters.

Returns:

the number of counters

Throws:

SystemException - if a system exception occurred

updateCounter

public static Counter updateCounter(Counter counter)
                             throws SystemException

Updates the counter in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

counter - the counter

Returns:

the counter that was updated

Throws:

SystemException - if a system exception occurred

updateCounter

public static Counter updateCounter(Counter counter,
                                    boolean merge)
                             throws SystemException

Updates the counter in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

counter - the counter

merge - whether to merge the counter with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.

Returns:

the counter that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

public static String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

getNames

public static List<String> getNames()
                             throws SystemException

Throws:

SystemException

increment

public static long increment()
                      throws SystemException

Throws:

SystemException

increment

public static long increment(String name)
                      throws SystemException

Throws:

SystemException

increment

public static long increment(String name,
                             int size)
                      throws SystemException

Throws:

SystemException

rename

public static void rename(String oldName,
                          String newName)
                   throws SystemException

Throws:

SystemException

reset

public static void reset(String name)
                  throws SystemException

Throws:

SystemException

reset

public static void reset(String name,
                         long size)
                  throws SystemException

Throws:

SystemException

getService

public static CounterLocalService getService()

setService

public void setService(CounterLocalService service)

Deprecated.