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 aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
020    import com.liferay.portal.kernel.util.ReferenceRegistry;
021    
022    /**
023     * Provides the local service utility for JournalFeed. This utility wraps
024     * {@link com.liferay.portlet.journal.service.impl.JournalFeedLocalServiceImpl} and is the
025     * primary access point for service operations in application layer code running
026     * on the local server. Methods of this service will not have security checks
027     * based on the propagated JAAS credentials because this service can only be
028     * accessed from within the same VM.
029     *
030     * @author Brian Wing Shun Chan
031     * @see JournalFeedLocalService
032     * @see com.liferay.portlet.journal.service.base.JournalFeedLocalServiceBaseImpl
033     * @see com.liferay.portlet.journal.service.impl.JournalFeedLocalServiceImpl
034     * @generated
035     */
036    @ProviderType
037    public class JournalFeedLocalServiceUtil {
038            /*
039             * NOTE FOR DEVELOPERS:
040             *
041             * 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.
042             */
043    
044            /**
045            * Adds the journal feed to the database. Also notifies the appropriate model listeners.
046            *
047            * @param journalFeed the journal feed
048            * @return the journal feed that was added
049            * @throws SystemException if a system exception occurred
050            */
051            public static com.liferay.portlet.journal.model.JournalFeed addJournalFeed(
052                    com.liferay.portlet.journal.model.JournalFeed journalFeed)
053                    throws com.liferay.portal.kernel.exception.SystemException {
054                    return getService().addJournalFeed(journalFeed);
055            }
056    
057            /**
058            * Creates a new journal feed with the primary key. Does not add the journal feed to the database.
059            *
060            * @param id the primary key for the new journal feed
061            * @return the new journal feed
062            */
063            public static com.liferay.portlet.journal.model.JournalFeed createJournalFeed(
064                    long id) {
065                    return getService().createJournalFeed(id);
066            }
067    
068            /**
069            * Deletes the journal feed with the primary key from the database. Also notifies the appropriate model listeners.
070            *
071            * @param id the primary key of the journal feed
072            * @return the journal feed that was removed
073            * @throws PortalException if a journal feed with the primary key could not be found
074            * @throws SystemException if a system exception occurred
075            */
076            public static com.liferay.portlet.journal.model.JournalFeed deleteJournalFeed(
077                    long id)
078                    throws com.liferay.portal.kernel.exception.PortalException,
079                            com.liferay.portal.kernel.exception.SystemException {
080                    return getService().deleteJournalFeed(id);
081            }
082    
083            /**
084            * Deletes the journal feed from the database. Also notifies the appropriate model listeners.
085            *
086            * @param journalFeed the journal feed
087            * @return the journal feed that was removed
088            * @throws SystemException if a system exception occurred
089            */
090            public static com.liferay.portlet.journal.model.JournalFeed deleteJournalFeed(
091                    com.liferay.portlet.journal.model.JournalFeed journalFeed)
092                    throws com.liferay.portal.kernel.exception.SystemException {
093                    return getService().deleteJournalFeed(journalFeed);
094            }
095    
096            public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
097                    return getService().dynamicQuery();
098            }
099    
100            /**
101            * Performs a dynamic query on the database and returns the matching rows.
102            *
103            * @param dynamicQuery the dynamic query
104            * @return the matching rows
105            * @throws SystemException if a system exception occurred
106            */
107            @SuppressWarnings("rawtypes")
108            public static java.util.List dynamicQuery(
109                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
110                    throws com.liferay.portal.kernel.exception.SystemException {
111                    return getService().dynamicQuery(dynamicQuery);
112            }
113    
114            /**
115            * Performs a dynamic query on the database and returns a range of the matching rows.
116            *
117            * <p>
118            * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.journal.model.impl.JournalFeedModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
119            * </p>
120            *
121            * @param dynamicQuery the dynamic query
122            * @param start the lower bound of the range of model instances
123            * @param end the upper bound of the range of model instances (not inclusive)
124            * @return the range of matching rows
125            * @throws SystemException if a system exception occurred
126            */
127            @SuppressWarnings("rawtypes")
128            public static java.util.List dynamicQuery(
129                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
130                    int end) throws com.liferay.portal.kernel.exception.SystemException {
131                    return getService().dynamicQuery(dynamicQuery, start, end);
132            }
133    
134            /**
135            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
136            *
137            * <p>
138            * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.journal.model.impl.JournalFeedModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
139            * </p>
140            *
141            * @param dynamicQuery the dynamic query
142            * @param start the lower bound of the range of model instances
143            * @param end the upper bound of the range of model instances (not inclusive)
144            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
145            * @return the ordered range of matching rows
146            * @throws SystemException if a system exception occurred
147            */
148            @SuppressWarnings("rawtypes")
149            public static java.util.List dynamicQuery(
150                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
151                    int end,
152                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
153                    throws com.liferay.portal.kernel.exception.SystemException {
154                    return getService()
155                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
156            }
157    
158            /**
159            * Returns the number of rows that match the dynamic query.
160            *
161            * @param dynamicQuery the dynamic query
162            * @return the number of rows that match the dynamic query
163            * @throws SystemException if a system exception occurred
164            */
165            public static long dynamicQueryCount(
166                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
167                    throws com.liferay.portal.kernel.exception.SystemException {
168                    return getService().dynamicQueryCount(dynamicQuery);
169            }
170    
171            /**
172            * Returns the number of rows that match the dynamic query.
173            *
174            * @param dynamicQuery the dynamic query
175            * @param projection the projection to apply to the query
176            * @return the number of rows that match the dynamic query
177            * @throws SystemException if a system exception occurred
178            */
179            public static long dynamicQueryCount(
180                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
181                    com.liferay.portal.kernel.dao.orm.Projection projection)
182                    throws com.liferay.portal.kernel.exception.SystemException {
183                    return getService().dynamicQueryCount(dynamicQuery, projection);
184            }
185    
186            public static com.liferay.portlet.journal.model.JournalFeed fetchJournalFeed(
187                    long id) throws com.liferay.portal.kernel.exception.SystemException {
188                    return getService().fetchJournalFeed(id);
189            }
190    
191            /**
192            * Returns the journal feed with the matching UUID and company.
193            *
194            * @param uuid the journal feed's UUID
195            * @param companyId the primary key of the company
196            * @return the matching journal feed, or <code>null</code> if a matching journal feed could not be found
197            * @throws SystemException if a system exception occurred
198            */
199            public static com.liferay.portlet.journal.model.JournalFeed fetchJournalFeedByUuidAndCompanyId(
200                    java.lang.String uuid, long companyId)
201                    throws com.liferay.portal.kernel.exception.SystemException {
202                    return getService().fetchJournalFeedByUuidAndCompanyId(uuid, companyId);
203            }
204    
205            /**
206            * Returns the journal feed matching the UUID and group.
207            *
208            * @param uuid the journal feed's UUID
209            * @param groupId the primary key of the group
210            * @return the matching journal feed, or <code>null</code> if a matching journal feed could not be found
211            * @throws SystemException if a system exception occurred
212            */
213            public static com.liferay.portlet.journal.model.JournalFeed fetchJournalFeedByUuidAndGroupId(
214                    java.lang.String uuid, long groupId)
215                    throws com.liferay.portal.kernel.exception.SystemException {
216                    return getService().fetchJournalFeedByUuidAndGroupId(uuid, groupId);
217            }
218    
219            /**
220            * Returns the journal feed with the primary key.
221            *
222            * @param id the primary key of the journal feed
223            * @return the journal feed
224            * @throws PortalException if a journal feed with the primary key could not be found
225            * @throws SystemException if a system exception occurred
226            */
227            public static com.liferay.portlet.journal.model.JournalFeed getJournalFeed(
228                    long id)
229                    throws com.liferay.portal.kernel.exception.PortalException,
230                            com.liferay.portal.kernel.exception.SystemException {
231                    return getService().getJournalFeed(id);
232            }
233    
234            public static com.liferay.portal.model.PersistedModel getPersistedModel(
235                    java.io.Serializable primaryKeyObj)
236                    throws com.liferay.portal.kernel.exception.PortalException,
237                            com.liferay.portal.kernel.exception.SystemException {
238                    return getService().getPersistedModel(primaryKeyObj);
239            }
240    
241            /**
242            * Returns the journal feed with the matching UUID and company.
243            *
244            * @param uuid the journal feed's UUID
245            * @param companyId the primary key of the company
246            * @return the matching journal feed
247            * @throws PortalException if a matching journal feed could not be found
248            * @throws SystemException if a system exception occurred
249            */
250            public static com.liferay.portlet.journal.model.JournalFeed getJournalFeedByUuidAndCompanyId(
251                    java.lang.String uuid, long companyId)
252                    throws com.liferay.portal.kernel.exception.PortalException,
253                            com.liferay.portal.kernel.exception.SystemException {
254                    return getService().getJournalFeedByUuidAndCompanyId(uuid, companyId);
255            }
256    
257            /**
258            * Returns the journal feed matching the UUID and group.
259            *
260            * @param uuid the journal feed's UUID
261            * @param groupId the primary key of the group
262            * @return the matching journal feed
263            * @throws PortalException if a matching journal feed could not be found
264            * @throws SystemException if a system exception occurred
265            */
266            public static com.liferay.portlet.journal.model.JournalFeed getJournalFeedByUuidAndGroupId(
267                    java.lang.String uuid, long groupId)
268                    throws com.liferay.portal.kernel.exception.PortalException,
269                            com.liferay.portal.kernel.exception.SystemException {
270                    return getService().getJournalFeedByUuidAndGroupId(uuid, groupId);
271            }
272    
273            /**
274            * Returns a range of all the journal feeds.
275            *
276            * <p>
277            * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.journal.model.impl.JournalFeedModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
278            * </p>
279            *
280            * @param start the lower bound of the range of journal feeds
281            * @param end the upper bound of the range of journal feeds (not inclusive)
282            * @return the range of journal feeds
283            * @throws SystemException if a system exception occurred
284            */
285            public static java.util.List<com.liferay.portlet.journal.model.JournalFeed> getJournalFeeds(
286                    int start, int end)
287                    throws com.liferay.portal.kernel.exception.SystemException {
288                    return getService().getJournalFeeds(start, end);
289            }
290    
291            /**
292            * Returns the number of journal feeds.
293            *
294            * @return the number of journal feeds
295            * @throws SystemException if a system exception occurred
296            */
297            public static int getJournalFeedsCount()
298                    throws com.liferay.portal.kernel.exception.SystemException {
299                    return getService().getJournalFeedsCount();
300            }
301    
302            /**
303            * Updates the journal feed in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
304            *
305            * @param journalFeed the journal feed
306            * @return the journal feed that was updated
307            * @throws SystemException if a system exception occurred
308            */
309            public static com.liferay.portlet.journal.model.JournalFeed updateJournalFeed(
310                    com.liferay.portlet.journal.model.JournalFeed journalFeed)
311                    throws com.liferay.portal.kernel.exception.SystemException {
312                    return getService().updateJournalFeed(journalFeed);
313            }
314    
315            /**
316            * Returns the Spring bean ID for this bean.
317            *
318            * @return the Spring bean ID for this bean
319            */
320            public static java.lang.String getBeanIdentifier() {
321                    return getService().getBeanIdentifier();
322            }
323    
324            /**
325            * Sets the Spring bean ID for this bean.
326            *
327            * @param beanIdentifier the Spring bean ID for this bean
328            */
329            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
330                    getService().setBeanIdentifier(beanIdentifier);
331            }
332    
333            public static com.liferay.portlet.journal.model.JournalFeed addFeed(
334                    long userId, long groupId, java.lang.String feedId, boolean autoFeedId,
335                    java.lang.String name, java.lang.String description,
336                    java.lang.String type, java.lang.String structureId,
337                    java.lang.String templateId, java.lang.String rendererTemplateId,
338                    int delta, java.lang.String orderByCol, java.lang.String orderByType,
339                    java.lang.String targetLayoutFriendlyUrl,
340                    java.lang.String targetPortletId, java.lang.String contentField,
341                    java.lang.String feedFormat, double feedVersion,
342                    com.liferay.portal.service.ServiceContext serviceContext)
343                    throws com.liferay.portal.kernel.exception.PortalException,
344                            com.liferay.portal.kernel.exception.SystemException {
345                    return getService()
346                                       .addFeed(userId, groupId, feedId, autoFeedId, name,
347                            description, type, structureId, templateId, rendererTemplateId,
348                            delta, orderByCol, orderByType, targetLayoutFriendlyUrl,
349                            targetPortletId, contentField, feedFormat, feedVersion,
350                            serviceContext);
351            }
352    
353            public static void addFeedResources(
354                    com.liferay.portlet.journal.model.JournalFeed feed,
355                    boolean addGroupPermissions, boolean addGuestPermissions)
356                    throws com.liferay.portal.kernel.exception.PortalException,
357                            com.liferay.portal.kernel.exception.SystemException {
358                    getService()
359                            .addFeedResources(feed, addGroupPermissions, addGuestPermissions);
360            }
361    
362            public static void addFeedResources(
363                    com.liferay.portlet.journal.model.JournalFeed feed,
364                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
365                    throws com.liferay.portal.kernel.exception.PortalException,
366                            com.liferay.portal.kernel.exception.SystemException {
367                    getService().addFeedResources(feed, groupPermissions, guestPermissions);
368            }
369    
370            public static void addFeedResources(long feedId,
371                    boolean addGroupPermissions, boolean addGuestPermissions)
372                    throws com.liferay.portal.kernel.exception.PortalException,
373                            com.liferay.portal.kernel.exception.SystemException {
374                    getService()
375                            .addFeedResources(feedId, addGroupPermissions, addGuestPermissions);
376            }
377    
378            public static void addFeedResources(long feedId,
379                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
380                    throws com.liferay.portal.kernel.exception.PortalException,
381                            com.liferay.portal.kernel.exception.SystemException {
382                    getService().addFeedResources(feedId, groupPermissions, guestPermissions);
383            }
384    
385            public static void deleteFeed(
386                    com.liferay.portlet.journal.model.JournalFeed feed)
387                    throws com.liferay.portal.kernel.exception.PortalException,
388                            com.liferay.portal.kernel.exception.SystemException {
389                    getService().deleteFeed(feed);
390            }
391    
392            public static void deleteFeed(long feedId)
393                    throws com.liferay.portal.kernel.exception.PortalException,
394                            com.liferay.portal.kernel.exception.SystemException {
395                    getService().deleteFeed(feedId);
396            }
397    
398            public static void deleteFeed(long groupId, java.lang.String feedId)
399                    throws com.liferay.portal.kernel.exception.PortalException,
400                            com.liferay.portal.kernel.exception.SystemException {
401                    getService().deleteFeed(groupId, feedId);
402            }
403    
404            public static com.liferay.portlet.journal.model.JournalFeed fetchFeed(
405                    long groupId, java.lang.String feedId)
406                    throws com.liferay.portal.kernel.exception.SystemException {
407                    return getService().fetchFeed(groupId, feedId);
408            }
409    
410            public static com.liferay.portlet.journal.model.JournalFeed getFeed(
411                    long feedId)
412                    throws com.liferay.portal.kernel.exception.PortalException,
413                            com.liferay.portal.kernel.exception.SystemException {
414                    return getService().getFeed(feedId);
415            }
416    
417            public static com.liferay.portlet.journal.model.JournalFeed getFeed(
418                    long groupId, java.lang.String feedId)
419                    throws com.liferay.portal.kernel.exception.PortalException,
420                            com.liferay.portal.kernel.exception.SystemException {
421                    return getService().getFeed(groupId, feedId);
422            }
423    
424            public static java.util.List<com.liferay.portlet.journal.model.JournalFeed> getFeeds()
425                    throws com.liferay.portal.kernel.exception.SystemException {
426                    return getService().getFeeds();
427            }
428    
429            public static java.util.List<com.liferay.portlet.journal.model.JournalFeed> getFeeds(
430                    long groupId)
431                    throws com.liferay.portal.kernel.exception.SystemException {
432                    return getService().getFeeds(groupId);
433            }
434    
435            public static java.util.List<com.liferay.portlet.journal.model.JournalFeed> getFeeds(
436                    long groupId, int start, int end)
437                    throws com.liferay.portal.kernel.exception.SystemException {
438                    return getService().getFeeds(groupId, start, end);
439            }
440    
441            public static int getFeedsCount(long groupId)
442                    throws com.liferay.portal.kernel.exception.SystemException {
443                    return getService().getFeedsCount(groupId);
444            }
445    
446            public static java.util.List<com.liferay.portlet.journal.model.JournalFeed> search(
447                    long companyId, long groupId, java.lang.String keywords, int start,
448                    int end, com.liferay.portal.kernel.util.OrderByComparator obc)
449                    throws com.liferay.portal.kernel.exception.SystemException {
450                    return getService().search(companyId, groupId, keywords, start, end, obc);
451            }
452    
453            public static java.util.List<com.liferay.portlet.journal.model.JournalFeed> search(
454                    long companyId, long groupId, java.lang.String feedId,
455                    java.lang.String name, java.lang.String description,
456                    boolean andOperator, int start, int end,
457                    com.liferay.portal.kernel.util.OrderByComparator obc)
458                    throws com.liferay.portal.kernel.exception.SystemException {
459                    return getService()
460                                       .search(companyId, groupId, feedId, name, description,
461                            andOperator, start, end, obc);
462            }
463    
464            public static int searchCount(long companyId, long groupId,
465                    java.lang.String keywords)
466                    throws com.liferay.portal.kernel.exception.SystemException {
467                    return getService().searchCount(companyId, groupId, keywords);
468            }
469    
470            public static int searchCount(long companyId, long groupId,
471                    java.lang.String feedId, java.lang.String name,
472                    java.lang.String description, boolean andOperator)
473                    throws com.liferay.portal.kernel.exception.SystemException {
474                    return getService()
475                                       .searchCount(companyId, groupId, feedId, name, description,
476                            andOperator);
477            }
478    
479            public static com.liferay.portlet.journal.model.JournalFeed updateFeed(
480                    long groupId, java.lang.String feedId, java.lang.String name,
481                    java.lang.String description, java.lang.String type,
482                    java.lang.String structureId, java.lang.String templateId,
483                    java.lang.String rendererTemplateId, int delta,
484                    java.lang.String orderByCol, java.lang.String orderByType,
485                    java.lang.String targetLayoutFriendlyUrl,
486                    java.lang.String targetPortletId, java.lang.String contentField,
487                    java.lang.String feedFormat, double feedVersion,
488                    com.liferay.portal.service.ServiceContext serviceContext)
489                    throws com.liferay.portal.kernel.exception.PortalException,
490                            com.liferay.portal.kernel.exception.SystemException {
491                    return getService()
492                                       .updateFeed(groupId, feedId, name, description, type,
493                            structureId, templateId, rendererTemplateId, delta, orderByCol,
494                            orderByType, targetLayoutFriendlyUrl, targetPortletId,
495                            contentField, feedFormat, feedVersion, serviceContext);
496            }
497    
498            public static JournalFeedLocalService getService() {
499                    if (_service == null) {
500                            _service = (JournalFeedLocalService)PortalBeanLocatorUtil.locate(JournalFeedLocalService.class.getName());
501    
502                            ReferenceRegistry.registerReference(JournalFeedLocalServiceUtil.class,
503                                    "_service");
504                    }
505    
506                    return _service;
507            }
508    
509            /**
510             * @deprecated As of 6.2.0
511             */
512            public void setService(JournalFeedLocalService service) {
513            }
514    
515            private static JournalFeedLocalService _service;
516    }