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