CounterLocalServiceUtil (Liferay 7.1.1-ga2 portal-kernel API)

Object
- com.liferay.counter.kernel.service.CounterLocalServiceUtil

```
@ProviderType
public class CounterLocalServiceUtil
extends Object
```
Provides the local service utility for Counter. This utility wraps CounterLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server. 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:

CounterLocalService, CounterLocalServiceBaseImpl, CounterLocalServiceImpl

{$generated.description}

Constructor Summary

Constructors
Constructor and Description

CounterLocalServiceUtil()

Constructors
Constructor and Description
`CounterLocalServiceUtil()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`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 PersistedModel`	`deletePersistedModel(PersistedModel persistedModel)`
`static DynamicQuery`	`dynamicQuery()`
`static <T> List<T>`	`dynamicQuery(DynamicQuery dynamicQuery)` Performs a dynamic query on the database and returns the matching rows.
`static <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.
`static <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.
`static long`	`dynamicQueryCount(DynamicQuery dynamicQuery)` Returns the number of rows matching the dynamic query.
`static long`	`dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)` Returns the number of rows matching the dynamic query.
`static Counter`	`fetchCounter(String name)`
`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 String`	`getOSGiServiceIdentifier()` Returns the OSGi service identifier.
`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 Counter`	`updateCounter(Counter counter)` Updates the counter in the database or adds it if it does not yet exist.

Methods inherited from class 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)
```
    Adds the counter to the database. Also notifies the appropriate model listeners.
    
    Parameters:
    
    counter - the counter
    
    Returns:
    
    the counter that was added
  - 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(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
```
public static 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
```
public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException
```
    Throws:
    
    PortalException
  - dynamicQuery
```
public static DynamicQuery dynamicQuery()
```
  - dynamicQuery
```
public static <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
```
public static <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
```
public static <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
```
public static 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
```
public static 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
```
public static Counter fetchCounter(String name)
```
  - getCounter
```
public static 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
```
public static 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
```
public static int getCountersCount()
```
    Returns the number of counters.
    
    Returns:
    
    the number of counters
  - getNames
```
public static List<String> getNames()
```
  - getOSGiServiceIdentifier
```
public static String getOSGiServiceIdentifier()
```
    Returns the OSGi service identifier.
    
    Returns:
    
    the OSGi service identifier
  - getPersistedModel
```
public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException
```
    Throws:
    
    PortalException
  - increment
```
public static long increment()
```
  - increment
```
public static long increment(String name)
```
  - increment
```
public static long increment(String name,
                             int size)
```
  - rename
```
public static void rename(String oldName,
                          String newName)
```
  - reset
```
public static void reset(String name)
```
  - reset
```
public static void reset(String name,
                         long size)
```
  - updateCounter
```
public static 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
  - getService
```
public static CounterLocalService getService()
```

Class CounterLocalServiceUtil

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

CounterLocalServiceUtil

Method Detail

addCounter

createCounter

deleteCounter

deleteCounter

deletePersistedModel

dynamicQuery

dynamicQuery

dynamicQuery

dynamicQuery

dynamicQueryCount

dynamicQueryCount

fetchCounter

getCounter

getCounters

getCountersCount

getNames

getOSGiServiceIdentifier

getPersistedModel

increment

increment

increment

rename

reset

reset

updateCounter

getService