com.liferay.counter.kernel.service

Interface CounterLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

CounterLocalServiceWrapper

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

Provides the local service interface for Counter. 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.

Author:

Brian Wing Shun Chan

See Also:

CounterLocalServiceUtil, CounterLocalServiceBaseImpl, CounterLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
Counter	addCounter(Counter counter) Adds the counter to the database.
Counter	createCounter(String name) Creates a new counter with the primary key.
Counter	deleteCounter(Counter counter) Deletes the counter from the database.
Counter	deleteCounter(String name) Deletes the counter with the primary key from the database.
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
DynamicQuery	dynamicQuery()
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
Counter	fetchCounter(String name)
Counter	getCounter(String name) Returns the counter with the primary key.
List<Counter>	getCounters(int start, int end) Returns a range of all the counters.
int	getCountersCount() Returns the number of counters.
List<String>	getNames()
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
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 or adds it if it does not yet exist.

Method Detail

addCounter

@Indexable(type=REINDEX)
Counter addCounter(Counter counter)

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

Parameters:

counter - the counter

Returns:

the counter that was added

createCounter

@Transactional(enabled=false)
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

@Indexable(type=DELETE)
Counter deleteCounter(Counter counter)

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

Parameters:

counter - the counter

Returns:

the counter that was removed

deleteCounter

@Indexable(type=DELETE)
Counter deleteCounter(String name)
                                       throws PortalException

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

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

<T> List<T> dynamicQuery(DynamicQuery dynamicQuery)

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

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                         int start,
                         int end)

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

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

dynamicQuery

<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                         int start,
                         int end,
                         OrderByComparator<T> orderByComparator)

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

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

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                       Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchCounter

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Counter fetchCounter(String name)

getCounter

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

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

getCounters

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Counter> getCounters(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

getCountersCount

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

Returns the number of counters.

Returns:

the number of counters

getNames

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

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                                                                             throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

increment

@Transactional(isolation=COUNTER,
               propagation=REQUIRES_NEW)
long increment()

increment

@Transactional(isolation=COUNTER,
               propagation=REQUIRES_NEW)
long increment(String name)

increment

@Transactional(isolation=COUNTER,
               propagation=REQUIRES_NEW)
long increment(String name,
                                                                                          int size)

rename

@Transactional(isolation=COUNTER,
               propagation=REQUIRES_NEW)
void rename(String oldName,
                                                                                       String newName)

reset

@Transactional(isolation=COUNTER,
               propagation=REQUIRES_NEW)
void reset(String name)

reset

@Transactional(isolation=COUNTER,
               propagation=REQUIRES_NEW)
void reset(String name,
                                                                                      long size)

updateCounter

@Indexable(type=REINDEX)
Counter updateCounter(Counter counter)

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