001    /**
002     * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
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            /**
150            * Returns the journal feed with the primary key.
151            *
152            * @param id the primary key of the journal feed
153            * @return the journal feed
154            * @throws PortalException if a journal feed with the primary key could not be found
155            * @throws SystemException if a system exception occurred
156            */
157            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
158            public com.liferay.portlet.journal.model.JournalFeed getJournalFeed(long id)
159                    throws com.liferay.portal.kernel.exception.PortalException,
160                            com.liferay.portal.kernel.exception.SystemException;
161    
162            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
163            public com.liferay.portal.model.PersistedModel getPersistedModel(
164                    java.io.Serializable primaryKeyObj)
165                    throws com.liferay.portal.kernel.exception.PortalException,
166                            com.liferay.portal.kernel.exception.SystemException;
167    
168            /**
169            * Returns the journal feed with the UUID in the group.
170            *
171            * @param uuid the UUID of journal feed
172            * @param groupId the group id of the journal feed
173            * @return the journal feed
174            * @throws PortalException if a journal feed with the UUID in the group could not be found
175            * @throws SystemException if a system exception occurred
176            */
177            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
178            public com.liferay.portlet.journal.model.JournalFeed getJournalFeedByUuidAndGroupId(
179                    java.lang.String uuid, long groupId)
180                    throws com.liferay.portal.kernel.exception.PortalException,
181                            com.liferay.portal.kernel.exception.SystemException;
182    
183            /**
184            * Returns a range of all the journal feeds.
185            *
186            * <p>
187            * 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.
188            * </p>
189            *
190            * @param start the lower bound of the range of journal feeds
191            * @param end the upper bound of the range of journal feeds (not inclusive)
192            * @return the range of journal feeds
193            * @throws SystemException if a system exception occurred
194            */
195            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
196            public java.util.List<com.liferay.portlet.journal.model.JournalFeed> getJournalFeeds(
197                    int start, int end)
198                    throws com.liferay.portal.kernel.exception.SystemException;
199    
200            /**
201            * Returns the number of journal feeds.
202            *
203            * @return the number of journal feeds
204            * @throws SystemException if a system exception occurred
205            */
206            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
207            public int getJournalFeedsCount()
208                    throws com.liferay.portal.kernel.exception.SystemException;
209    
210            /**
211            * Updates the journal feed in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
212            *
213            * @param journalFeed the journal feed
214            * @return the journal feed that was updated
215            * @throws SystemException if a system exception occurred
216            */
217            public com.liferay.portlet.journal.model.JournalFeed updateJournalFeed(
218                    com.liferay.portlet.journal.model.JournalFeed journalFeed)
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            * @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.
226            * @return the journal feed that was updated
227            * @throws SystemException if a system exception occurred
228            */
229            public com.liferay.portlet.journal.model.JournalFeed updateJournalFeed(
230                    com.liferay.portlet.journal.model.JournalFeed journalFeed, boolean merge)
231                    throws com.liferay.portal.kernel.exception.SystemException;
232    
233            /**
234            * Returns the Spring bean ID for this bean.
235            *
236            * @return the Spring bean ID for this bean
237            */
238            public java.lang.String getBeanIdentifier();
239    
240            /**
241            * Sets the Spring bean ID for this bean.
242            *
243            * @param beanIdentifier the Spring bean ID for this bean
244            */
245            public void setBeanIdentifier(java.lang.String beanIdentifier);
246    
247            public com.liferay.portlet.journal.model.JournalFeed addFeed(long userId,
248                    long groupId, java.lang.String feedId, boolean autoFeedId,
249                    java.lang.String name, java.lang.String description,
250                    java.lang.String type, java.lang.String structureId,
251                    java.lang.String templateId, java.lang.String rendererTemplateId,
252                    int delta, java.lang.String orderByCol, java.lang.String orderByType,
253                    java.lang.String targetLayoutFriendlyUrl,
254                    java.lang.String targetPortletId, java.lang.String contentField,
255                    java.lang.String feedType, double feedVersion,
256                    com.liferay.portal.service.ServiceContext serviceContext)
257                    throws com.liferay.portal.kernel.exception.PortalException,
258                            com.liferay.portal.kernel.exception.SystemException;
259    
260            public void addFeedResources(long feedId, boolean addCommunityPermissions,
261                    boolean addGuestPermissions)
262                    throws com.liferay.portal.kernel.exception.PortalException,
263                            com.liferay.portal.kernel.exception.SystemException;
264    
265            public void addFeedResources(
266                    com.liferay.portlet.journal.model.JournalFeed feed,
267                    boolean addCommunityPermissions, boolean addGuestPermissions)
268                    throws com.liferay.portal.kernel.exception.PortalException,
269                            com.liferay.portal.kernel.exception.SystemException;
270    
271            public void addFeedResources(long feedId,
272                    java.lang.String[] communityPermissions,
273                    java.lang.String[] guestPermissions)
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[] communityPermissions,
280                    java.lang.String[] guestPermissions)
281                    throws com.liferay.portal.kernel.exception.PortalException,
282                            com.liferay.portal.kernel.exception.SystemException;
283    
284            public void deleteFeed(long feedId)
285                    throws com.liferay.portal.kernel.exception.PortalException,
286                            com.liferay.portal.kernel.exception.SystemException;
287    
288            public void deleteFeed(long groupId, java.lang.String feedId)
289                    throws com.liferay.portal.kernel.exception.PortalException,
290                            com.liferay.portal.kernel.exception.SystemException;
291    
292            public void deleteFeed(com.liferay.portlet.journal.model.JournalFeed feed)
293                    throws com.liferay.portal.kernel.exception.PortalException,
294                            com.liferay.portal.kernel.exception.SystemException;
295    
296            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
297            public com.liferay.portlet.journal.model.JournalFeed getFeed(long feedId)
298                    throws com.liferay.portal.kernel.exception.PortalException,
299                            com.liferay.portal.kernel.exception.SystemException;
300    
301            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
302            public com.liferay.portlet.journal.model.JournalFeed getFeed(long groupId,
303                    java.lang.String feedId)
304                    throws com.liferay.portal.kernel.exception.PortalException,
305                            com.liferay.portal.kernel.exception.SystemException;
306    
307            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
308            public java.util.List<com.liferay.portlet.journal.model.JournalFeed> getFeeds()
309                    throws com.liferay.portal.kernel.exception.SystemException;
310    
311            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
312            public java.util.List<com.liferay.portlet.journal.model.JournalFeed> getFeeds(
313                    long groupId)
314                    throws 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                    long groupId, int start, int end)
319                    throws com.liferay.portal.kernel.exception.SystemException;
320    
321            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
322            public int getFeedsCount(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> search(
327                    long companyId, long groupId, java.lang.String keywords, int start,
328                    int end, com.liferay.portal.kernel.util.OrderByComparator obc)
329                    throws com.liferay.portal.kernel.exception.SystemException;
330    
331            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
332            public java.util.List<com.liferay.portlet.journal.model.JournalFeed> search(
333                    long companyId, long groupId, java.lang.String feedId,
334                    java.lang.String name, java.lang.String description,
335                    boolean andOperator, int start, int end,
336                    com.liferay.portal.kernel.util.OrderByComparator obc)
337                    throws com.liferay.portal.kernel.exception.SystemException;
338    
339            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
340            public int searchCount(long companyId, long groupId,
341                    java.lang.String keywords)
342                    throws com.liferay.portal.kernel.exception.SystemException;
343    
344            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
345            public int searchCount(long companyId, long groupId,
346                    java.lang.String feedId, java.lang.String name,
347                    java.lang.String description, boolean andOperator)
348                    throws com.liferay.portal.kernel.exception.SystemException;
349    
350            public com.liferay.portlet.journal.model.JournalFeed updateFeed(
351                    long groupId, java.lang.String feedId, java.lang.String name,
352                    java.lang.String description, java.lang.String type,
353                    java.lang.String structureId, java.lang.String templateId,
354                    java.lang.String rendererTemplateId, int delta,
355                    java.lang.String orderByCol, java.lang.String orderByType,
356                    java.lang.String targetLayoutFriendlyUrl,
357                    java.lang.String targetPortletId, java.lang.String contentField,
358                    java.lang.String feedType, double feedVersion,
359                    com.liferay.portal.service.ServiceContext serviceContext)
360                    throws com.liferay.portal.kernel.exception.PortalException,
361                            com.liferay.portal.kernel.exception.SystemException;
362    }