com.liferay.counter.service
Interface CounterLocalService

All Known Implementing Classes:

CounterLocalServiceBaseImpl, CounterLocalServiceImpl, CounterLocalServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface CounterLocalService

The interface for the counter local service.

Never modify or reference this interface directly. Always use CounterLocalServiceUtil to access the counter local service. Add custom service methods to CounterLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

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:

CounterLocalServiceUtil, CounterLocalServiceBaseImpl, CounterLocalServiceImpl

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

Method Summary

Counter	addCounter(Counter counter) Adds the counter to the database.
Counter	createCounter(String name) Creates a new counter with the primary key.
void	deleteCounter(Counter counter) Deletes the counter from the database.
void	deleteCounter(String name) Deletes the counter with the primary key from the database.
List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
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.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Counts the number of rows that match the dynamic query.
Counter	getCounter(String name) Gets the counter with the primary key.
List<Counter>	getCounters(int start, int end) Gets a range of all the counters.
int	getCountersCount() Gets the number of counters.
List<String>	getNames()
long	increment()
long	increment(String name)
long	increment(String name, int size)
void	rename(String oldName, String newName)
void	reset(String name)
void	reset(String name, long size)
Counter	updateCounter(Counter counter) Updates the counter in the database.
Counter	updateCounter(Counter counter, boolean merge) Updates the counter in the database.

Method Detail

addCounter

Counter addCounter(Counter counter)
                   throws SystemException

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

Parameters:

counter - the counter to add

Returns:

the counter that was added

Throws:

SystemException - if a system exception occurred

createCounter

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

void 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 to delete

Throws:

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

SystemException - if a system exception occurred

deleteCounter

void deleteCounter(Counter counter)
                   throws SystemException

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

Parameters:

counter - the counter to delete

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException

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

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

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 to search with

start - the lower bound of the range of model instances to return

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

Returns:

the range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

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 to search with

start - the lower bound of the range of model instances to return

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

orderByComparator - the comparator to order the results by

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException

Counts the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

getCounter

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Counter getCounter(String name)
                   throws PortalException,
                          SystemException

Gets the counter with the primary key.

Parameters:

name - the primary key of the counter to get

Returns:

the counter

Throws:

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

SystemException - if a system exception occurred

getCounters

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Counter> getCounters(int start,
                                                                   int end)
                          throws SystemException

Gets 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

getCountersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCountersCount()
                     throws SystemException

Gets the number of counters.

Returns:

the number of counters

Throws:

SystemException - if a system exception occurred

updateCounter

Counter updateCounter(Counter counter)
                      throws SystemException

Updates the counter in the database. Also notifies the appropriate model listeners.

Parameters:

counter - the counter to update

Returns:

the counter that was updated

Throws:

SystemException - if a system exception occurred

updateCounter

Counter updateCounter(Counter counter,
                      boolean merge)
                      throws SystemException

Updates the counter in the database. Also notifies the appropriate model listeners.

Parameters:

counter - the counter to update

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

getNames

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<String> getNames()
                      throws SystemException

Throws:

SystemException

increment

long increment()
               throws SystemException

Throws:

SystemException

increment

long increment(String name)
               throws SystemException

Throws:

SystemException

increment

long increment(String name,
               int size)
               throws SystemException

Throws:

SystemException

rename

void rename(String oldName,
            String newName)
            throws SystemException

Throws:

SystemException

reset

void reset(String name)
           throws SystemException

Throws:

SystemException

reset

void reset(String name,
           long size)
           throws SystemException

Throws:

SystemException