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.journal.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 journal feed local service. This utility wraps {@link com.liferay.portlet.journal.service.impl.JournalFeedLocalServiceImpl} 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 JournalFeedLocalService
030     * @see com.liferay.portlet.journal.service.base.JournalFeedLocalServiceBaseImpl
031     * @see com.liferay.portlet.journal.service.impl.JournalFeedLocalServiceImpl
032     * @generated
033     */
034    public class JournalFeedLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.journal.service.impl.JournalFeedLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
039             */
040    
041            /**
042            * Adds the journal feed to the database. Also notifies the appropriate model listeners.
043            *
044            * @param journalFeed the journal feed
045            * @return the journal feed that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portlet.journal.model.JournalFeed addJournalFeed(
049                    com.liferay.portlet.journal.model.JournalFeed journalFeed)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addJournalFeed(journalFeed);
052            }
053    
054            /**
055            * Creates a new journal feed with the primary key. Does not add the journal feed to the database.
056            *
057            * @param id the primary key for the new journal feed
058            * @return the new journal feed
059            */
060            public static com.liferay.portlet.journal.model.JournalFeed createJournalFeed(
061                    long id) {
062                    return getService().createJournalFeed(id);
063            }
064    
065            /**
066            * Deletes the journal feed with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param id the primary key of the journal feed
069            * @throws PortalException if a journal feed with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static void deleteJournalFeed(long id)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteJournalFeed(id);
076            }
077    
078            /**
079            * Deletes the journal feed from the database. Also notifies the appropriate model listeners.
080            *
081            * @param journalFeed the journal feed
082            * @throws SystemException if a system exception occurred
083            */
084            public static void deleteJournalFeed(
085                    com.liferay.portlet.journal.model.JournalFeed journalFeed)
086                    throws com.liferay.portal.kernel.exception.SystemException {
087                    getService().deleteJournalFeed(journalFeed);
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 journal feed with the primary key.
163            *
164            * @param id the primary key of the journal feed
165            * @return the journal feed
166            * @throws PortalException if a journal feed with the primary key could not be found
167            * @throws SystemException if a system exception occurred
168            */
169            public static com.liferay.portlet.journal.model.JournalFeed getJournalFeed(
170                    long id)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException {
173                    return getService().getJournalFeed(id);
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 the journal feed with the UUID in the group.
185            *
186            * @param uuid the UUID of journal feed
187            * @param groupId the group id of the journal feed
188            * @return the journal feed
189            * @throws PortalException if a journal feed with the UUID in the group could not be found
190            * @throws SystemException if a system exception occurred
191            */
192            public static com.liferay.portlet.journal.model.JournalFeed getJournalFeedByUuidAndGroupId(
193                    java.lang.String uuid, long groupId)
194                    throws com.liferay.portal.kernel.exception.PortalException,
195                            com.liferay.portal.kernel.exception.SystemException {
196                    return getService().getJournalFeedByUuidAndGroupId(uuid, groupId);
197            }
198    
199            /**
200            * Returns a range of all the journal feeds.
201            *
202            * <p>
203            * 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.
204            * </p>
205            *
206            * @param start the lower bound of the range of journal feeds
207            * @param end the upper bound of the range of journal feeds (not inclusive)
208            * @return the range of journal feeds
209            * @throws SystemException if a system exception occurred
210            */
211            public static java.util.List<com.liferay.portlet.journal.model.JournalFeed> getJournalFeeds(
212                    int start, int end)
213                    throws com.liferay.portal.kernel.exception.SystemException {
214                    return getService().getJournalFeeds(start, end);
215            }
216    
217            /**
218            * Returns the number of journal feeds.
219            *
220            * @return the number of journal feeds
221            * @throws SystemException if a system exception occurred
222            */
223            public static int getJournalFeedsCount()
224                    throws com.liferay.portal.kernel.exception.SystemException {
225                    return getService().getJournalFeedsCount();
226            }
227    
228            /**
229            * Updates the journal feed in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
230            *
231            * @param journalFeed the journal feed
232            * @return the journal feed that was updated
233            * @throws SystemException if a system exception occurred
234            */
235            public static com.liferay.portlet.journal.model.JournalFeed updateJournalFeed(
236                    com.liferay.portlet.journal.model.JournalFeed journalFeed)
237                    throws com.liferay.portal.kernel.exception.SystemException {
238                    return getService().updateJournalFeed(journalFeed);
239            }
240    
241            /**
242            * Updates the journal feed in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
243            *
244            * @param journalFeed the journal feed
245            * @param merge whether to merge the journal feed 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.
246            * @return the journal feed that was updated
247            * @throws SystemException if a system exception occurred
248            */
249            public static com.liferay.portlet.journal.model.JournalFeed updateJournalFeed(
250                    com.liferay.portlet.journal.model.JournalFeed journalFeed, boolean merge)
251                    throws com.liferay.portal.kernel.exception.SystemException {
252                    return getService().updateJournalFeed(journalFeed, merge);
253            }
254    
255            /**
256            * Returns the Spring bean ID for this bean.
257            *
258            * @return the Spring bean ID for this bean
259            */
260            public static java.lang.String getBeanIdentifier() {
261                    return getService().getBeanIdentifier();
262            }
263    
264            /**
265            * Sets the Spring bean ID for this bean.
266            *
267            * @param beanIdentifier the Spring bean ID for this bean
268            */
269            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
270                    getService().setBeanIdentifier(beanIdentifier);
271            }
272    
273            public static com.liferay.portlet.journal.model.JournalFeed addFeed(
274                    long userId, long groupId, java.lang.String feedId, boolean autoFeedId,
275                    java.lang.String name, java.lang.String description,
276                    java.lang.String type, java.lang.String structureId,
277                    java.lang.String templateId, java.lang.String rendererTemplateId,
278                    int delta, java.lang.String orderByCol, java.lang.String orderByType,
279                    java.lang.String targetLayoutFriendlyUrl,
280                    java.lang.String targetPortletId, java.lang.String contentField,
281                    java.lang.String feedType, double feedVersion,
282                    com.liferay.portal.service.ServiceContext serviceContext)
283                    throws com.liferay.portal.kernel.exception.PortalException,
284                            com.liferay.portal.kernel.exception.SystemException {
285                    return getService()
286                                       .addFeed(userId, groupId, feedId, autoFeedId, name,
287                            description, type, structureId, templateId, rendererTemplateId,
288                            delta, orderByCol, orderByType, targetLayoutFriendlyUrl,
289                            targetPortletId, contentField, feedType, feedVersion, serviceContext);
290            }
291    
292            public static void addFeedResources(long feedId,
293                    boolean addGroupPermissions, boolean addGuestPermissions)
294                    throws com.liferay.portal.kernel.exception.PortalException,
295                            com.liferay.portal.kernel.exception.SystemException {
296                    getService()
297                            .addFeedResources(feedId, addGroupPermissions, addGuestPermissions);
298            }
299    
300            public static void addFeedResources(
301                    com.liferay.portlet.journal.model.JournalFeed feed,
302                    boolean addGroupPermissions, boolean addGuestPermissions)
303                    throws com.liferay.portal.kernel.exception.PortalException,
304                            com.liferay.portal.kernel.exception.SystemException {
305                    getService()
306                            .addFeedResources(feed, addGroupPermissions, addGuestPermissions);
307            }
308    
309            public static void addFeedResources(long feedId,
310                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
311                    throws com.liferay.portal.kernel.exception.PortalException,
312                            com.liferay.portal.kernel.exception.SystemException {
313                    getService().addFeedResources(feedId, groupPermissions, guestPermissions);
314            }
315    
316            public static void addFeedResources(
317                    com.liferay.portlet.journal.model.JournalFeed feed,
318                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
319                    throws com.liferay.portal.kernel.exception.PortalException,
320                            com.liferay.portal.kernel.exception.SystemException {
321                    getService().addFeedResources(feed, groupPermissions, guestPermissions);
322            }
323    
324            public static void deleteFeed(long feedId)
325                    throws com.liferay.portal.kernel.exception.PortalException,
326                            com.liferay.portal.kernel.exception.SystemException {
327                    getService().deleteFeed(feedId);
328            }
329    
330            public static void deleteFeed(long groupId, java.lang.String feedId)
331                    throws com.liferay.portal.kernel.exception.PortalException,
332                            com.liferay.portal.kernel.exception.SystemException {
333                    getService().deleteFeed(groupId, feedId);
334            }
335    
336            public static void deleteFeed(
337                    com.liferay.portlet.journal.model.JournalFeed feed)
338                    throws com.liferay.portal.kernel.exception.PortalException,
339                            com.liferay.portal.kernel.exception.SystemException {
340                    getService().deleteFeed(feed);
341            }
342    
343            public static com.liferay.portlet.journal.model.JournalFeed getFeed(
344                    long feedId)
345                    throws com.liferay.portal.kernel.exception.PortalException,
346                            com.liferay.portal.kernel.exception.SystemException {
347                    return getService().getFeed(feedId);
348            }
349    
350            public static com.liferay.portlet.journal.model.JournalFeed getFeed(
351                    long groupId, java.lang.String feedId)
352                    throws com.liferay.portal.kernel.exception.PortalException,
353                            com.liferay.portal.kernel.exception.SystemException {
354                    return getService().getFeed(groupId, feedId);
355            }
356    
357            public static java.util.List<com.liferay.portlet.journal.model.JournalFeed> getFeeds()
358                    throws com.liferay.portal.kernel.exception.SystemException {
359                    return getService().getFeeds();
360            }
361    
362            public static java.util.List<com.liferay.portlet.journal.model.JournalFeed> getFeeds(
363                    long groupId)
364                    throws com.liferay.portal.kernel.exception.SystemException {
365                    return getService().getFeeds(groupId);
366            }
367    
368            public static java.util.List<com.liferay.portlet.journal.model.JournalFeed> getFeeds(
369                    long groupId, int start, int end)
370                    throws com.liferay.portal.kernel.exception.SystemException {
371                    return getService().getFeeds(groupId, start, end);
372            }
373    
374            public static int getFeedsCount(long groupId)
375                    throws com.liferay.portal.kernel.exception.SystemException {
376                    return getService().getFeedsCount(groupId);
377            }
378    
379            public static java.util.List<com.liferay.portlet.journal.model.JournalFeed> search(
380                    long companyId, long groupId, java.lang.String keywords, int start,
381                    int end, com.liferay.portal.kernel.util.OrderByComparator obc)
382                    throws com.liferay.portal.kernel.exception.SystemException {
383                    return getService().search(companyId, groupId, keywords, start, end, obc);
384            }
385    
386            public static java.util.List<com.liferay.portlet.journal.model.JournalFeed> search(
387                    long companyId, long groupId, java.lang.String feedId,
388                    java.lang.String name, java.lang.String description,
389                    boolean andOperator, int start, int end,
390                    com.liferay.portal.kernel.util.OrderByComparator obc)
391                    throws com.liferay.portal.kernel.exception.SystemException {
392                    return getService()
393                                       .search(companyId, groupId, feedId, name, description,
394                            andOperator, start, end, obc);
395            }
396    
397            public static int searchCount(long companyId, long groupId,
398                    java.lang.String keywords)
399                    throws com.liferay.portal.kernel.exception.SystemException {
400                    return getService().searchCount(companyId, groupId, keywords);
401            }
402    
403            public static int searchCount(long companyId, long groupId,
404                    java.lang.String feedId, java.lang.String name,
405                    java.lang.String description, boolean andOperator)
406                    throws com.liferay.portal.kernel.exception.SystemException {
407                    return getService()
408                                       .searchCount(companyId, groupId, feedId, name, description,
409                            andOperator);
410            }
411    
412            public static com.liferay.portlet.journal.model.JournalFeed updateFeed(
413                    long groupId, java.lang.String feedId, java.lang.String name,
414                    java.lang.String description, java.lang.String type,
415                    java.lang.String structureId, java.lang.String templateId,
416                    java.lang.String rendererTemplateId, int delta,
417                    java.lang.String orderByCol, java.lang.String orderByType,
418                    java.lang.String targetLayoutFriendlyUrl,
419                    java.lang.String targetPortletId, java.lang.String contentField,
420                    java.lang.String feedType, double feedVersion,
421                    com.liferay.portal.service.ServiceContext serviceContext)
422                    throws com.liferay.portal.kernel.exception.PortalException,
423                            com.liferay.portal.kernel.exception.SystemException {
424                    return getService()
425                                       .updateFeed(groupId, feedId, name, description, type,
426                            structureId, templateId, rendererTemplateId, delta, orderByCol,
427                            orderByType, targetLayoutFriendlyUrl, targetPortletId,
428                            contentField, feedType, feedVersion, serviceContext);
429            }
430    
431            public static JournalFeedLocalService getService() {
432                    if (_service == null) {
433                            _service = (JournalFeedLocalService)PortalBeanLocatorUtil.locate(JournalFeedLocalService.class.getName());
434    
435                            ReferenceRegistry.registerReference(JournalFeedLocalServiceUtil.class,
436                                    "_service");
437                            MethodCache.remove(JournalFeedLocalService.class);
438                    }
439    
440                    return _service;
441            }
442    
443            public void setService(JournalFeedLocalService service) {
444                    MethodCache.remove(JournalFeedLocalService.class);
445    
446                    _service = service;
447    
448                    ReferenceRegistry.registerReference(JournalFeedLocalServiceUtil.class,
449                            "_service");
450                    MethodCache.remove(JournalFeedLocalService.class);
451            }
452    
453            private static JournalFeedLocalService _service;
454    }