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.portlet.social.service;
016    
017    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    import com.liferay.portal.kernel.util.ReferenceRegistry;
019    
020    /**
021     * The utility for the social activity counter local service. This utility wraps {@link com.liferay.portlet.social.service.impl.SocialActivityCounterLocalServiceImpl} and is the primary access point for service operations in application layer code running on the local server.
022     *
023     * <p>
024     * 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.
025     * </p>
026     *
027     * @author Brian Wing Shun Chan
028     * @see SocialActivityCounterLocalService
029     * @see com.liferay.portlet.social.service.base.SocialActivityCounterLocalServiceBaseImpl
030     * @see com.liferay.portlet.social.service.impl.SocialActivityCounterLocalServiceImpl
031     * @generated
032     */
033    public class SocialActivityCounterLocalServiceUtil {
034            /*
035             * NOTE FOR DEVELOPERS:
036             *
037             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.social.service.impl.SocialActivityCounterLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
038             */
039    
040            /**
041            * Adds the social activity counter to the database. Also notifies the appropriate model listeners.
042            *
043            * @param socialActivityCounter the social activity counter
044            * @return the social activity counter that was added
045            * @throws SystemException if a system exception occurred
046            */
047            public static com.liferay.portlet.social.model.SocialActivityCounter addSocialActivityCounter(
048                    com.liferay.portlet.social.model.SocialActivityCounter socialActivityCounter)
049                    throws com.liferay.portal.kernel.exception.SystemException {
050                    return getService().addSocialActivityCounter(socialActivityCounter);
051            }
052    
053            /**
054            * Creates a new social activity counter with the primary key. Does not add the social activity counter to the database.
055            *
056            * @param activityCounterId the primary key for the new social activity counter
057            * @return the new social activity counter
058            */
059            public static com.liferay.portlet.social.model.SocialActivityCounter createSocialActivityCounter(
060                    long activityCounterId) {
061                    return getService().createSocialActivityCounter(activityCounterId);
062            }
063    
064            /**
065            * Deletes the social activity counter with the primary key from the database. Also notifies the appropriate model listeners.
066            *
067            * @param activityCounterId the primary key of the social activity counter
068            * @return the social activity counter that was removed
069            * @throws PortalException if a social activity counter with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static com.liferay.portlet.social.model.SocialActivityCounter deleteSocialActivityCounter(
073                    long activityCounterId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException {
076                    return getService().deleteSocialActivityCounter(activityCounterId);
077            }
078    
079            /**
080            * Deletes the social activity counter from the database. Also notifies the appropriate model listeners.
081            *
082            * @param socialActivityCounter the social activity counter
083            * @return the social activity counter that was removed
084            * @throws SystemException if a system exception occurred
085            */
086            public static com.liferay.portlet.social.model.SocialActivityCounter deleteSocialActivityCounter(
087                    com.liferay.portlet.social.model.SocialActivityCounter socialActivityCounter)
088                    throws com.liferay.portal.kernel.exception.SystemException {
089                    return getService().deleteSocialActivityCounter(socialActivityCounter);
090            }
091    
092            public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
093                    return getService().dynamicQuery();
094            }
095    
096            /**
097            * Performs a dynamic query on the database and returns the matching rows.
098            *
099            * @param dynamicQuery the dynamic query
100            * @return the matching rows
101            * @throws SystemException if a system exception occurred
102            */
103            @SuppressWarnings("rawtypes")
104            public static java.util.List dynamicQuery(
105                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
106                    throws com.liferay.portal.kernel.exception.SystemException {
107                    return getService().dynamicQuery(dynamicQuery);
108            }
109    
110            /**
111            * Performs a dynamic query on the database and returns a range of the matching rows.
112            *
113            * <p>
114            * 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.
115            * </p>
116            *
117            * @param dynamicQuery the dynamic query
118            * @param start the lower bound of the range of model instances
119            * @param end the upper bound of the range of model instances (not inclusive)
120            * @return the range of matching rows
121            * @throws SystemException if a system exception occurred
122            */
123            @SuppressWarnings("rawtypes")
124            public static java.util.List dynamicQuery(
125                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
126                    int end) throws com.liferay.portal.kernel.exception.SystemException {
127                    return getService().dynamicQuery(dynamicQuery, start, end);
128            }
129    
130            /**
131            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
132            *
133            * <p>
134            * 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.
135            * </p>
136            *
137            * @param dynamicQuery the dynamic query
138            * @param start the lower bound of the range of model instances
139            * @param end the upper bound of the range of model instances (not inclusive)
140            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
141            * @return the ordered range of matching rows
142            * @throws SystemException if a system exception occurred
143            */
144            @SuppressWarnings("rawtypes")
145            public static java.util.List dynamicQuery(
146                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
147                    int end,
148                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
149                    throws com.liferay.portal.kernel.exception.SystemException {
150                    return getService()
151                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
152            }
153    
154            /**
155            * Returns the number of rows that match the dynamic query.
156            *
157            * @param dynamicQuery the dynamic query
158            * @return the number of rows that match the dynamic query
159            * @throws SystemException if a system exception occurred
160            */
161            public static long dynamicQueryCount(
162                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
163                    throws com.liferay.portal.kernel.exception.SystemException {
164                    return getService().dynamicQueryCount(dynamicQuery);
165            }
166    
167            public static com.liferay.portlet.social.model.SocialActivityCounter fetchSocialActivityCounter(
168                    long activityCounterId)
169                    throws com.liferay.portal.kernel.exception.SystemException {
170                    return getService().fetchSocialActivityCounter(activityCounterId);
171            }
172    
173            /**
174            * Returns the social activity counter with the primary key.
175            *
176            * @param activityCounterId the primary key of the social activity counter
177            * @return the social activity counter
178            * @throws PortalException if a social activity counter with the primary key could not be found
179            * @throws SystemException if a system exception occurred
180            */
181            public static com.liferay.portlet.social.model.SocialActivityCounter getSocialActivityCounter(
182                    long activityCounterId)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return getService().getSocialActivityCounter(activityCounterId);
186            }
187    
188            public static com.liferay.portal.model.PersistedModel getPersistedModel(
189                    java.io.Serializable primaryKeyObj)
190                    throws com.liferay.portal.kernel.exception.PortalException,
191                            com.liferay.portal.kernel.exception.SystemException {
192                    return getService().getPersistedModel(primaryKeyObj);
193            }
194    
195            /**
196            * Returns a range of all the social activity counters.
197            *
198            * <p>
199            * 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.
200            * </p>
201            *
202            * @param start the lower bound of the range of social activity counters
203            * @param end the upper bound of the range of social activity counters (not inclusive)
204            * @return the range of social activity counters
205            * @throws SystemException if a system exception occurred
206            */
207            public static java.util.List<com.liferay.portlet.social.model.SocialActivityCounter> getSocialActivityCounters(
208                    int start, int end)
209                    throws com.liferay.portal.kernel.exception.SystemException {
210                    return getService().getSocialActivityCounters(start, end);
211            }
212    
213            /**
214            * Returns the number of social activity counters.
215            *
216            * @return the number of social activity counters
217            * @throws SystemException if a system exception occurred
218            */
219            public static int getSocialActivityCountersCount()
220                    throws com.liferay.portal.kernel.exception.SystemException {
221                    return getService().getSocialActivityCountersCount();
222            }
223    
224            /**
225            * Updates the social activity counter in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
226            *
227            * @param socialActivityCounter the social activity counter
228            * @return the social activity counter that was updated
229            * @throws SystemException if a system exception occurred
230            */
231            public static com.liferay.portlet.social.model.SocialActivityCounter updateSocialActivityCounter(
232                    com.liferay.portlet.social.model.SocialActivityCounter socialActivityCounter)
233                    throws com.liferay.portal.kernel.exception.SystemException {
234                    return getService().updateSocialActivityCounter(socialActivityCounter);
235            }
236    
237            /**
238            * Updates the social activity counter in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
239            *
240            * @param socialActivityCounter the social activity counter
241            * @param merge whether to merge the social activity counter with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation.
242            * @return the social activity counter that was updated
243            * @throws SystemException if a system exception occurred
244            */
245            public static com.liferay.portlet.social.model.SocialActivityCounter updateSocialActivityCounter(
246                    com.liferay.portlet.social.model.SocialActivityCounter socialActivityCounter,
247                    boolean merge)
248                    throws com.liferay.portal.kernel.exception.SystemException {
249                    return getService()
250                                       .updateSocialActivityCounter(socialActivityCounter, merge);
251            }
252    
253            /**
254            * Returns the Spring bean ID for this bean.
255            *
256            * @return the Spring bean ID for this bean
257            */
258            public static java.lang.String getBeanIdentifier() {
259                    return getService().getBeanIdentifier();
260            }
261    
262            /**
263            * Sets the Spring bean ID for this bean.
264            *
265            * @param beanIdentifier the Spring bean ID for this bean
266            */
267            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
268                    getService().setBeanIdentifier(beanIdentifier);
269            }
270    
271            public static com.liferay.portlet.social.model.SocialActivityCounter addActivityCounter(
272                    long groupId, long classNameId, long classPK, java.lang.String name,
273                    int ownerType, int currentValue, int totalValue, int startPeriod,
274                    int endPeriod)
275                    throws com.liferay.portal.kernel.exception.PortalException,
276                            com.liferay.portal.kernel.exception.SystemException {
277                    return getService()
278                                       .addActivityCounter(groupId, classNameId, classPK, name,
279                            ownerType, currentValue, totalValue, startPeriod, endPeriod);
280            }
281    
282            public static com.liferay.portlet.social.model.SocialActivityCounter addActivityCounter(
283                    long groupId, long classNameId, long classPK, java.lang.String name,
284                    int ownerType, int currentValue, int totalValue, int startPeriod,
285                    int endPeriod, long previousActivityCounterId, int periodLength)
286                    throws com.liferay.portal.kernel.exception.PortalException,
287                            com.liferay.portal.kernel.exception.SystemException {
288                    return getService()
289                                       .addActivityCounter(groupId, classNameId, classPK, name,
290                            ownerType, currentValue, totalValue, startPeriod, endPeriod,
291                            previousActivityCounterId, periodLength);
292            }
293    
294            public static void addActivityCounters(
295                    com.liferay.portlet.social.model.SocialActivity activity)
296                    throws com.liferay.portal.kernel.exception.PortalException,
297                            com.liferay.portal.kernel.exception.SystemException {
298                    getService().addActivityCounters(activity);
299            }
300    
301            /**
302            * @deprecated {@link #createActivityCounter(long, long, long, String, int,
303            int, int, int, int, long, int)}
304            */
305            public static com.liferay.portlet.social.model.SocialActivityCounter createActivityCounter(
306                    long groupId, long classNameId, long classPK, java.lang.String name,
307                    int ownerType, int currentValue, int totalValue, int startPeriod,
308                    int endPeriod)
309                    throws com.liferay.portal.kernel.exception.PortalException,
310                            com.liferay.portal.kernel.exception.SystemException {
311                    return getService()
312                                       .createActivityCounter(groupId, classNameId, classPK, name,
313                            ownerType, currentValue, totalValue, startPeriod, endPeriod);
314            }
315    
316            public static com.liferay.portlet.social.model.SocialActivityCounter createActivityCounter(
317                    long groupId, long classNameId, long classPK, java.lang.String name,
318                    int ownerType, int currentValue, int totalValue, int startPeriod,
319                    int endPeriod, long previousActivityCounterId, int periodLength)
320                    throws com.liferay.portal.kernel.exception.PortalException,
321                            com.liferay.portal.kernel.exception.SystemException {
322                    return getService()
323                                       .createActivityCounter(groupId, classNameId, classPK, name,
324                            ownerType, currentValue, totalValue, startPeriod, endPeriod,
325                            previousActivityCounterId, periodLength);
326            }
327    
328            public static void deleteActivityCounters(
329                    com.liferay.portlet.asset.model.AssetEntry assetEntry)
330                    throws com.liferay.portal.kernel.exception.PortalException,
331                            com.liferay.portal.kernel.exception.SystemException {
332                    getService().deleteActivityCounters(assetEntry);
333            }
334    
335            public static void deleteActivityCounters(long classNameId, long classPK)
336                    throws com.liferay.portal.kernel.exception.SystemException {
337                    getService().deleteActivityCounters(classNameId, classPK);
338            }
339    
340            public static com.liferay.portlet.social.model.SocialActivityCounter fetchActivityCounterByEndPeriod(
341                    long groupId, long classNameId, long classPK, java.lang.String name,
342                    int ownerType, int endPeriod)
343                    throws com.liferay.portal.kernel.exception.SystemException {
344                    return getService()
345                                       .fetchActivityCounterByEndPeriod(groupId, classNameId,
346                            classPK, name, ownerType, endPeriod);
347            }
348    
349            public static com.liferay.portlet.social.model.SocialActivityCounter fetchActivityCounterByStartPeriod(
350                    long groupId, long classNameId, long classPK, java.lang.String name,
351                    int ownerType, int startPeriod)
352                    throws com.liferay.portal.kernel.exception.SystemException {
353                    return getService()
354                                       .fetchActivityCounterByStartPeriod(groupId, classNameId,
355                            classPK, name, ownerType, startPeriod);
356            }
357    
358            public static com.liferay.portlet.social.model.SocialActivityCounter fetchLatestActivityCounter(
359                    long groupId, long classNameId, long classPK, java.lang.String name,
360                    int ownerType)
361                    throws com.liferay.portal.kernel.exception.SystemException {
362                    return getService()
363                                       .fetchLatestActivityCounter(groupId, classNameId, classPK,
364                            name, ownerType);
365            }
366    
367            public static java.util.List<com.liferay.portlet.social.model.SocialActivityCounter> getOffsetActivityCounters(
368                    long groupId, java.lang.String name, int startOffset, int endOffset)
369                    throws com.liferay.portal.kernel.exception.SystemException {
370                    return getService()
371                                       .getOffsetActivityCounters(groupId, name, startOffset,
372                            endOffset);
373            }
374    
375            public static java.util.List<com.liferay.portlet.social.model.SocialActivityCounter> getOffsetDistributionActivityCounters(
376                    long groupId, java.lang.String name, int startOffset, int endOffset)
377                    throws com.liferay.portal.kernel.exception.SystemException {
378                    return getService()
379                                       .getOffsetDistributionActivityCounters(groupId, name,
380                            startOffset, endOffset);
381            }
382    
383            public static java.util.List<com.liferay.portlet.social.model.SocialActivityCounter> getPeriodActivityCounters(
384                    long groupId, java.lang.String name, int startPeriod, int endPeriod)
385                    throws com.liferay.portal.kernel.exception.SystemException {
386                    return getService()
387                                       .getPeriodActivityCounters(groupId, name, startPeriod,
388                            endPeriod);
389            }
390    
391            public static java.util.List<com.liferay.portlet.social.model.SocialActivityCounter> getPeriodDistributionActivityCounters(
392                    long groupId, java.lang.String name, int startPeriod, int endPeriod)
393                    throws com.liferay.portal.kernel.exception.SystemException {
394                    return getService()
395                                       .getPeriodDistributionActivityCounters(groupId, name,
396                            startPeriod, endPeriod);
397            }
398    
399            public static java.util.List<com.liferay.portal.kernel.util.Tuple> getUserActivityCounters(
400                    long groupId, java.lang.String[] rankingNames,
401                    java.lang.String[] selectedNames, int start, int end)
402                    throws com.liferay.portal.kernel.exception.SystemException {
403                    return getService()
404                                       .getUserActivityCounters(groupId, rankingNames,
405                            selectedNames, start, end);
406            }
407    
408            public static int getUserActivityCountersCount(long groupId,
409                    java.lang.String[] rankingNames)
410                    throws com.liferay.portal.kernel.exception.SystemException {
411                    return getService().getUserActivityCountersCount(groupId, rankingNames);
412            }
413    
414            public static void incrementUserAchievementCounter(long userId, long groupId)
415                    throws com.liferay.portal.kernel.exception.PortalException,
416                            com.liferay.portal.kernel.exception.SystemException {
417                    getService().incrementUserAchievementCounter(userId, groupId);
418            }
419    
420            public static SocialActivityCounterLocalService getService() {
421                    if (_service == null) {
422                            _service = (SocialActivityCounterLocalService)PortalBeanLocatorUtil.locate(SocialActivityCounterLocalService.class.getName());
423    
424                            ReferenceRegistry.registerReference(SocialActivityCounterLocalServiceUtil.class,
425                                    "_service");
426                    }
427    
428                    return _service;
429            }
430    
431            /**
432             * @deprecated
433             */
434            public void setService(SocialActivityCounterLocalService service) {
435            }
436    
437            private static SocialActivityCounterLocalService _service;
438    }