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