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