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. 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.
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. 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.
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 matching the UUID and group.
196            *
197            * @param uuid the journal feed's UUID
198            * @param groupId the primary key of the group
199            * @return the matching journal feed
200            * @throws PortalException if a matching journal feed 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. 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.
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            * Returns the Spring bean ID for this bean.
254            *
255            * @return the Spring bean ID for this bean
256            */
257            public static java.lang.String getBeanIdentifier() {
258                    return getService().getBeanIdentifier();
259            }
260    
261            /**
262            * Sets the Spring bean ID for this bean.
263            *
264            * @param beanIdentifier the Spring bean ID for this bean
265            */
266            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
267                    getService().setBeanIdentifier(beanIdentifier);
268            }
269    
270            public static com.liferay.portlet.journal.model.JournalFeed addFeed(
271                    long userId, long groupId, java.lang.String feedId, boolean autoFeedId,
272                    java.lang.String name, java.lang.String description,
273                    java.lang.String type, java.lang.String structureId,
274                    java.lang.String templateId, java.lang.String rendererTemplateId,
275                    int delta, java.lang.String orderByCol, java.lang.String orderByType,
276                    java.lang.String targetLayoutFriendlyUrl,
277                    java.lang.String targetPortletId, java.lang.String contentField,
278                    java.lang.String feedFormat, double feedVersion,
279                    com.liferay.portal.service.ServiceContext serviceContext)
280                    throws com.liferay.portal.kernel.exception.PortalException,
281                            com.liferay.portal.kernel.exception.SystemException {
282                    return getService()
283                                       .addFeed(userId, groupId, feedId, autoFeedId, name,
284                            description, type, structureId, templateId, rendererTemplateId,
285                            delta, orderByCol, orderByType, targetLayoutFriendlyUrl,
286                            targetPortletId, contentField, feedFormat, feedVersion,
287                            serviceContext);
288            }
289    
290            public static void addFeedResources(
291                    com.liferay.portlet.journal.model.JournalFeed feed,
292                    boolean addGroupPermissions, boolean addGuestPermissions)
293                    throws com.liferay.portal.kernel.exception.PortalException,
294                            com.liferay.portal.kernel.exception.SystemException {
295                    getService()
296                            .addFeedResources(feed, addGroupPermissions, addGuestPermissions);
297            }
298    
299            public static void addFeedResources(
300                    com.liferay.portlet.journal.model.JournalFeed feed,
301                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
302                    throws com.liferay.portal.kernel.exception.PortalException,
303                            com.liferay.portal.kernel.exception.SystemException {
304                    getService().addFeedResources(feed, groupPermissions, guestPermissions);
305            }
306    
307            public static void addFeedResources(long feedId,
308                    boolean addGroupPermissions, boolean addGuestPermissions)
309                    throws com.liferay.portal.kernel.exception.PortalException,
310                            com.liferay.portal.kernel.exception.SystemException {
311                    getService()
312                            .addFeedResources(feedId, addGroupPermissions, addGuestPermissions);
313            }
314    
315            public static void addFeedResources(long feedId,
316                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
317                    throws com.liferay.portal.kernel.exception.PortalException,
318                            com.liferay.portal.kernel.exception.SystemException {
319                    getService().addFeedResources(feedId, groupPermissions, guestPermissions);
320            }
321    
322            public static void deleteFeed(
323                    com.liferay.portlet.journal.model.JournalFeed feed)
324                    throws com.liferay.portal.kernel.exception.PortalException,
325                            com.liferay.portal.kernel.exception.SystemException {
326                    getService().deleteFeed(feed);
327            }
328    
329            public static void deleteFeed(long feedId)
330                    throws com.liferay.portal.kernel.exception.PortalException,
331                            com.liferay.portal.kernel.exception.SystemException {
332                    getService().deleteFeed(feedId);
333            }
334    
335            public static void deleteFeed(long groupId, java.lang.String feedId)
336                    throws com.liferay.portal.kernel.exception.PortalException,
337                            com.liferay.portal.kernel.exception.SystemException {
338                    getService().deleteFeed(groupId, feedId);
339            }
340    
341            public static com.liferay.portlet.journal.model.JournalFeed getFeed(
342                    long feedId)
343                    throws com.liferay.portal.kernel.exception.PortalException,
344                            com.liferay.portal.kernel.exception.SystemException {
345                    return getService().getFeed(feedId);
346            }
347    
348            public static com.liferay.portlet.journal.model.JournalFeed getFeed(
349                    long groupId, java.lang.String feedId)
350                    throws com.liferay.portal.kernel.exception.PortalException,
351                            com.liferay.portal.kernel.exception.SystemException {
352                    return getService().getFeed(groupId, feedId);
353            }
354    
355            public static java.util.List<com.liferay.portlet.journal.model.JournalFeed> getFeeds()
356                    throws com.liferay.portal.kernel.exception.SystemException {
357                    return getService().getFeeds();
358            }
359    
360            public static java.util.List<com.liferay.portlet.journal.model.JournalFeed> getFeeds(
361                    long groupId)
362                    throws com.liferay.portal.kernel.exception.SystemException {
363                    return getService().getFeeds(groupId);
364            }
365    
366            public static java.util.List<com.liferay.portlet.journal.model.JournalFeed> getFeeds(
367                    long groupId, int start, int end)
368                    throws com.liferay.portal.kernel.exception.SystemException {
369                    return getService().getFeeds(groupId, start, end);
370            }
371    
372            public static int getFeedsCount(long groupId)
373                    throws com.liferay.portal.kernel.exception.SystemException {
374                    return getService().getFeedsCount(groupId);
375            }
376    
377            public static java.util.List<com.liferay.portlet.journal.model.JournalFeed> search(
378                    long companyId, long groupId, java.lang.String keywords, int start,
379                    int end, com.liferay.portal.kernel.util.OrderByComparator obc)
380                    throws com.liferay.portal.kernel.exception.SystemException {
381                    return getService().search(companyId, groupId, keywords, start, end, obc);
382            }
383    
384            public static java.util.List<com.liferay.portlet.journal.model.JournalFeed> search(
385                    long companyId, long groupId, java.lang.String feedId,
386                    java.lang.String name, java.lang.String description,
387                    boolean andOperator, int start, int end,
388                    com.liferay.portal.kernel.util.OrderByComparator obc)
389                    throws com.liferay.portal.kernel.exception.SystemException {
390                    return getService()
391                                       .search(companyId, groupId, feedId, name, description,
392                            andOperator, start, end, obc);
393            }
394    
395            public static int searchCount(long companyId, long groupId,
396                    java.lang.String keywords)
397                    throws com.liferay.portal.kernel.exception.SystemException {
398                    return getService().searchCount(companyId, groupId, keywords);
399            }
400    
401            public static int searchCount(long companyId, long groupId,
402                    java.lang.String feedId, java.lang.String name,
403                    java.lang.String description, boolean andOperator)
404                    throws com.liferay.portal.kernel.exception.SystemException {
405                    return getService()
406                                       .searchCount(companyId, groupId, feedId, name, description,
407                            andOperator);
408            }
409    
410            public static com.liferay.portlet.journal.model.JournalFeed updateFeed(
411                    long groupId, java.lang.String feedId, java.lang.String name,
412                    java.lang.String description, java.lang.String type,
413                    java.lang.String structureId, java.lang.String templateId,
414                    java.lang.String rendererTemplateId, int delta,
415                    java.lang.String orderByCol, java.lang.String orderByType,
416                    java.lang.String targetLayoutFriendlyUrl,
417                    java.lang.String targetPortletId, java.lang.String contentField,
418                    java.lang.String feedFormat, double feedVersion,
419                    com.liferay.portal.service.ServiceContext serviceContext)
420                    throws com.liferay.portal.kernel.exception.PortalException,
421                            com.liferay.portal.kernel.exception.SystemException {
422                    return getService()
423                                       .updateFeed(groupId, feedId, name, description, type,
424                            structureId, templateId, rendererTemplateId, delta, orderByCol,
425                            orderByType, targetLayoutFriendlyUrl, targetPortletId,
426                            contentField, feedFormat, feedVersion, serviceContext);
427            }
428    
429            public static JournalFeedLocalService getService() {
430                    if (_service == null) {
431                            _service = (JournalFeedLocalService)PortalBeanLocatorUtil.locate(JournalFeedLocalService.class.getName());
432    
433                            ReferenceRegistry.registerReference(JournalFeedLocalServiceUtil.class,
434                                    "_service");
435                    }
436    
437                    return _service;
438            }
439    
440            /**
441             * @deprecated As of 6.2.0
442             */
443            public void setService(JournalFeedLocalService service) {
444            }
445    
446            private static JournalFeedLocalService _service;
447    }