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.exception.PortalException;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.kernel.transaction.Isolation;
020    import com.liferay.portal.kernel.transaction.Propagation;
021    import com.liferay.portal.kernel.transaction.Transactional;
022    import com.liferay.portal.service.BaseLocalService;
023    import com.liferay.portal.service.PersistedModelLocalService;
024    
025    /**
026     * Provides the local service interface for JournalFeed. Methods of this
027     * service will not have security checks based on the propagated JAAS
028     * credentials because this service can only be accessed from within the same
029     * VM.
030     *
031     * @author Brian Wing Shun Chan
032     * @see JournalFeedLocalServiceUtil
033     * @see com.liferay.portlet.journal.service.base.JournalFeedLocalServiceBaseImpl
034     * @see com.liferay.portlet.journal.service.impl.JournalFeedLocalServiceImpl
035     * @generated
036     */
037    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
038            PortalException.class, SystemException.class})
039    public interface JournalFeedLocalService extends BaseLocalService,
040            PersistedModelLocalService {
041            /*
042             * NOTE FOR DEVELOPERS:
043             *
044             * Never modify or reference this interface directly. Always use {@link JournalFeedLocalServiceUtil} to access the journal feed local service. Add custom service methods to {@link com.liferay.portlet.journal.service.impl.JournalFeedLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
045             */
046    
047            /**
048            * Adds the journal feed to the database. Also notifies the appropriate model listeners.
049            *
050            * @param journalFeed the journal feed
051            * @return the journal feed that was added
052            * @throws SystemException if a system exception occurred
053            */
054            public com.liferay.portlet.journal.model.JournalFeed addJournalFeed(
055                    com.liferay.portlet.journal.model.JournalFeed journalFeed)
056                    throws com.liferay.portal.kernel.exception.SystemException;
057    
058            /**
059            * Creates a new journal feed with the primary key. Does not add the journal feed to the database.
060            *
061            * @param id the primary key for the new journal feed
062            * @return the new journal feed
063            */
064            public com.liferay.portlet.journal.model.JournalFeed createJournalFeed(
065                    long id);
066    
067            /**
068            * Deletes the journal feed with the primary key from the database. Also notifies the appropriate model listeners.
069            *
070            * @param id the primary key of the journal feed
071            * @return the journal feed that was removed
072            * @throws PortalException if a journal feed with the primary key could not be found
073            * @throws SystemException if a system exception occurred
074            */
075            public com.liferay.portlet.journal.model.JournalFeed deleteJournalFeed(
076                    long id)
077                    throws com.liferay.portal.kernel.exception.PortalException,
078                            com.liferay.portal.kernel.exception.SystemException;
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 com.liferay.portlet.journal.model.JournalFeed deleteJournalFeed(
088                    com.liferay.portlet.journal.model.JournalFeed journalFeed)
089                    throws com.liferay.portal.kernel.exception.SystemException;
090    
091            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
092    
093            /**
094            * Performs a dynamic query on the database and returns the matching rows.
095            *
096            * @param dynamicQuery the dynamic query
097            * @return the matching rows
098            * @throws SystemException if a system exception occurred
099            */
100            @SuppressWarnings("rawtypes")
101            public java.util.List dynamicQuery(
102                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
103                    throws com.liferay.portal.kernel.exception.SystemException;
104    
105            /**
106            * Performs a dynamic query on the database and returns a range of the matching rows.
107            *
108            * <p>
109            * 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.
110            * </p>
111            *
112            * @param dynamicQuery the dynamic query
113            * @param start the lower bound of the range of model instances
114            * @param end the upper bound of the range of model instances (not inclusive)
115            * @return the range of matching rows
116            * @throws SystemException if a system exception occurred
117            */
118            @SuppressWarnings("rawtypes")
119            public java.util.List dynamicQuery(
120                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
121                    int end) throws com.liferay.portal.kernel.exception.SystemException;
122    
123            /**
124            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
125            *
126            * <p>
127            * 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.
128            * </p>
129            *
130            * @param dynamicQuery the dynamic query
131            * @param start the lower bound of the range of model instances
132            * @param end the upper bound of the range of model instances (not inclusive)
133            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
134            * @return the ordered range of matching rows
135            * @throws SystemException if a system exception occurred
136            */
137            @SuppressWarnings("rawtypes")
138            public java.util.List dynamicQuery(
139                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
140                    int end,
141                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
142                    throws com.liferay.portal.kernel.exception.SystemException;
143    
144            /**
145            * Returns the number of rows that match the dynamic query.
146            *
147            * @param dynamicQuery the dynamic query
148            * @return the number of rows that match the dynamic query
149            * @throws SystemException if a system exception occurred
150            */
151            public long dynamicQueryCount(
152                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
153                    throws com.liferay.portal.kernel.exception.SystemException;
154    
155            /**
156            * Returns the number of rows that match the dynamic query.
157            *
158            * @param dynamicQuery the dynamic query
159            * @param projection the projection to apply to the query
160            * @return the number of rows that match the dynamic query
161            * @throws SystemException if a system exception occurred
162            */
163            public long dynamicQueryCount(
164                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
165                    com.liferay.portal.kernel.dao.orm.Projection projection)
166                    throws com.liferay.portal.kernel.exception.SystemException;
167    
168            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
169            public com.liferay.portlet.journal.model.JournalFeed fetchJournalFeed(
170                    long id) throws com.liferay.portal.kernel.exception.SystemException;
171    
172            /**
173            * Returns the journal feed with the matching UUID and company.
174            *
175            * @param uuid the journal feed's UUID
176            * @param companyId the primary key of the company
177            * @return the matching journal feed, or <code>null</code> if a matching journal feed could not be found
178            * @throws SystemException if a system exception occurred
179            */
180            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
181            public com.liferay.portlet.journal.model.JournalFeed fetchJournalFeedByUuidAndCompanyId(
182                    java.lang.String uuid, long companyId)
183                    throws com.liferay.portal.kernel.exception.SystemException;
184    
185            /**
186            * Returns the journal feed matching the UUID and group.
187            *
188            * @param uuid the journal feed's UUID
189            * @param groupId the primary key of the group
190            * @return the matching journal feed, or <code>null</code> if a matching journal feed could not be found
191            * @throws SystemException if a system exception occurred
192            */
193            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
194            public com.liferay.portlet.journal.model.JournalFeed fetchJournalFeedByUuidAndGroupId(
195                    java.lang.String uuid, long groupId)
196                    throws com.liferay.portal.kernel.exception.SystemException;
197    
198            /**
199            * Returns the journal feed with the primary key.
200            *
201            * @param id the primary key of the journal feed
202            * @return the journal feed
203            * @throws PortalException if a journal feed with the primary key could not be found
204            * @throws SystemException if a system exception occurred
205            */
206            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
207            public com.liferay.portlet.journal.model.JournalFeed getJournalFeed(long id)
208                    throws com.liferay.portal.kernel.exception.PortalException,
209                            com.liferay.portal.kernel.exception.SystemException;
210    
211            @Override
212            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
213            public com.liferay.portal.model.PersistedModel getPersistedModel(
214                    java.io.Serializable primaryKeyObj)
215                    throws com.liferay.portal.kernel.exception.PortalException,
216                            com.liferay.portal.kernel.exception.SystemException;
217    
218            /**
219            * Returns the journal feed with the matching UUID and company.
220            *
221            * @param uuid the journal feed's UUID
222            * @param companyId the primary key of the company
223            * @return the matching journal feed
224            * @throws PortalException if a matching journal feed could not be found
225            * @throws SystemException if a system exception occurred
226            */
227            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
228            public com.liferay.portlet.journal.model.JournalFeed getJournalFeedByUuidAndCompanyId(
229                    java.lang.String uuid, long companyId)
230                    throws com.liferay.portal.kernel.exception.PortalException,
231                            com.liferay.portal.kernel.exception.SystemException;
232    
233            /**
234            * Returns the journal feed matching the UUID and group.
235            *
236            * @param uuid the journal feed's UUID
237            * @param groupId the primary key of the group
238            * @return the matching journal feed
239            * @throws PortalException if a matching journal feed could not be found
240            * @throws SystemException if a system exception occurred
241            */
242            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
243            public com.liferay.portlet.journal.model.JournalFeed getJournalFeedByUuidAndGroupId(
244                    java.lang.String uuid, long groupId)
245                    throws com.liferay.portal.kernel.exception.PortalException,
246                            com.liferay.portal.kernel.exception.SystemException;
247    
248            /**
249            * Returns a range of all the journal feeds.
250            *
251            * <p>
252            * 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.
253            * </p>
254            *
255            * @param start the lower bound of the range of journal feeds
256            * @param end the upper bound of the range of journal feeds (not inclusive)
257            * @return the range of journal feeds
258            * @throws SystemException if a system exception occurred
259            */
260            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
261            public java.util.List<com.liferay.portlet.journal.model.JournalFeed> getJournalFeeds(
262                    int start, int end)
263                    throws com.liferay.portal.kernel.exception.SystemException;
264    
265            /**
266            * Returns the number of journal feeds.
267            *
268            * @return the number of journal feeds
269            * @throws SystemException if a system exception occurred
270            */
271            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
272            public int getJournalFeedsCount()
273                    throws com.liferay.portal.kernel.exception.SystemException;
274    
275            /**
276            * Updates the journal feed in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
277            *
278            * @param journalFeed the journal feed
279            * @return the journal feed that was updated
280            * @throws SystemException if a system exception occurred
281            */
282            public com.liferay.portlet.journal.model.JournalFeed updateJournalFeed(
283                    com.liferay.portlet.journal.model.JournalFeed journalFeed)
284                    throws com.liferay.portal.kernel.exception.SystemException;
285    
286            /**
287            * Returns the Spring bean ID for this bean.
288            *
289            * @return the Spring bean ID for this bean
290            */
291            public java.lang.String getBeanIdentifier();
292    
293            /**
294            * Sets the Spring bean ID for this bean.
295            *
296            * @param beanIdentifier the Spring bean ID for this bean
297            */
298            public void setBeanIdentifier(java.lang.String beanIdentifier);
299    
300            public com.liferay.portlet.journal.model.JournalFeed addFeed(long userId,
301                    long groupId, java.lang.String feedId, boolean autoFeedId,
302                    java.lang.String name, java.lang.String description,
303                    java.lang.String type, java.lang.String structureId,
304                    java.lang.String templateId, java.lang.String rendererTemplateId,
305                    int delta, java.lang.String orderByCol, java.lang.String orderByType,
306                    java.lang.String targetLayoutFriendlyUrl,
307                    java.lang.String targetPortletId, java.lang.String contentField,
308                    java.lang.String feedFormat, double feedVersion,
309                    com.liferay.portal.service.ServiceContext serviceContext)
310                    throws com.liferay.portal.kernel.exception.PortalException,
311                            com.liferay.portal.kernel.exception.SystemException;
312    
313            public void addFeedResources(
314                    com.liferay.portlet.journal.model.JournalFeed feed,
315                    boolean addGroupPermissions, boolean addGuestPermissions)
316                    throws com.liferay.portal.kernel.exception.PortalException,
317                            com.liferay.portal.kernel.exception.SystemException;
318    
319            public void addFeedResources(
320                    com.liferay.portlet.journal.model.JournalFeed feed,
321                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
322                    throws com.liferay.portal.kernel.exception.PortalException,
323                            com.liferay.portal.kernel.exception.SystemException;
324    
325            public void addFeedResources(long feedId, boolean addGroupPermissions,
326                    boolean addGuestPermissions)
327                    throws com.liferay.portal.kernel.exception.PortalException,
328                            com.liferay.portal.kernel.exception.SystemException;
329    
330            public void addFeedResources(long feedId,
331                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
332                    throws com.liferay.portal.kernel.exception.PortalException,
333                            com.liferay.portal.kernel.exception.SystemException;
334    
335            public void deleteFeed(com.liferay.portlet.journal.model.JournalFeed feed)
336                    throws com.liferay.portal.kernel.exception.PortalException,
337                            com.liferay.portal.kernel.exception.SystemException;
338    
339            public void deleteFeed(long feedId)
340                    throws com.liferay.portal.kernel.exception.PortalException,
341                            com.liferay.portal.kernel.exception.SystemException;
342    
343            public void deleteFeed(long groupId, java.lang.String feedId)
344                    throws com.liferay.portal.kernel.exception.PortalException,
345                            com.liferay.portal.kernel.exception.SystemException;
346    
347            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
348            public com.liferay.portlet.journal.model.JournalFeed fetchFeed(
349                    long groupId, java.lang.String feedId)
350                    throws com.liferay.portal.kernel.exception.SystemException;
351    
352            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
353            public com.liferay.portlet.journal.model.JournalFeed getFeed(long feedId)
354                    throws com.liferay.portal.kernel.exception.PortalException,
355                            com.liferay.portal.kernel.exception.SystemException;
356    
357            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
358            public com.liferay.portlet.journal.model.JournalFeed getFeed(long groupId,
359                    java.lang.String feedId)
360                    throws com.liferay.portal.kernel.exception.PortalException,
361                            com.liferay.portal.kernel.exception.SystemException;
362    
363            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
364            public java.util.List<com.liferay.portlet.journal.model.JournalFeed> getFeeds()
365                    throws com.liferay.portal.kernel.exception.SystemException;
366    
367            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
368            public java.util.List<com.liferay.portlet.journal.model.JournalFeed> getFeeds(
369                    long groupId)
370                    throws com.liferay.portal.kernel.exception.SystemException;
371    
372            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
373            public java.util.List<com.liferay.portlet.journal.model.JournalFeed> getFeeds(
374                    long groupId, int start, int end)
375                    throws com.liferay.portal.kernel.exception.SystemException;
376    
377            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
378            public int getFeedsCount(long groupId)
379                    throws com.liferay.portal.kernel.exception.SystemException;
380    
381            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
382            public java.util.List<com.liferay.portlet.journal.model.JournalFeed> search(
383                    long companyId, long groupId, java.lang.String keywords, int start,
384                    int end, com.liferay.portal.kernel.util.OrderByComparator obc)
385                    throws com.liferay.portal.kernel.exception.SystemException;
386    
387            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
388            public java.util.List<com.liferay.portlet.journal.model.JournalFeed> search(
389                    long companyId, long groupId, java.lang.String feedId,
390                    java.lang.String name, java.lang.String description,
391                    boolean andOperator, int start, int end,
392                    com.liferay.portal.kernel.util.OrderByComparator obc)
393                    throws com.liferay.portal.kernel.exception.SystemException;
394    
395            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
396            public int searchCount(long companyId, long groupId,
397                    java.lang.String keywords)
398                    throws com.liferay.portal.kernel.exception.SystemException;
399    
400            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
401            public 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    
406            public com.liferay.portlet.journal.model.JournalFeed updateFeed(
407                    long groupId, java.lang.String feedId, java.lang.String name,
408                    java.lang.String description, java.lang.String type,
409                    java.lang.String structureId, java.lang.String templateId,
410                    java.lang.String rendererTemplateId, int delta,
411                    java.lang.String orderByCol, java.lang.String orderByType,
412                    java.lang.String targetLayoutFriendlyUrl,
413                    java.lang.String targetPortletId, java.lang.String contentField,
414                    java.lang.String feedFormat, double feedVersion,
415                    com.liferay.portal.service.ServiceContext serviceContext)
416                    throws com.liferay.portal.kernel.exception.PortalException,
417                            com.liferay.portal.kernel.exception.SystemException;
418    }