Liferay 6.1.2-ce-ga3

com.liferay.counter.service
Interface CounterLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
CounterLocalServiceWrapper

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

The interface for the counter local service.

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, com.liferay.counter.service.base.CounterLocalServiceBaseImpl, com.liferay.counter.service.impl.CounterLocalServiceImpl

Method Summary
 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.
 DynamicQuery dynamicQuery()
           
 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)
          Returns the number of rows that match the dynamic query.
 Counter fetchCounter(String name)
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 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()
           
 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)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 Counter updateCounter(Counter counter)
          Updates the counter in the database or adds it if it does not yet exist.
 Counter updateCounter(Counter counter, boolean merge)
          Updates the counter in the database or adds it if it does not yet exist.
 

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

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

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

DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Counter fetchCounter(String name)
                     throws SystemException
Throws:
SystemException

getCounter

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException
SystemException

getCounters

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCountersCount()
                     throws SystemException
Returns 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 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

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

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

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

Liferay 6.1.2-ce-ga3