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