001    /**
002     * Copyright (c) 2000-2012 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 setting local service. This utility wraps {@link com.liferay.portlet.social.service.impl.SocialActivitySettingLocalServiceImpl} 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 SocialActivitySettingLocalService
029     * @see com.liferay.portlet.social.service.base.SocialActivitySettingLocalServiceBaseImpl
030     * @see com.liferay.portlet.social.service.impl.SocialActivitySettingLocalServiceImpl
031     * @generated
032     */
033    public class SocialActivitySettingLocalServiceUtil {
034            /*
035             * NOTE FOR DEVELOPERS:
036             *
037             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.social.service.impl.SocialActivitySettingLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
038             */
039    
040            /**
041            * Adds the social activity setting to the database. Also notifies the appropriate model listeners.
042            *
043            * @param socialActivitySetting the social activity setting
044            * @return the social activity setting that was added
045            * @throws SystemException if a system exception occurred
046            */
047            public static com.liferay.portlet.social.model.SocialActivitySetting addSocialActivitySetting(
048                    com.liferay.portlet.social.model.SocialActivitySetting socialActivitySetting)
049                    throws com.liferay.portal.kernel.exception.SystemException {
050                    return getService().addSocialActivitySetting(socialActivitySetting);
051            }
052    
053            /**
054            * Creates a new social activity setting with the primary key. Does not add the social activity setting to the database.
055            *
056            * @param activitySettingId the primary key for the new social activity setting
057            * @return the new social activity setting
058            */
059            public static com.liferay.portlet.social.model.SocialActivitySetting createSocialActivitySetting(
060                    long activitySettingId) {
061                    return getService().createSocialActivitySetting(activitySettingId);
062            }
063    
064            /**
065            * Deletes the social activity setting with the primary key from the database. Also notifies the appropriate model listeners.
066            *
067            * @param activitySettingId the primary key of the social activity setting
068            * @return the social activity setting that was removed
069            * @throws PortalException if a social activity setting 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.SocialActivitySetting deleteSocialActivitySetting(
073                    long activitySettingId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException {
076                    return getService().deleteSocialActivitySetting(activitySettingId);
077            }
078    
079            /**
080            * Deletes the social activity setting from the database. Also notifies the appropriate model listeners.
081            *
082            * @param socialActivitySetting the social activity setting
083            * @return the social activity setting that was removed
084            * @throws SystemException if a system exception occurred
085            */
086            public static com.liferay.portlet.social.model.SocialActivitySetting deleteSocialActivitySetting(
087                    com.liferay.portlet.social.model.SocialActivitySetting socialActivitySetting)
088                    throws com.liferay.portal.kernel.exception.SystemException {
089                    return getService().deleteSocialActivitySetting(socialActivitySetting);
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. 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.portlet.social.model.impl.SocialActivitySettingModelImpl}. 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.
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. 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.portlet.social.model.impl.SocialActivitySettingModelImpl}. 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.
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.SocialActivitySetting fetchSocialActivitySetting(
168                    long activitySettingId)
169                    throws com.liferay.portal.kernel.exception.SystemException {
170                    return getService().fetchSocialActivitySetting(activitySettingId);
171            }
172    
173            /**
174            * Returns the social activity setting with the primary key.
175            *
176            * @param activitySettingId the primary key of the social activity setting
177            * @return the social activity setting
178            * @throws PortalException if a social activity setting 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.SocialActivitySetting getSocialActivitySetting(
182                    long activitySettingId)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return getService().getSocialActivitySetting(activitySettingId);
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 settings.
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. 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.portlet.social.model.impl.SocialActivitySettingModelImpl}. 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.
200            * </p>
201            *
202            * @param start the lower bound of the range of social activity settings
203            * @param end the upper bound of the range of social activity settings (not inclusive)
204            * @return the range of social activity settings
205            * @throws SystemException if a system exception occurred
206            */
207            public static java.util.List<com.liferay.portlet.social.model.SocialActivitySetting> getSocialActivitySettings(
208                    int start, int end)
209                    throws com.liferay.portal.kernel.exception.SystemException {
210                    return getService().getSocialActivitySettings(start, end);
211            }
212    
213            /**
214            * Returns the number of social activity settings.
215            *
216            * @return the number of social activity settings
217            * @throws SystemException if a system exception occurred
218            */
219            public static int getSocialActivitySettingsCount()
220                    throws com.liferay.portal.kernel.exception.SystemException {
221                    return getService().getSocialActivitySettingsCount();
222            }
223    
224            /**
225            * Updates the social activity setting in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
226            *
227            * @param socialActivitySetting the social activity setting
228            * @return the social activity setting that was updated
229            * @throws SystemException if a system exception occurred
230            */
231            public static com.liferay.portlet.social.model.SocialActivitySetting updateSocialActivitySetting(
232                    com.liferay.portlet.social.model.SocialActivitySetting socialActivitySetting)
233                    throws com.liferay.portal.kernel.exception.SystemException {
234                    return getService().updateSocialActivitySetting(socialActivitySetting);
235            }
236    
237            /**
238            * Returns the Spring bean ID for this bean.
239            *
240            * @return the Spring bean ID for this bean
241            */
242            public static java.lang.String getBeanIdentifier() {
243                    return getService().getBeanIdentifier();
244            }
245    
246            /**
247            * Sets the Spring bean ID for this bean.
248            *
249            * @param beanIdentifier the Spring bean ID for this bean
250            */
251            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
252                    getService().setBeanIdentifier(beanIdentifier);
253            }
254    
255            public static void deleteActivitySetting(long groupId,
256                    java.lang.String className, long classPK)
257                    throws com.liferay.portal.kernel.exception.SystemException {
258                    getService().deleteActivitySetting(groupId, className, classPK);
259            }
260    
261            public static void deleteActivitySettings(long groupId)
262                    throws com.liferay.portal.kernel.exception.SystemException {
263                    getService().deleteActivitySettings(groupId);
264            }
265    
266            public static com.liferay.portlet.social.model.SocialActivityDefinition getActivityDefinition(
267                    long groupId, java.lang.String className, int activityType)
268                    throws com.liferay.portal.kernel.exception.SystemException {
269                    return getService()
270                                       .getActivityDefinition(groupId, className, activityType);
271            }
272    
273            public static java.util.List<com.liferay.portlet.social.model.SocialActivityDefinition> getActivityDefinitions(
274                    long groupId, java.lang.String className)
275                    throws com.liferay.portal.kernel.exception.SystemException {
276                    return getService().getActivityDefinitions(groupId, className);
277            }
278    
279            public static java.util.List<com.liferay.portlet.social.model.SocialActivitySetting> getActivitySettings(
280                    long groupId)
281                    throws com.liferay.portal.kernel.exception.SystemException {
282                    return getService().getActivitySettings(groupId);
283            }
284    
285            public static boolean isEnabled(long groupId, long classNameId)
286                    throws com.liferay.portal.kernel.exception.SystemException {
287                    return getService().isEnabled(groupId, classNameId);
288            }
289    
290            public static boolean isEnabled(long groupId, long classNameId, long classPK)
291                    throws com.liferay.portal.kernel.exception.SystemException {
292                    return getService().isEnabled(groupId, classNameId, classPK);
293            }
294    
295            public static void updateActivitySetting(long groupId,
296                    java.lang.String className, boolean enabled)
297                    throws com.liferay.portal.kernel.exception.PortalException,
298                            com.liferay.portal.kernel.exception.SystemException {
299                    getService().updateActivitySetting(groupId, className, enabled);
300            }
301    
302            public static void updateActivitySetting(long groupId,
303                    java.lang.String className, int activityType,
304                    com.liferay.portlet.social.model.SocialActivityCounterDefinition activityCounterDefinition)
305                    throws com.liferay.portal.kernel.exception.PortalException,
306                            com.liferay.portal.kernel.exception.SystemException {
307                    getService()
308                            .updateActivitySetting(groupId, className, activityType,
309                            activityCounterDefinition);
310            }
311    
312            public static void updateActivitySetting(long groupId,
313                    java.lang.String className, long classPK, boolean enabled)
314                    throws com.liferay.portal.kernel.exception.PortalException,
315                            com.liferay.portal.kernel.exception.SystemException {
316                    getService().updateActivitySetting(groupId, className, classPK, enabled);
317            }
318    
319            public static void updateActivitySettings(long groupId,
320                    java.lang.String className, int activityType,
321                    java.util.List<com.liferay.portlet.social.model.SocialActivityCounterDefinition> activityCounterDefinitions)
322                    throws com.liferay.portal.kernel.exception.PortalException,
323                            com.liferay.portal.kernel.exception.SystemException {
324                    getService()
325                            .updateActivitySettings(groupId, className, activityType,
326                            activityCounterDefinitions);
327            }
328    
329            public static SocialActivitySettingLocalService getService() {
330                    if (_service == null) {
331                            _service = (SocialActivitySettingLocalService)PortalBeanLocatorUtil.locate(SocialActivitySettingLocalService.class.getName());
332    
333                            ReferenceRegistry.registerReference(SocialActivitySettingLocalServiceUtil.class,
334                                    "_service");
335                    }
336    
337                    return _service;
338            }
339    
340            /**
341             * @deprecated
342             */
343            public void setService(SocialActivitySettingLocalService service) {
344            }
345    
346            private static SocialActivitySettingLocalService _service;
347    }