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.blogs.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 blogs entry 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 BlogsEntryLocalServiceUtil
034     * @see com.liferay.portlet.blogs.service.base.BlogsEntryLocalServiceBaseImpl
035     * @see com.liferay.portlet.blogs.service.impl.BlogsEntryLocalServiceImpl
036     * @generated
037     */
038    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
039            PortalException.class, SystemException.class})
040    public interface BlogsEntryLocalService extends BaseLocalService,
041            PersistedModelLocalService {
042            /*
043             * NOTE FOR DEVELOPERS:
044             *
045             * Never modify or reference this interface directly. Always use {@link BlogsEntryLocalServiceUtil} to access the blogs entry local service. Add custom service methods to {@link com.liferay.portlet.blogs.service.impl.BlogsEntryLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
046             */
047    
048            /**
049            * Adds the blogs entry to the database. Also notifies the appropriate model listeners.
050            *
051            * @param blogsEntry the blogs entry
052            * @return the blogs entry that was added
053            * @throws SystemException if a system exception occurred
054            */
055            public com.liferay.portlet.blogs.model.BlogsEntry addBlogsEntry(
056                    com.liferay.portlet.blogs.model.BlogsEntry blogsEntry)
057                    throws com.liferay.portal.kernel.exception.SystemException;
058    
059            /**
060            * Creates a new blogs entry with the primary key. Does not add the blogs entry to the database.
061            *
062            * @param entryId the primary key for the new blogs entry
063            * @return the new blogs entry
064            */
065            public com.liferay.portlet.blogs.model.BlogsEntry createBlogsEntry(
066                    long entryId);
067    
068            /**
069            * Deletes the blogs entry with the primary key from the database. Also notifies the appropriate model listeners.
070            *
071            * @param entryId the primary key of the blogs entry
072            * @return the blogs entry that was removed
073            * @throws PortalException if a blogs entry with the primary key could not be found
074            * @throws SystemException if a system exception occurred
075            */
076            public com.liferay.portlet.blogs.model.BlogsEntry deleteBlogsEntry(
077                    long entryId)
078                    throws com.liferay.portal.kernel.exception.PortalException,
079                            com.liferay.portal.kernel.exception.SystemException;
080    
081            /**
082            * Deletes the blogs entry from the database. Also notifies the appropriate model listeners.
083            *
084            * @param blogsEntry the blogs entry
085            * @return the blogs entry that was removed
086            * @throws SystemException if a system exception occurred
087            */
088            public com.liferay.portlet.blogs.model.BlogsEntry deleteBlogsEntry(
089                    com.liferay.portlet.blogs.model.BlogsEntry blogsEntry)
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.blogs.model.BlogsEntry fetchBlogsEntry(
158                    long entryId)
159                    throws com.liferay.portal.kernel.exception.SystemException;
160    
161            /**
162            * Returns the blogs entry with the primary key.
163            *
164            * @param entryId the primary key of the blogs entry
165            * @return the blogs entry
166            * @throws PortalException if a blogs entry with the primary key could not be found
167            * @throws SystemException if a system exception occurred
168            */
169            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
170            public com.liferay.portlet.blogs.model.BlogsEntry getBlogsEntry(
171                    long entryId)
172                    throws com.liferay.portal.kernel.exception.PortalException,
173                            com.liferay.portal.kernel.exception.SystemException;
174    
175            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
176            public com.liferay.portal.model.PersistedModel getPersistedModel(
177                    java.io.Serializable primaryKeyObj)
178                    throws com.liferay.portal.kernel.exception.PortalException,
179                            com.liferay.portal.kernel.exception.SystemException;
180    
181            /**
182            * Returns the blogs entry with the UUID in the group.
183            *
184            * @param uuid the UUID of blogs entry
185            * @param groupId the group id of the blogs entry
186            * @return the blogs entry
187            * @throws PortalException if a blogs entry with the UUID in the group could not be found
188            * @throws SystemException if a system exception occurred
189            */
190            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
191            public com.liferay.portlet.blogs.model.BlogsEntry getBlogsEntryByUuidAndGroupId(
192                    java.lang.String uuid, long groupId)
193                    throws com.liferay.portal.kernel.exception.PortalException,
194                            com.liferay.portal.kernel.exception.SystemException;
195    
196            /**
197            * Returns a range of all the blogs entries.
198            *
199            * <p>
200            * 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.
201            * </p>
202            *
203            * @param start the lower bound of the range of blogs entries
204            * @param end the upper bound of the range of blogs entries (not inclusive)
205            * @return the range of blogs entries
206            * @throws SystemException if a system exception occurred
207            */
208            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
209            public java.util.List<com.liferay.portlet.blogs.model.BlogsEntry> getBlogsEntries(
210                    int start, int end)
211                    throws com.liferay.portal.kernel.exception.SystemException;
212    
213            /**
214            * Returns the number of blogs entries.
215            *
216            * @return the number of blogs entries
217            * @throws SystemException if a system exception occurred
218            */
219            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
220            public int getBlogsEntriesCount()
221                    throws com.liferay.portal.kernel.exception.SystemException;
222    
223            /**
224            * Updates the blogs entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
225            *
226            * @param blogsEntry the blogs entry
227            * @return the blogs entry that was updated
228            * @throws SystemException if a system exception occurred
229            */
230            public com.liferay.portlet.blogs.model.BlogsEntry updateBlogsEntry(
231                    com.liferay.portlet.blogs.model.BlogsEntry blogsEntry)
232                    throws com.liferay.portal.kernel.exception.SystemException;
233    
234            /**
235            * Updates the blogs entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
236            *
237            * @param blogsEntry the blogs entry
238            * @param merge whether to merge the blogs entry 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.
239            * @return the blogs entry that was updated
240            * @throws SystemException if a system exception occurred
241            */
242            public com.liferay.portlet.blogs.model.BlogsEntry updateBlogsEntry(
243                    com.liferay.portlet.blogs.model.BlogsEntry blogsEntry, boolean merge)
244                    throws com.liferay.portal.kernel.exception.SystemException;
245    
246            /**
247            * Returns the Spring bean ID for this bean.
248            *
249            * @return the Spring bean ID for this bean
250            */
251            public java.lang.String getBeanIdentifier();
252    
253            /**
254            * Sets the Spring bean ID for this bean.
255            *
256            * @param beanIdentifier the Spring bean ID for this bean
257            */
258            public void setBeanIdentifier(java.lang.String beanIdentifier);
259    
260            public com.liferay.portlet.blogs.model.BlogsEntry addEntry(long userId,
261                    java.lang.String title, java.lang.String description,
262                    java.lang.String content, int displayDateMonth, int displayDateDay,
263                    int displayDateYear, int displayDateHour, int displayDateMinute,
264                    boolean allowPingbacks, boolean allowTrackbacks,
265                    java.lang.String[] trackbacks, boolean smallImage,
266                    java.lang.String smallImageURL, java.lang.String smallImageFileName,
267                    java.io.InputStream smallImageInputStream,
268                    com.liferay.portal.service.ServiceContext serviceContext)
269                    throws com.liferay.portal.kernel.exception.PortalException,
270                            com.liferay.portal.kernel.exception.SystemException;
271    
272            public void addEntryResources(
273                    com.liferay.portlet.blogs.model.BlogsEntry entry,
274                    boolean addGroupPermissions, boolean addGuestPermissions)
275                    throws com.liferay.portal.kernel.exception.PortalException,
276                            com.liferay.portal.kernel.exception.SystemException;
277    
278            public void addEntryResources(
279                    com.liferay.portlet.blogs.model.BlogsEntry entry,
280                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
281                    throws com.liferay.portal.kernel.exception.PortalException,
282                            com.liferay.portal.kernel.exception.SystemException;
283    
284            public void addEntryResources(long entryId, boolean addGroupPermissions,
285                    boolean addGuestPermissions)
286                    throws com.liferay.portal.kernel.exception.PortalException,
287                            com.liferay.portal.kernel.exception.SystemException;
288    
289            public void addEntryResources(long entryId,
290                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
291                    throws com.liferay.portal.kernel.exception.PortalException,
292                            com.liferay.portal.kernel.exception.SystemException;
293    
294            public void checkEntries()
295                    throws com.liferay.portal.kernel.exception.PortalException,
296                            com.liferay.portal.kernel.exception.SystemException;
297    
298            public void deleteEntries(long groupId)
299                    throws com.liferay.portal.kernel.exception.PortalException,
300                            com.liferay.portal.kernel.exception.SystemException;
301    
302            public void deleteEntry(com.liferay.portlet.blogs.model.BlogsEntry entry)
303                    throws com.liferay.portal.kernel.exception.PortalException,
304                            com.liferay.portal.kernel.exception.SystemException;
305    
306            public void deleteEntry(long entryId)
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 java.util.List<com.liferay.portlet.blogs.model.BlogsEntry> getCompanyEntries(
312                    long companyId, java.util.Date displayDate, int status, int start,
313                    int end) throws com.liferay.portal.kernel.exception.SystemException;
314    
315            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
316            public java.util.List<com.liferay.portlet.blogs.model.BlogsEntry> getCompanyEntries(
317                    long companyId, java.util.Date displayDate, int status, int start,
318                    int end, com.liferay.portal.kernel.util.OrderByComparator obc)
319                    throws com.liferay.portal.kernel.exception.SystemException;
320    
321            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
322            public int getCompanyEntriesCount(long companyId,
323                    java.util.Date displayDate, int status)
324                    throws com.liferay.portal.kernel.exception.SystemException;
325    
326            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
327            public com.liferay.portlet.blogs.model.BlogsEntry[] getEntriesPrevAndNext(
328                    long entryId)
329                    throws com.liferay.portal.kernel.exception.PortalException,
330                            com.liferay.portal.kernel.exception.SystemException;
331    
332            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
333            public com.liferay.portlet.blogs.model.BlogsEntry getEntry(long entryId)
334                    throws com.liferay.portal.kernel.exception.PortalException,
335                            com.liferay.portal.kernel.exception.SystemException;
336    
337            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
338            public com.liferay.portlet.blogs.model.BlogsEntry getEntry(long groupId,
339                    java.lang.String urlTitle)
340                    throws com.liferay.portal.kernel.exception.PortalException,
341                            com.liferay.portal.kernel.exception.SystemException;
342    
343            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
344            public java.util.List<com.liferay.portlet.blogs.model.BlogsEntry> getGroupEntries(
345                    long groupId, java.util.Date displayDate, int status, int start, int end)
346                    throws com.liferay.portal.kernel.exception.SystemException;
347    
348            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
349            public java.util.List<com.liferay.portlet.blogs.model.BlogsEntry> getGroupEntries(
350                    long groupId, java.util.Date displayDate, int status, int start,
351                    int end, com.liferay.portal.kernel.util.OrderByComparator obc)
352                    throws com.liferay.portal.kernel.exception.SystemException;
353    
354            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
355            public java.util.List<com.liferay.portlet.blogs.model.BlogsEntry> getGroupEntries(
356                    long groupId, int status, int start, int end)
357                    throws com.liferay.portal.kernel.exception.SystemException;
358    
359            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
360            public java.util.List<com.liferay.portlet.blogs.model.BlogsEntry> getGroupEntries(
361                    long groupId, int status, int start, int end,
362                    com.liferay.portal.kernel.util.OrderByComparator obc)
363                    throws com.liferay.portal.kernel.exception.SystemException;
364    
365            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
366            public int getGroupEntriesCount(long groupId, java.util.Date displayDate,
367                    int status) throws com.liferay.portal.kernel.exception.SystemException;
368    
369            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
370            public int getGroupEntriesCount(long groupId, int status)
371                    throws com.liferay.portal.kernel.exception.SystemException;
372    
373            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
374            public java.util.List<com.liferay.portlet.blogs.model.BlogsEntry> getGroupsEntries(
375                    long companyId, long groupId, java.util.Date displayDate, int status,
376                    int start, int end)
377                    throws com.liferay.portal.kernel.exception.SystemException;
378    
379            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
380            public java.util.List<com.liferay.portlet.blogs.model.BlogsEntry> getGroupUserEntries(
381                    long groupId, long userId, java.util.Date displayDate, int status,
382                    int start, int end)
383                    throws com.liferay.portal.kernel.exception.SystemException;
384    
385            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
386            public java.util.List<com.liferay.portlet.blogs.model.BlogsEntry> getGroupUserEntries(
387                    long groupId, long userId, java.util.Date displayDate, int status,
388                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
389                    throws com.liferay.portal.kernel.exception.SystemException;
390    
391            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
392            public int getGroupUserEntriesCount(long groupId, long userId,
393                    java.util.Date displayDate, int status)
394                    throws com.liferay.portal.kernel.exception.SystemException;
395    
396            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
397            public java.util.List<com.liferay.portlet.blogs.model.BlogsEntry> getNoAssetEntries()
398                    throws com.liferay.portal.kernel.exception.SystemException;
399    
400            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
401            public java.util.List<com.liferay.portlet.blogs.model.BlogsEntry> getOrganizationEntries(
402                    long organizationId, java.util.Date displayDate, int status, int start,
403                    int end) throws com.liferay.portal.kernel.exception.SystemException;
404    
405            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
406            public java.util.List<com.liferay.portlet.blogs.model.BlogsEntry> getOrganizationEntries(
407                    long organizationId, java.util.Date displayDate, int status, int start,
408                    int end, com.liferay.portal.kernel.util.OrderByComparator obc)
409                    throws com.liferay.portal.kernel.exception.SystemException;
410    
411            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
412            public int getOrganizationEntriesCount(long organizationId,
413                    java.util.Date displayDate, int status)
414                    throws com.liferay.portal.kernel.exception.SystemException;
415    
416            public void subscribe(long userId, long groupId)
417                    throws com.liferay.portal.kernel.exception.PortalException,
418                            com.liferay.portal.kernel.exception.SystemException;
419    
420            public void unsubscribe(long userId, long groupId)
421                    throws com.liferay.portal.kernel.exception.PortalException,
422                            com.liferay.portal.kernel.exception.SystemException;
423    
424            public void updateAsset(long userId,
425                    com.liferay.portlet.blogs.model.BlogsEntry entry,
426                    long[] assetCategoryIds, java.lang.String[] assetTagNames,
427                    long[] assetLinkEntryIds)
428                    throws com.liferay.portal.kernel.exception.PortalException,
429                            com.liferay.portal.kernel.exception.SystemException;
430    
431            public com.liferay.portlet.blogs.model.BlogsEntry updateEntry(long userId,
432                    long entryId, java.lang.String title, java.lang.String description,
433                    java.lang.String content, int displayDateMonth, int displayDateDay,
434                    int displayDateYear, int displayDateHour, int displayDateMinute,
435                    boolean allowPingbacks, boolean allowTrackbacks,
436                    java.lang.String[] trackbacks, boolean smallImage,
437                    java.lang.String smallImageURL, java.lang.String smallImageFileName,
438                    java.io.InputStream smallImageInputStream,
439                    com.liferay.portal.service.ServiceContext serviceContext)
440                    throws com.liferay.portal.kernel.exception.PortalException,
441                            com.liferay.portal.kernel.exception.SystemException;
442    
443            public void updateEntryResources(
444                    com.liferay.portlet.blogs.model.BlogsEntry entry,
445                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
446                    throws com.liferay.portal.kernel.exception.PortalException,
447                            com.liferay.portal.kernel.exception.SystemException;
448    
449            public com.liferay.portlet.blogs.model.BlogsEntry updateStatus(
450                    long userId, long entryId, int status,
451                    com.liferay.portal.service.ServiceContext serviceContext)
452                    throws com.liferay.portal.kernel.exception.PortalException,
453                            com.liferay.portal.kernel.exception.SystemException;
454    }