001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.counter.service;
016    
017    import aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
020    import com.liferay.portal.kernel.util.ReferenceRegistry;
021    
022    /**
023     * Provides the local service utility for Counter. This utility wraps
024     * {@link com.liferay.counter.service.impl.CounterLocalServiceImpl} and is the
025     * primary access point for service operations in application layer code running
026     * on the local server. Methods of this service will not have security checks
027     * based on the propagated JAAS credentials because this service can only be
028     * accessed from within the same VM.
029     *
030     * @author Brian Wing Shun Chan
031     * @see CounterLocalService
032     * @see com.liferay.counter.service.base.CounterLocalServiceBaseImpl
033     * @see com.liferay.counter.service.impl.CounterLocalServiceImpl
034     * @generated
035     */
036    @ProviderType
037    public class CounterLocalServiceUtil {
038            /*
039             * NOTE FOR DEVELOPERS:
040             *
041             * Never modify this class directly. Add custom service methods to {@link com.liferay.counter.service.impl.CounterLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
042             */
043    
044            /**
045            * Adds the counter to the database. Also notifies the appropriate model listeners.
046            *
047            * @param counter the counter
048            * @return the counter that was added
049            * @throws SystemException if a system exception occurred
050            */
051            public static com.liferay.counter.model.Counter addCounter(
052                    com.liferay.counter.model.Counter counter)
053                    throws com.liferay.portal.kernel.exception.SystemException {
054                    return getService().addCounter(counter);
055            }
056    
057            /**
058            * Creates a new counter with the primary key. Does not add the counter to the database.
059            *
060            * @param name the primary key for the new counter
061            * @return the new counter
062            */
063            public static com.liferay.counter.model.Counter createCounter(
064                    java.lang.String name) {
065                    return getService().createCounter(name);
066            }
067    
068            /**
069            * Deletes the counter with the primary key from the database. Also notifies the appropriate model listeners.
070            *
071            * @param name the primary key of the counter
072            * @return the counter that was removed
073            * @throws PortalException if a counter with the primary key could not be found
074            * @throws SystemException if a system exception occurred
075            */
076            public static com.liferay.counter.model.Counter deleteCounter(
077                    java.lang.String name)
078                    throws com.liferay.portal.kernel.exception.PortalException,
079                            com.liferay.portal.kernel.exception.SystemException {
080                    return getService().deleteCounter(name);
081            }
082    
083            /**
084            * Deletes the counter from the database. Also notifies the appropriate model listeners.
085            *
086            * @param counter the counter
087            * @return the counter that was removed
088            * @throws SystemException if a system exception occurred
089            */
090            public static com.liferay.counter.model.Counter deleteCounter(
091                    com.liferay.counter.model.Counter counter)
092                    throws com.liferay.portal.kernel.exception.SystemException {
093                    return getService().deleteCounter(counter);
094            }
095    
096            public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
097                    return getService().dynamicQuery();
098            }
099    
100            /**
101            * Performs a dynamic query on the database and returns the matching rows.
102            *
103            * @param dynamicQuery the dynamic query
104            * @return the matching rows
105            * @throws SystemException if a system exception occurred
106            */
107            @SuppressWarnings("rawtypes")
108            public static java.util.List dynamicQuery(
109                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
110                    throws com.liferay.portal.kernel.exception.SystemException {
111                    return getService().dynamicQuery(dynamicQuery);
112            }
113    
114            /**
115            * Performs a dynamic query on the database and returns a range of the matching rows.
116            *
117            * <p>
118            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.counter.model.impl.CounterModelImpl}. If both <code>orderByComparator</code> 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.
119            * </p>
120            *
121            * @param dynamicQuery the dynamic query
122            * @param start the lower bound of the range of model instances
123            * @param end the upper bound of the range of model instances (not inclusive)
124            * @return the range of matching rows
125            * @throws SystemException if a system exception occurred
126            */
127            @SuppressWarnings("rawtypes")
128            public static java.util.List dynamicQuery(
129                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
130                    int end) throws com.liferay.portal.kernel.exception.SystemException {
131                    return getService().dynamicQuery(dynamicQuery, start, end);
132            }
133    
134            /**
135            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
136            *
137            * <p>
138            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.counter.model.impl.CounterModelImpl}. If both <code>orderByComparator</code> 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.
139            * </p>
140            *
141            * @param dynamicQuery the dynamic query
142            * @param start the lower bound of the range of model instances
143            * @param end the upper bound of the range of model instances (not inclusive)
144            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
145            * @return the ordered range of matching rows
146            * @throws SystemException if a system exception occurred
147            */
148            @SuppressWarnings("rawtypes")
149            public static java.util.List dynamicQuery(
150                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
151                    int end,
152                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
153                    throws com.liferay.portal.kernel.exception.SystemException {
154                    return getService()
155                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
156            }
157    
158            /**
159            * Returns the number of rows that match the dynamic query.
160            *
161            * @param dynamicQuery the dynamic query
162            * @return the number of rows that match the dynamic query
163            * @throws SystemException if a system exception occurred
164            */
165            public static long dynamicQueryCount(
166                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
167                    throws com.liferay.portal.kernel.exception.SystemException {
168                    return getService().dynamicQueryCount(dynamicQuery);
169            }
170    
171            /**
172            * Returns the number of rows that match the dynamic query.
173            *
174            * @param dynamicQuery the dynamic query
175            * @param projection the projection to apply to the query
176            * @return the number of rows that match the dynamic query
177            * @throws SystemException if a system exception occurred
178            */
179            public static long dynamicQueryCount(
180                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
181                    com.liferay.portal.kernel.dao.orm.Projection projection)
182                    throws com.liferay.portal.kernel.exception.SystemException {
183                    return getService().dynamicQueryCount(dynamicQuery, projection);
184            }
185    
186            public static com.liferay.counter.model.Counter fetchCounter(
187                    java.lang.String name)
188                    throws com.liferay.portal.kernel.exception.SystemException {
189                    return getService().fetchCounter(name);
190            }
191    
192            /**
193            * Returns the counter with the primary key.
194            *
195            * @param name the primary key of the counter
196            * @return the counter
197            * @throws PortalException if a counter with the primary key could not be found
198            * @throws SystemException if a system exception occurred
199            */
200            public static com.liferay.counter.model.Counter getCounter(
201                    java.lang.String name)
202                    throws com.liferay.portal.kernel.exception.PortalException,
203                            com.liferay.portal.kernel.exception.SystemException {
204                    return getService().getCounter(name);
205            }
206    
207            public static com.liferay.portal.model.PersistedModel getPersistedModel(
208                    java.io.Serializable primaryKeyObj)
209                    throws com.liferay.portal.kernel.exception.PortalException,
210                            com.liferay.portal.kernel.exception.SystemException {
211                    return getService().getPersistedModel(primaryKeyObj);
212            }
213    
214            /**
215            * Returns a range of all the counters.
216            *
217            * <p>
218            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.counter.model.impl.CounterModelImpl}. If both <code>orderByComparator</code> 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.
219            * </p>
220            *
221            * @param start the lower bound of the range of counters
222            * @param end the upper bound of the range of counters (not inclusive)
223            * @return the range of counters
224            * @throws SystemException if a system exception occurred
225            */
226            public static java.util.List<com.liferay.counter.model.Counter> getCounters(
227                    int start, int end)
228                    throws com.liferay.portal.kernel.exception.SystemException {
229                    return getService().getCounters(start, end);
230            }
231    
232            /**
233            * Returns the number of counters.
234            *
235            * @return the number of counters
236            * @throws SystemException if a system exception occurred
237            */
238            public static int getCountersCount()
239                    throws com.liferay.portal.kernel.exception.SystemException {
240                    return getService().getCountersCount();
241            }
242    
243            /**
244            * Updates the counter in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
245            *
246            * @param counter the counter
247            * @return the counter that was updated
248            * @throws SystemException if a system exception occurred
249            */
250            public static com.liferay.counter.model.Counter updateCounter(
251                    com.liferay.counter.model.Counter counter)
252                    throws com.liferay.portal.kernel.exception.SystemException {
253                    return getService().updateCounter(counter);
254            }
255    
256            /**
257            * Returns the Spring bean ID for this bean.
258            *
259            * @return the Spring bean ID for this bean
260            */
261            public static java.lang.String getBeanIdentifier() {
262                    return getService().getBeanIdentifier();
263            }
264    
265            /**
266            * Sets the Spring bean ID for this bean.
267            *
268            * @param beanIdentifier the Spring bean ID for this bean
269            */
270            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
271                    getService().setBeanIdentifier(beanIdentifier);
272            }
273    
274            public static java.util.List<java.lang.String> getNames()
275                    throws com.liferay.portal.kernel.exception.SystemException {
276                    return getService().getNames();
277            }
278    
279            public static long increment()
280                    throws com.liferay.portal.kernel.exception.SystemException {
281                    return getService().increment();
282            }
283    
284            public static long increment(java.lang.String name)
285                    throws com.liferay.portal.kernel.exception.SystemException {
286                    return getService().increment(name);
287            }
288    
289            public static long increment(java.lang.String name, int size)
290                    throws com.liferay.portal.kernel.exception.SystemException {
291                    return getService().increment(name, size);
292            }
293    
294            public static void rename(java.lang.String oldName, java.lang.String newName)
295                    throws com.liferay.portal.kernel.exception.SystemException {
296                    getService().rename(oldName, newName);
297            }
298    
299            public static void reset(java.lang.String name)
300                    throws com.liferay.portal.kernel.exception.SystemException {
301                    getService().reset(name);
302            }
303    
304            public static void reset(java.lang.String name, long size)
305                    throws com.liferay.portal.kernel.exception.SystemException {
306                    getService().reset(name, size);
307            }
308    
309            public static CounterLocalService getService() {
310                    if (_service == null) {
311                            _service = (CounterLocalService)PortalBeanLocatorUtil.locate(CounterLocalService.class.getName());
312    
313                            ReferenceRegistry.registerReference(CounterLocalServiceUtil.class,
314                                    "_service");
315                    }
316    
317                    return _service;
318            }
319    
320            /**
321             * @deprecated As of 6.2.0
322             */
323            public void setService(CounterLocalService service) {
324            }
325    
326            private static CounterLocalService _service;
327    }