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.messageboards.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 message boards ban local service. This utility wraps {@link com.liferay.portlet.messageboards.service.impl.MBBanLocalServiceImpl} 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 MBBanLocalService
030     * @see com.liferay.portlet.messageboards.service.base.MBBanLocalServiceBaseImpl
031     * @see com.liferay.portlet.messageboards.service.impl.MBBanLocalServiceImpl
032     * @generated
033     */
034    public class MBBanLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.messageboards.service.impl.MBBanLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
039             */
040    
041            /**
042            * Adds the message boards ban to the database. Also notifies the appropriate model listeners.
043            *
044            * @param mbBan the message boards ban
045            * @return the message boards ban that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portlet.messageboards.model.MBBan addMBBan(
049                    com.liferay.portlet.messageboards.model.MBBan mbBan)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addMBBan(mbBan);
052            }
053    
054            /**
055            * Creates a new message boards ban with the primary key. Does not add the message boards ban to the database.
056            *
057            * @param banId the primary key for the new message boards ban
058            * @return the new message boards ban
059            */
060            public static com.liferay.portlet.messageboards.model.MBBan createMBBan(
061                    long banId) {
062                    return getService().createMBBan(banId);
063            }
064    
065            /**
066            * Deletes the message boards ban with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param banId the primary key of the message boards ban
069            * @throws PortalException if a message boards ban with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static void deleteMBBan(long banId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteMBBan(banId);
076            }
077    
078            /**
079            * Deletes the message boards ban from the database. Also notifies the appropriate model listeners.
080            *
081            * @param mbBan the message boards ban
082            * @throws SystemException if a system exception occurred
083            */
084            public static void deleteMBBan(
085                    com.liferay.portlet.messageboards.model.MBBan mbBan)
086                    throws com.liferay.portal.kernel.exception.SystemException {
087                    getService().deleteMBBan(mbBan);
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            public static com.liferay.portlet.messageboards.model.MBBan fetchMBBan(
162                    long banId) throws com.liferay.portal.kernel.exception.SystemException {
163                    return getService().fetchMBBan(banId);
164            }
165    
166            /**
167            * Returns the message boards ban with the primary key.
168            *
169            * @param banId the primary key of the message boards ban
170            * @return the message boards ban
171            * @throws PortalException if a message boards ban with the primary key could not be found
172            * @throws SystemException if a system exception occurred
173            */
174            public static com.liferay.portlet.messageboards.model.MBBan getMBBan(
175                    long banId)
176                    throws com.liferay.portal.kernel.exception.PortalException,
177                            com.liferay.portal.kernel.exception.SystemException {
178                    return getService().getMBBan(banId);
179            }
180    
181            public static com.liferay.portal.model.PersistedModel getPersistedModel(
182                    java.io.Serializable primaryKeyObj)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return getService().getPersistedModel(primaryKeyObj);
186            }
187    
188            /**
189            * Returns a range of all the message boards bans.
190            *
191            * <p>
192            * 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.
193            * </p>
194            *
195            * @param start the lower bound of the range of message boards bans
196            * @param end the upper bound of the range of message boards bans (not inclusive)
197            * @return the range of message boards bans
198            * @throws SystemException if a system exception occurred
199            */
200            public static java.util.List<com.liferay.portlet.messageboards.model.MBBan> getMBBans(
201                    int start, int end)
202                    throws com.liferay.portal.kernel.exception.SystemException {
203                    return getService().getMBBans(start, end);
204            }
205    
206            /**
207            * Returns the number of message boards bans.
208            *
209            * @return the number of message boards bans
210            * @throws SystemException if a system exception occurred
211            */
212            public static int getMBBansCount()
213                    throws com.liferay.portal.kernel.exception.SystemException {
214                    return getService().getMBBansCount();
215            }
216    
217            /**
218            * Updates the message boards ban in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
219            *
220            * @param mbBan the message boards ban
221            * @return the message boards ban that was updated
222            * @throws SystemException if a system exception occurred
223            */
224            public static com.liferay.portlet.messageboards.model.MBBan updateMBBan(
225                    com.liferay.portlet.messageboards.model.MBBan mbBan)
226                    throws com.liferay.portal.kernel.exception.SystemException {
227                    return getService().updateMBBan(mbBan);
228            }
229    
230            /**
231            * Updates the message boards ban in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
232            *
233            * @param mbBan the message boards ban
234            * @param merge whether to merge the message boards ban 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.
235            * @return the message boards ban that was updated
236            * @throws SystemException if a system exception occurred
237            */
238            public static com.liferay.portlet.messageboards.model.MBBan updateMBBan(
239                    com.liferay.portlet.messageboards.model.MBBan mbBan, boolean merge)
240                    throws com.liferay.portal.kernel.exception.SystemException {
241                    return getService().updateMBBan(mbBan, merge);
242            }
243    
244            /**
245            * Returns the Spring bean ID for this bean.
246            *
247            * @return the Spring bean ID for this bean
248            */
249            public static java.lang.String getBeanIdentifier() {
250                    return getService().getBeanIdentifier();
251            }
252    
253            /**
254            * Sets the Spring bean ID for this bean.
255            *
256            * @param beanIdentifier the Spring bean ID for this bean
257            */
258            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
259                    getService().setBeanIdentifier(beanIdentifier);
260            }
261    
262            public static com.liferay.portlet.messageboards.model.MBBan addBan(
263                    long userId, long banUserId,
264                    com.liferay.portal.service.ServiceContext serviceContext)
265                    throws com.liferay.portal.kernel.exception.PortalException,
266                            com.liferay.portal.kernel.exception.SystemException {
267                    return getService().addBan(userId, banUserId, serviceContext);
268            }
269    
270            public static void checkBan(long groupId, long banUserId)
271                    throws com.liferay.portal.kernel.exception.PortalException,
272                            com.liferay.portal.kernel.exception.SystemException {
273                    getService().checkBan(groupId, banUserId);
274            }
275    
276            public static void deleteBan(long banId)
277                    throws com.liferay.portal.kernel.exception.PortalException,
278                            com.liferay.portal.kernel.exception.SystemException {
279                    getService().deleteBan(banId);
280            }
281    
282            public static void deleteBan(long banUserId,
283                    com.liferay.portal.service.ServiceContext serviceContext)
284                    throws com.liferay.portal.kernel.exception.SystemException {
285                    getService().deleteBan(banUserId, serviceContext);
286            }
287    
288            public static void deleteBan(
289                    com.liferay.portlet.messageboards.model.MBBan ban)
290                    throws com.liferay.portal.kernel.exception.SystemException {
291                    getService().deleteBan(ban);
292            }
293    
294            public static void deleteBansByBanUserId(long banUserId)
295                    throws com.liferay.portal.kernel.exception.SystemException {
296                    getService().deleteBansByBanUserId(banUserId);
297            }
298    
299            public static void deleteBansByGroupId(long groupId)
300                    throws com.liferay.portal.kernel.exception.SystemException {
301                    getService().deleteBansByGroupId(groupId);
302            }
303    
304            public static void expireBans()
305                    throws com.liferay.portal.kernel.exception.SystemException {
306                    getService().expireBans();
307            }
308    
309            public static java.util.List<com.liferay.portlet.messageboards.model.MBBan> getBans(
310                    long groupId, int start, int end)
311                    throws com.liferay.portal.kernel.exception.SystemException {
312                    return getService().getBans(groupId, start, end);
313            }
314    
315            public static int getBansCount(long groupId)
316                    throws com.liferay.portal.kernel.exception.SystemException {
317                    return getService().getBansCount(groupId);
318            }
319    
320            public static boolean hasBan(long groupId, long banUserId)
321                    throws com.liferay.portal.kernel.exception.SystemException {
322                    return getService().hasBan(groupId, banUserId);
323            }
324    
325            public static MBBanLocalService getService() {
326                    if (_service == null) {
327                            _service = (MBBanLocalService)PortalBeanLocatorUtil.locate(MBBanLocalService.class.getName());
328    
329                            ReferenceRegistry.registerReference(MBBanLocalServiceUtil.class,
330                                    "_service");
331                            MethodCache.remove(MBBanLocalService.class);
332                    }
333    
334                    return _service;
335            }
336    
337            public void setService(MBBanLocalService service) {
338                    MethodCache.remove(MBBanLocalService.class);
339    
340                    _service = service;
341    
342                    ReferenceRegistry.registerReference(MBBanLocalServiceUtil.class,
343                            "_service");
344                    MethodCache.remove(MBBanLocalService.class);
345            }
346    
347            private static MBBanLocalService _service;
348    }