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