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 setting local service. This utility wraps {@link com.liferay.portlet.social.service.impl.SocialEquitySettingLocalServiceImpl} 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 SocialEquitySettingLocalService
030     * @see com.liferay.portlet.social.service.base.SocialEquitySettingLocalServiceBaseImpl
031     * @see com.liferay.portlet.social.service.impl.SocialEquitySettingLocalServiceImpl
032     * @generated
033     */
034    public class SocialEquitySettingLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.social.service.impl.SocialEquitySettingLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
039             */
040    
041            /**
042            * Adds the social equity setting to the database. Also notifies the appropriate model listeners.
043            *
044            * @param socialEquitySetting the social equity setting
045            * @return the social equity setting that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portlet.social.model.SocialEquitySetting addSocialEquitySetting(
049                    com.liferay.portlet.social.model.SocialEquitySetting socialEquitySetting)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addSocialEquitySetting(socialEquitySetting);
052            }
053    
054            /**
055            * Creates a new social equity setting with the primary key. Does not add the social equity setting to the database.
056            *
057            * @param equitySettingId the primary key for the new social equity setting
058            * @return the new social equity setting
059            */
060            public static com.liferay.portlet.social.model.SocialEquitySetting createSocialEquitySetting(
061                    long equitySettingId) {
062                    return getService().createSocialEquitySetting(equitySettingId);
063            }
064    
065            /**
066            * Deletes the social equity setting with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param equitySettingId the primary key of the social equity setting
069            * @throws PortalException if a social equity setting with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static void deleteSocialEquitySetting(long equitySettingId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteSocialEquitySetting(equitySettingId);
076            }
077    
078            /**
079            * Deletes the social equity setting from the database. Also notifies the appropriate model listeners.
080            *
081            * @param socialEquitySetting the social equity setting
082            * @throws SystemException if a system exception occurred
083            */
084            public static void deleteSocialEquitySetting(
085                    com.liferay.portlet.social.model.SocialEquitySetting socialEquitySetting)
086                    throws com.liferay.portal.kernel.exception.SystemException {
087                    getService().deleteSocialEquitySetting(socialEquitySetting);
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 setting with the primary key.
163            *
164            * @param equitySettingId the primary key of the social equity setting
165            * @return the social equity setting
166            * @throws PortalException if a social equity 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.SocialEquitySetting getSocialEquitySetting(
170                    long equitySettingId)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException {
173                    return getService().getSocialEquitySetting(equitySettingId);
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 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 settings
191            * @param end the upper bound of the range of social equity settings (not inclusive)
192            * @return the range of social equity settings
193            * @throws SystemException if a system exception occurred
194            */
195            public static java.util.List<com.liferay.portlet.social.model.SocialEquitySetting> getSocialEquitySettings(
196                    int start, int end)
197                    throws com.liferay.portal.kernel.exception.SystemException {
198                    return getService().getSocialEquitySettings(start, end);
199            }
200    
201            /**
202            * Returns the number of social equity settings.
203            *
204            * @return the number of social equity settings
205            * @throws SystemException if a system exception occurred
206            */
207            public static int getSocialEquitySettingsCount()
208                    throws com.liferay.portal.kernel.exception.SystemException {
209                    return getService().getSocialEquitySettingsCount();
210            }
211    
212            /**
213            * Updates the social equity setting in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
214            *
215            * @param socialEquitySetting the social equity setting
216            * @return the social equity setting that was updated
217            * @throws SystemException if a system exception occurred
218            */
219            public static com.liferay.portlet.social.model.SocialEquitySetting updateSocialEquitySetting(
220                    com.liferay.portlet.social.model.SocialEquitySetting socialEquitySetting)
221                    throws com.liferay.portal.kernel.exception.SystemException {
222                    return getService().updateSocialEquitySetting(socialEquitySetting);
223            }
224    
225            /**
226            * Updates the social equity setting in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
227            *
228            * @param socialEquitySetting the social equity setting
229            * @param merge whether to merge the social equity 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.
230            * @return the social equity setting that was updated
231            * @throws SystemException if a system exception occurred
232            */
233            public static com.liferay.portlet.social.model.SocialEquitySetting updateSocialEquitySetting(
234                    com.liferay.portlet.social.model.SocialEquitySetting socialEquitySetting,
235                    boolean merge)
236                    throws com.liferay.portal.kernel.exception.SystemException {
237                    return getService().updateSocialEquitySetting(socialEquitySetting, merge);
238            }
239    
240            /**
241            * Returns the Spring bean ID for this bean.
242            *
243            * @return the Spring bean ID for this bean
244            */
245            public static java.lang.String getBeanIdentifier() {
246                    return getService().getBeanIdentifier();
247            }
248    
249            /**
250            * Sets the Spring bean ID for this bean.
251            *
252            * @param beanIdentifier the Spring bean ID for this bean
253            */
254            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
255                    getService().setBeanIdentifier(beanIdentifier);
256            }
257    
258            /**
259            * Returns all the settings for the social equity action.
260            *
261            * @param groupId the primary key of the group
262            * @param className the class name for the target asset
263            * @param actionId the ID of the action
264            * @return the settings for the social equity action
265            * @throws SystemException if a system exception occurred
266            */
267            public static java.util.List<com.liferay.portlet.social.model.SocialEquitySetting> getEquitySettings(
268                    long groupId, java.lang.String className, java.lang.String actionId)
269                    throws com.liferay.portal.kernel.exception.SystemException {
270                    return getService().getEquitySettings(groupId, className, actionId);
271            }
272    
273            /**
274            * Returns all the settings for the social equity action.
275            *
276            * @param groupId the primary key of the group
277            * @param classNameId the ID of the target asset's class
278            * @param actionId the ID of the action
279            * @return the settings for the social equity action
280            * @throws SystemException if a system exception occurred
281            */
282            public static java.util.List<com.liferay.portlet.social.model.SocialEquitySetting> getEquitySettings(
283                    long groupId, long classNameId, java.lang.String actionId)
284                    throws com.liferay.portal.kernel.exception.SystemException {
285                    return getService().getEquitySettings(groupId, classNameId, actionId);
286            }
287    
288            /**
289            * Updates settings for the model (asset type) in the group.
290            *
291            * <p>
292            * This method accepts a list of social equity action mappings. A
293            * <code>SocialEquityActionMapping</code> contains both participation and
294            * information settings for an action. The
295            * <code>SocialEquityActionMapping</code> class is used by the portal to
296            * store the default settings for social equity actions.
297            * </p>
298            *
299            * @param groupId the primary key of the group
300            * @param className the class name of the target asset
301            * @param equityActionMappings the equity action mappings containing the
302            settings to be stored
303            * @throws PortalException if the group could not be found
304            * @throws SystemException if a system exception occurred
305            */
306            public static void updateEquitySettings(long groupId,
307                    java.lang.String className,
308                    java.util.List<com.liferay.portlet.social.model.SocialEquityActionMapping> equityActionMappings)
309                    throws com.liferay.portal.kernel.exception.PortalException,
310                            com.liferay.portal.kernel.exception.SystemException {
311                    getService()
312                            .updateEquitySettings(groupId, className, equityActionMappings);
313            }
314    
315            public static SocialEquitySettingLocalService getService() {
316                    if (_service == null) {
317                            _service = (SocialEquitySettingLocalService)PortalBeanLocatorUtil.locate(SocialEquitySettingLocalService.class.getName());
318    
319                            ReferenceRegistry.registerReference(SocialEquitySettingLocalServiceUtil.class,
320                                    "_service");
321                            MethodCache.remove(SocialEquitySettingLocalService.class);
322                    }
323    
324                    return _service;
325            }
326    
327            public void setService(SocialEquitySettingLocalService service) {
328                    MethodCache.remove(SocialEquitySettingLocalService.class);
329    
330                    _service = service;
331    
332                    ReferenceRegistry.registerReference(SocialEquitySettingLocalServiceUtil.class,
333                            "_service");
334                    MethodCache.remove(SocialEquitySettingLocalService.class);
335            }
336    
337            private static SocialEquitySettingLocalService _service;
338    }