001    /**
002     * Copyright (c) 2000-2010 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.annotation.Isolation;
018    import com.liferay.portal.kernel.annotation.Propagation;
019    import com.liferay.portal.kernel.annotation.Transactional;
020    import com.liferay.portal.kernel.exception.PortalException;
021    import com.liferay.portal.kernel.exception.SystemException;
022    
023    /**
024     * The interface for the journal feed local service.
025     *
026     * <p>
027     * 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.
028     * </p>
029     *
030     * <p>
031     * 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.
032     * </p>
033     *
034     * @author Brian Wing Shun Chan
035     * @see JournalFeedLocalServiceUtil
036     * @see com.liferay.portlet.journal.service.base.JournalFeedLocalServiceBaseImpl
037     * @see com.liferay.portlet.journal.service.impl.JournalFeedLocalServiceImpl
038     * @generated
039     */
040    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
041            PortalException.class, SystemException.class})
042    public interface JournalFeedLocalService {
043            /**
044            * Adds the journal feed to the database. Also notifies the appropriate model listeners.
045            *
046            * @param journalFeed the journal feed to add
047            * @return the journal feed that was added
048            * @throws SystemException if a system exception occurred
049            */
050            public com.liferay.portlet.journal.model.JournalFeed addJournalFeed(
051                    com.liferay.portlet.journal.model.JournalFeed journalFeed)
052                    throws com.liferay.portal.kernel.exception.SystemException;
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 com.liferay.portlet.journal.model.JournalFeed createJournalFeed(
061                    long id);
062    
063            /**
064            * Deletes the journal feed with the primary key from the database. Also notifies the appropriate model listeners.
065            *
066            * @param id the primary key of the journal feed to delete
067            * @throws PortalException if a journal feed with the primary key could not be found
068            * @throws SystemException if a system exception occurred
069            */
070            public void deleteJournalFeed(long id)
071                    throws com.liferay.portal.kernel.exception.PortalException,
072                            com.liferay.portal.kernel.exception.SystemException;
073    
074            /**
075            * Deletes the journal feed from the database. Also notifies the appropriate model listeners.
076            *
077            * @param journalFeed the journal feed to delete
078            * @throws SystemException if a system exception occurred
079            */
080            public void deleteJournalFeed(
081                    com.liferay.portlet.journal.model.JournalFeed journalFeed)
082                    throws com.liferay.portal.kernel.exception.SystemException;
083    
084            /**
085            * Performs a dynamic query on the database and returns the matching rows.
086            *
087            * @param dynamicQuery the dynamic query to search with
088            * @return the matching rows
089            * @throws SystemException if a system exception occurred
090            */
091            @SuppressWarnings("rawtypes")
092            public java.util.List dynamicQuery(
093                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
094                    throws com.liferay.portal.kernel.exception.SystemException;
095    
096            /**
097            * Performs a dynamic query on the database and returns a range of the matching rows.
098            *
099            * <p>
100            * 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.
101            * </p>
102            *
103            * @param dynamicQuery the dynamic query to search with
104            * @param start the lower bound of the range of model instances to return
105            * @param end the upper bound of the range of model instances to return (not inclusive)
106            * @return the range of matching rows
107            * @throws SystemException if a system exception occurred
108            */
109            @SuppressWarnings("rawtypes")
110            public java.util.List dynamicQuery(
111                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
112                    int end) throws com.liferay.portal.kernel.exception.SystemException;
113    
114            /**
115            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
116            *
117            * <p>
118            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
119            * </p>
120            *
121            * @param dynamicQuery the dynamic query to search with
122            * @param start the lower bound of the range of model instances to return
123            * @param end the upper bound of the range of model instances to return (not inclusive)
124            * @param orderByComparator the comparator to order the results by
125            * @return the ordered range of matching rows
126            * @throws SystemException if a system exception occurred
127            */
128            @SuppressWarnings("rawtypes")
129            public java.util.List dynamicQuery(
130                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
131                    int end,
132                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
133                    throws com.liferay.portal.kernel.exception.SystemException;
134    
135            /**
136            * Counts the number of rows that match the dynamic query.
137            *
138            * @param dynamicQuery the dynamic query to search with
139            * @return the number of rows that match the dynamic query
140            * @throws SystemException if a system exception occurred
141            */
142            public long dynamicQueryCount(
143                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
144                    throws com.liferay.portal.kernel.exception.SystemException;
145    
146            /**
147            * Gets the journal feed with the primary key.
148            *
149            * @param id the primary key of the journal feed to get
150            * @return the journal feed
151            * @throws PortalException if a journal feed with the primary key could not be found
152            * @throws SystemException if a system exception occurred
153            */
154            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
155            public com.liferay.portlet.journal.model.JournalFeed getJournalFeed(long id)
156                    throws com.liferay.portal.kernel.exception.PortalException,
157                            com.liferay.portal.kernel.exception.SystemException;
158    
159            /**
160            * Gets the journal feed with the UUID and group id.
161            *
162            * @param uuid the UUID of journal feed to get
163            * @param groupId the group id of the journal feed to get
164            * @return the journal feed
165            * @throws PortalException if a journal feed with the UUID and group id could not be found
166            * @throws SystemException if a system exception occurred
167            */
168            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
169            public com.liferay.portlet.journal.model.JournalFeed getJournalFeedByUuidAndGroupId(
170                    java.lang.String uuid, long groupId)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException;
173    
174            /**
175            * Gets a range of all the journal feeds.
176            *
177            * <p>
178            * 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.
179            * </p>
180            *
181            * @param start the lower bound of the range of journal feeds to return
182            * @param end the upper bound of the range of journal feeds to return (not inclusive)
183            * @return the range of journal feeds
184            * @throws SystemException if a system exception occurred
185            */
186            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
187            public java.util.List<com.liferay.portlet.journal.model.JournalFeed> getJournalFeeds(
188                    int start, int end)
189                    throws com.liferay.portal.kernel.exception.SystemException;
190    
191            /**
192            * Gets the number of journal feeds.
193            *
194            * @return the number of journal feeds
195            * @throws SystemException if a system exception occurred
196            */
197            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
198            public int getJournalFeedsCount()
199                    throws com.liferay.portal.kernel.exception.SystemException;
200    
201            /**
202            * Updates the journal feed in the database. Also notifies the appropriate model listeners.
203            *
204            * @param journalFeed the journal feed to update
205            * @return the journal feed that was updated
206            * @throws SystemException if a system exception occurred
207            */
208            public com.liferay.portlet.journal.model.JournalFeed updateJournalFeed(
209                    com.liferay.portlet.journal.model.JournalFeed journalFeed)
210                    throws com.liferay.portal.kernel.exception.SystemException;
211    
212            /**
213            * Updates the journal feed in the database. Also notifies the appropriate model listeners.
214            *
215            * @param journalFeed the journal feed to update
216            * @param merge whether to merge the journal feed with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation.
217            * @return the journal feed that was updated
218            * @throws SystemException if a system exception occurred
219            */
220            public com.liferay.portlet.journal.model.JournalFeed updateJournalFeed(
221                    com.liferay.portlet.journal.model.JournalFeed journalFeed, boolean merge)
222                    throws com.liferay.portal.kernel.exception.SystemException;
223    
224            public com.liferay.portlet.journal.model.JournalFeed addFeed(long userId,
225                    long groupId, java.lang.String feedId, boolean autoFeedId,
226                    java.lang.String name, java.lang.String description,
227                    java.lang.String type, java.lang.String structureId,
228                    java.lang.String templateId, java.lang.String rendererTemplateId,
229                    int delta, java.lang.String orderByCol, java.lang.String orderByType,
230                    java.lang.String targetLayoutFriendlyUrl,
231                    java.lang.String targetPortletId, java.lang.String contentField,
232                    java.lang.String feedType, double feedVersion,
233                    com.liferay.portal.service.ServiceContext serviceContext)
234                    throws com.liferay.portal.kernel.exception.PortalException,
235                            com.liferay.portal.kernel.exception.SystemException;
236    
237            public void addFeedResources(long feedId, boolean addCommunityPermissions,
238                    boolean addGuestPermissions)
239                    throws com.liferay.portal.kernel.exception.PortalException,
240                            com.liferay.portal.kernel.exception.SystemException;
241    
242            public void addFeedResources(
243                    com.liferay.portlet.journal.model.JournalFeed feed,
244                    boolean addCommunityPermissions, boolean addGuestPermissions)
245                    throws com.liferay.portal.kernel.exception.PortalException,
246                            com.liferay.portal.kernel.exception.SystemException;
247    
248            public void addFeedResources(long feedId,
249                    java.lang.String[] communityPermissions,
250                    java.lang.String[] guestPermissions)
251                    throws com.liferay.portal.kernel.exception.PortalException,
252                            com.liferay.portal.kernel.exception.SystemException;
253    
254            public void addFeedResources(
255                    com.liferay.portlet.journal.model.JournalFeed feed,
256                    java.lang.String[] communityPermissions,
257                    java.lang.String[] guestPermissions)
258                    throws com.liferay.portal.kernel.exception.PortalException,
259                            com.liferay.portal.kernel.exception.SystemException;
260    
261            public void deleteFeed(long feedId)
262                    throws com.liferay.portal.kernel.exception.PortalException,
263                            com.liferay.portal.kernel.exception.SystemException;
264    
265            public void deleteFeed(long groupId, java.lang.String feedId)
266                    throws com.liferay.portal.kernel.exception.PortalException,
267                            com.liferay.portal.kernel.exception.SystemException;
268    
269            public void deleteFeed(com.liferay.portlet.journal.model.JournalFeed feed)
270                    throws com.liferay.portal.kernel.exception.PortalException,
271                            com.liferay.portal.kernel.exception.SystemException;
272    
273            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
274            public com.liferay.portlet.journal.model.JournalFeed getFeed(long feedId)
275                    throws com.liferay.portal.kernel.exception.PortalException,
276                            com.liferay.portal.kernel.exception.SystemException;
277    
278            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
279            public com.liferay.portlet.journal.model.JournalFeed getFeed(long groupId,
280                    java.lang.String feedId)
281                    throws com.liferay.portal.kernel.exception.PortalException,
282                            com.liferay.portal.kernel.exception.SystemException;
283    
284            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
285            public java.util.List<com.liferay.portlet.journal.model.JournalFeed> getFeeds()
286                    throws com.liferay.portal.kernel.exception.SystemException;
287    
288            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
289            public java.util.List<com.liferay.portlet.journal.model.JournalFeed> getFeeds(
290                    long groupId)
291                    throws com.liferay.portal.kernel.exception.SystemException;
292    
293            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
294            public java.util.List<com.liferay.portlet.journal.model.JournalFeed> getFeeds(
295                    long groupId, int start, int end)
296                    throws com.liferay.portal.kernel.exception.SystemException;
297    
298            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
299            public int getFeedsCount(long groupId)
300                    throws com.liferay.portal.kernel.exception.SystemException;
301    
302            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
303            public java.util.List<com.liferay.portlet.journal.model.JournalFeed> search(
304                    long companyId, long groupId, java.lang.String keywords, int start,
305                    int end, com.liferay.portal.kernel.util.OrderByComparator obc)
306                    throws com.liferay.portal.kernel.exception.SystemException;
307    
308            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
309            public java.util.List<com.liferay.portlet.journal.model.JournalFeed> search(
310                    long companyId, long groupId, java.lang.String feedId,
311                    java.lang.String name, java.lang.String description,
312                    boolean andOperator, int start, int end,
313                    com.liferay.portal.kernel.util.OrderByComparator obc)
314                    throws com.liferay.portal.kernel.exception.SystemException;
315    
316            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
317            public int searchCount(long companyId, long groupId,
318                    java.lang.String keywords)
319                    throws com.liferay.portal.kernel.exception.SystemException;
320    
321            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
322            public int searchCount(long companyId, long groupId,
323                    java.lang.String feedId, java.lang.String name,
324                    java.lang.String description, boolean andOperator)
325                    throws com.liferay.portal.kernel.exception.SystemException;
326    
327            public com.liferay.portlet.journal.model.JournalFeed updateFeed(
328                    long groupId, java.lang.String feedId, java.lang.String name,
329                    java.lang.String description, java.lang.String type,
330                    java.lang.String structureId, java.lang.String templateId,
331                    java.lang.String rendererTemplateId, int delta,
332                    java.lang.String orderByCol, java.lang.String orderByType,
333                    java.lang.String targetLayoutFriendlyUrl,
334                    java.lang.String targetPortletId, java.lang.String contentField,
335                    java.lang.String feedType, double feedVersion,
336                    com.liferay.portal.service.ServiceContext serviceContext)
337                    throws com.liferay.portal.kernel.exception.PortalException,
338                            com.liferay.portal.kernel.exception.SystemException;
339    }