001    /**
002     * Copyright (c) 2000-2011 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.MethodCache;
019    import com.liferay.portal.kernel.util.ReferenceRegistry;
020    
021    /**
022     * The utility for the social equity group setting local service. This utility wraps {@link com.liferay.portlet.social.service.impl.SocialEquityGroupSettingLocalServiceImpl} and is the primary access point for service operations in application layer code running on the local server.
023     *
024     * <p>
025     * 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.
026     * </p>
027     *
028     * @author Brian Wing Shun Chan
029     * @see SocialEquityGroupSettingLocalService
030     * @see com.liferay.portlet.social.service.base.SocialEquityGroupSettingLocalServiceBaseImpl
031     * @see com.liferay.portlet.social.service.impl.SocialEquityGroupSettingLocalServiceImpl
032     * @generated
033     */
034    public class SocialEquityGroupSettingLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.social.service.impl.SocialEquityGroupSettingLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
039             */
040    
041            /**
042            * Adds the social equity group setting to the database. Also notifies the appropriate model listeners.
043            *
044            * @param socialEquityGroupSetting the social equity group setting
045            * @return the social equity group setting that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portlet.social.model.SocialEquityGroupSetting addSocialEquityGroupSetting(
049                    com.liferay.portlet.social.model.SocialEquityGroupSetting socialEquityGroupSetting)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addSocialEquityGroupSetting(socialEquityGroupSetting);
052            }
053    
054            /**
055            * Creates a new social equity group setting with the primary key. Does not add the social equity group setting to the database.
056            *
057            * @param equityGroupSettingId the primary key for the new social equity group setting
058            * @return the new social equity group setting
059            */
060            public static com.liferay.portlet.social.model.SocialEquityGroupSetting createSocialEquityGroupSetting(
061                    long equityGroupSettingId) {
062                    return getService().createSocialEquityGroupSetting(equityGroupSettingId);
063            }
064    
065            /**
066            * Deletes the social equity group setting with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param equityGroupSettingId the primary key of the social equity group setting
069            * @throws PortalException if a social equity group setting with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static void deleteSocialEquityGroupSetting(long equityGroupSettingId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteSocialEquityGroupSetting(equityGroupSettingId);
076            }
077    
078            /**
079            * Deletes the social equity group setting from the database. Also notifies the appropriate model listeners.
080            *
081            * @param socialEquityGroupSetting the social equity group setting
082            * @throws SystemException if a system exception occurred
083            */
084            public static void deleteSocialEquityGroupSetting(
085                    com.liferay.portlet.social.model.SocialEquityGroupSetting socialEquityGroupSetting)
086                    throws com.liferay.portal.kernel.exception.SystemException {
087                    getService().deleteSocialEquityGroupSetting(socialEquityGroupSetting);
088            }
089    
090            /**
091            * Performs a dynamic query on the database and returns the matching rows.
092            *
093            * @param dynamicQuery the dynamic query
094            * @return the matching rows
095            * @throws SystemException if a system exception occurred
096            */
097            @SuppressWarnings("rawtypes")
098            public static java.util.List dynamicQuery(
099                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
100                    throws com.liferay.portal.kernel.exception.SystemException {
101                    return getService().dynamicQuery(dynamicQuery);
102            }
103    
104            /**
105            * Performs a dynamic query on the database and returns a range of the matching rows.
106            *
107            * <p>
108            * 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.
109            * </p>
110            *
111            * @param dynamicQuery the dynamic query
112            * @param start the lower bound of the range of model instances
113            * @param end the upper bound of the range of model instances (not inclusive)
114            * @return the range of matching rows
115            * @throws SystemException if a system exception occurred
116            */
117            @SuppressWarnings("rawtypes")
118            public static java.util.List dynamicQuery(
119                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
120                    int end) throws com.liferay.portal.kernel.exception.SystemException {
121                    return getService().dynamicQuery(dynamicQuery, start, end);
122            }
123    
124            /**
125            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
126            *
127            * <p>
128            * 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.
129            * </p>
130            *
131            * @param dynamicQuery the dynamic query
132            * @param start the lower bound of the range of model instances
133            * @param end the upper bound of the range of model instances (not inclusive)
134            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
135            * @return the ordered range of matching rows
136            * @throws SystemException if a system exception occurred
137            */
138            @SuppressWarnings("rawtypes")
139            public static java.util.List dynamicQuery(
140                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
141                    int end,
142                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
143                    throws com.liferay.portal.kernel.exception.SystemException {
144                    return getService()
145                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
146            }
147    
148            /**
149            * Returns the number of rows that match the dynamic query.
150            *
151            * @param dynamicQuery the dynamic query
152            * @return the number of rows that match the dynamic query
153            * @throws SystemException if a system exception occurred
154            */
155            public static long dynamicQueryCount(
156                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
157                    throws com.liferay.portal.kernel.exception.SystemException {
158                    return getService().dynamicQueryCount(dynamicQuery);
159            }
160    
161            /**
162            * Returns the social equity group setting with the primary key.
163            *
164            * @param equityGroupSettingId the primary key of the social equity group setting
165            * @return the social equity group setting
166            * @throws PortalException if a social equity group setting with the primary key could not be found
167            * @throws SystemException if a system exception occurred
168            */
169            public static com.liferay.portlet.social.model.SocialEquityGroupSetting getSocialEquityGroupSetting(
170                    long equityGroupSettingId)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException {
173                    return getService().getSocialEquityGroupSetting(equityGroupSettingId);
174            }
175    
176            public static com.liferay.portal.model.PersistedModel getPersistedModel(
177                    java.io.Serializable primaryKeyObj)
178                    throws com.liferay.portal.kernel.exception.PortalException,
179                            com.liferay.portal.kernel.exception.SystemException {
180                    return getService().getPersistedModel(primaryKeyObj);
181            }
182    
183            /**
184            * Returns a range of all the social equity group settings.
185            *
186            * <p>
187            * 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.
188            * </p>
189            *
190            * @param start the lower bound of the range of social equity group settings
191            * @param end the upper bound of the range of social equity group settings (not inclusive)
192            * @return the range of social equity group settings
193            * @throws SystemException if a system exception occurred
194            */
195            public static java.util.List<com.liferay.portlet.social.model.SocialEquityGroupSetting> getSocialEquityGroupSettings(
196                    int start, int end)
197                    throws com.liferay.portal.kernel.exception.SystemException {
198                    return getService().getSocialEquityGroupSettings(start, end);
199            }
200    
201            /**
202            * Returns the number of social equity group settings.
203            *
204            * @return the number of social equity group settings
205            * @throws SystemException if a system exception occurred
206            */
207            public static int getSocialEquityGroupSettingsCount()
208                    throws com.liferay.portal.kernel.exception.SystemException {
209                    return getService().getSocialEquityGroupSettingsCount();
210            }
211    
212            /**
213            * Updates the social equity group setting in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
214            *
215            * @param socialEquityGroupSetting the social equity group setting
216            * @return the social equity group setting that was updated
217            * @throws SystemException if a system exception occurred
218            */
219            public static com.liferay.portlet.social.model.SocialEquityGroupSetting updateSocialEquityGroupSetting(
220                    com.liferay.portlet.social.model.SocialEquityGroupSetting socialEquityGroupSetting)
221                    throws com.liferay.portal.kernel.exception.SystemException {
222                    return getService()
223                                       .updateSocialEquityGroupSetting(socialEquityGroupSetting);
224            }
225    
226            /**
227            * Updates the social equity group setting in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
228            *
229            * @param socialEquityGroupSetting the social equity group setting
230            * @param merge whether to merge the social equity group setting 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.
231            * @return the social equity group setting that was updated
232            * @throws SystemException if a system exception occurred
233            */
234            public static com.liferay.portlet.social.model.SocialEquityGroupSetting updateSocialEquityGroupSetting(
235                    com.liferay.portlet.social.model.SocialEquityGroupSetting socialEquityGroupSetting,
236                    boolean merge)
237                    throws com.liferay.portal.kernel.exception.SystemException {
238                    return getService()
239                                       .updateSocialEquityGroupSetting(socialEquityGroupSetting,
240                            merge);
241            }
242    
243            /**
244            * Returns the Spring bean ID for this bean.
245            *
246            * @return the Spring bean ID for this bean
247            */
248            public static java.lang.String getBeanIdentifier() {
249                    return getService().getBeanIdentifier();
250            }
251    
252            /**
253            * Sets the Spring bean ID for this bean.
254            *
255            * @param beanIdentifier the Spring bean ID for this bean
256            */
257            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
258                    getService().setBeanIdentifier(beanIdentifier);
259            }
260    
261            /**
262            * Returns <code>true</code> if social equity is turned on for the model
263            * (asset type) in the group.
264            *
265            * @param groupId the primary key of the group
266            * @param className the class name for the target asset type
267            * @return <code>true</code> if social equity is enabled for the model;
268            <code>false</code> otherwise
269            * @throws SystemException if a system exception occurred
270            */
271            public static boolean isEnabled(long groupId, java.lang.String className)
272                    throws com.liferay.portal.kernel.exception.SystemException {
273                    return getService().isEnabled(groupId, className);
274            }
275    
276            /**
277            * Returns <code>true</code> if the specified social equity scoring type is
278            * turned on for the model (asset type) in the group.
279            *
280            * @param groupId the primary key of the group
281            * @param className the class name for the target asset type
282            * @param type the social equity score type, acceptable values are {@link
283            SocialEquitySettingConstants.TYPE_INFORMATION} and {@link
284            SocialEquitySettingConstants.TYPE_PARTICIPATION}
285            * @return <code>true</code> if the given type of social equity scoring is
286            enabled for the model; <code>false</code> otherwise
287            * @throws SystemException if a system exception occurred
288            */
289            public static boolean isEnabled(long groupId, java.lang.String className,
290                    int type) throws com.liferay.portal.kernel.exception.SystemException {
291                    return getService().isEnabled(groupId, className, type);
292            }
293    
294            /**
295            * Updates the group related social equity settings for the group and model
296            * (asset type).
297            *
298            * <p>
299            * This method stores whether the social equity scoring type (information
300            * or participation) is turned on for the model in the group.
301            * </p>
302            *
303            * @param groupId the primary key of the group
304            * @param className the class name for the target asset
305            * @param type the social equity score type, acceptable values are {@link
306            SocialEquitySettingConstants.TYPE_INFORMATION}, {@link
307            SocialEquitySettingConstants.TYPE_PARTICIPATION}
308            * @param enabled whether social equity is turned on
309            * @throws PortalException if the group could not be found
310            * @throws SystemException if a system exception occurred
311            */
312            public static void updateEquityGroupSetting(long groupId,
313                    java.lang.String className, int type, boolean enabled)
314                    throws com.liferay.portal.kernel.exception.PortalException,
315                            com.liferay.portal.kernel.exception.SystemException {
316                    getService().updateEquityGroupSetting(groupId, className, type, enabled);
317            }
318    
319            public static SocialEquityGroupSettingLocalService getService() {
320                    if (_service == null) {
321                            _service = (SocialEquityGroupSettingLocalService)PortalBeanLocatorUtil.locate(SocialEquityGroupSettingLocalService.class.getName());
322    
323                            ReferenceRegistry.registerReference(SocialEquityGroupSettingLocalServiceUtil.class,
324                                    "_service");
325                            MethodCache.remove(SocialEquityGroupSettingLocalService.class);
326                    }
327    
328                    return _service;
329            }
330    
331            public void setService(SocialEquityGroupSettingLocalService service) {
332                    MethodCache.remove(SocialEquityGroupSettingLocalService.class);
333    
334                    _service = service;
335    
336                    ReferenceRegistry.registerReference(SocialEquityGroupSettingLocalServiceUtil.class,
337                            "_service");
338                    MethodCache.remove(SocialEquityGroupSettingLocalService.class);
339            }
340    
341            private static SocialEquityGroupSettingLocalService _service;
342    }