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.bookmarks.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.PermissionedModelLocalService;
024    
025    /**
026     * Provides the local service interface for BookmarksFolder. Methods of this
027     * service will not have security checks based on the propagated JAAS
028     * credentials because this service can only be accessed from within the same
029     * VM.
030     *
031     * @author Brian Wing Shun Chan
032     * @see BookmarksFolderLocalServiceUtil
033     * @see com.liferay.portlet.bookmarks.service.base.BookmarksFolderLocalServiceBaseImpl
034     * @see com.liferay.portlet.bookmarks.service.impl.BookmarksFolderLocalServiceImpl
035     * @generated
036     */
037    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
038            PortalException.class, SystemException.class})
039    public interface BookmarksFolderLocalService extends BaseLocalService,
040            PermissionedModelLocalService {
041            /*
042             * NOTE FOR DEVELOPERS:
043             *
044             * Never modify or reference this interface directly. Always use {@link BookmarksFolderLocalServiceUtil} to access the bookmarks folder local service. Add custom service methods to {@link com.liferay.portlet.bookmarks.service.impl.BookmarksFolderLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
045             */
046    
047            /**
048            * Adds the bookmarks folder to the database. Also notifies the appropriate model listeners.
049            *
050            * @param bookmarksFolder the bookmarks folder
051            * @return the bookmarks folder that was added
052            * @throws SystemException if a system exception occurred
053            */
054            public com.liferay.portlet.bookmarks.model.BookmarksFolder addBookmarksFolder(
055                    com.liferay.portlet.bookmarks.model.BookmarksFolder bookmarksFolder)
056                    throws com.liferay.portal.kernel.exception.SystemException;
057    
058            /**
059            * Creates a new bookmarks folder with the primary key. Does not add the bookmarks folder to the database.
060            *
061            * @param folderId the primary key for the new bookmarks folder
062            * @return the new bookmarks folder
063            */
064            public com.liferay.portlet.bookmarks.model.BookmarksFolder createBookmarksFolder(
065                    long folderId);
066    
067            /**
068            * Deletes the bookmarks folder with the primary key from the database. Also notifies the appropriate model listeners.
069            *
070            * @param folderId the primary key of the bookmarks folder
071            * @return the bookmarks folder that was removed
072            * @throws PortalException if a bookmarks folder with the primary key could not be found
073            * @throws SystemException if a system exception occurred
074            */
075            public com.liferay.portlet.bookmarks.model.BookmarksFolder deleteBookmarksFolder(
076                    long folderId)
077                    throws com.liferay.portal.kernel.exception.PortalException,
078                            com.liferay.portal.kernel.exception.SystemException;
079    
080            /**
081            * Deletes the bookmarks folder from the database. Also notifies the appropriate model listeners.
082            *
083            * @param bookmarksFolder the bookmarks folder
084            * @return the bookmarks folder that was removed
085            * @throws SystemException if a system exception occurred
086            */
087            public com.liferay.portlet.bookmarks.model.BookmarksFolder deleteBookmarksFolder(
088                    com.liferay.portlet.bookmarks.model.BookmarksFolder bookmarksFolder)
089                    throws com.liferay.portal.kernel.exception.SystemException;
090    
091            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
092    
093            /**
094            * Performs a dynamic query on the database and returns the matching rows.
095            *
096            * @param dynamicQuery the dynamic query
097            * @return the matching rows
098            * @throws SystemException if a system exception occurred
099            */
100            @SuppressWarnings("rawtypes")
101            public java.util.List dynamicQuery(
102                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
103                    throws com.liferay.portal.kernel.exception.SystemException;
104    
105            /**
106            * Performs a dynamic query on the database and returns a range of the matching rows.
107            *
108            * <p>
109            * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.bookmarks.model.impl.BookmarksFolderModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
110            * </p>
111            *
112            * @param dynamicQuery the dynamic query
113            * @param start the lower bound of the range of model instances
114            * @param end the upper bound of the range of model instances (not inclusive)
115            * @return the range of matching rows
116            * @throws SystemException if a system exception occurred
117            */
118            @SuppressWarnings("rawtypes")
119            public java.util.List dynamicQuery(
120                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
121                    int end) throws com.liferay.portal.kernel.exception.SystemException;
122    
123            /**
124            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
125            *
126            * <p>
127            * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.bookmarks.model.impl.BookmarksFolderModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
128            * </p>
129            *
130            * @param dynamicQuery the dynamic query
131            * @param start the lower bound of the range of model instances
132            * @param end the upper bound of the range of model instances (not inclusive)
133            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
134            * @return the ordered range of matching rows
135            * @throws SystemException if a system exception occurred
136            */
137            @SuppressWarnings("rawtypes")
138            public java.util.List dynamicQuery(
139                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
140                    int end,
141                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
142                    throws com.liferay.portal.kernel.exception.SystemException;
143    
144            /**
145            * Returns the number of rows that match the dynamic query.
146            *
147            * @param dynamicQuery the dynamic query
148            * @return the number of rows that match the dynamic query
149            * @throws SystemException if a system exception occurred
150            */
151            public long dynamicQueryCount(
152                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
153                    throws com.liferay.portal.kernel.exception.SystemException;
154    
155            /**
156            * Returns the number of rows that match the dynamic query.
157            *
158            * @param dynamicQuery the dynamic query
159            * @param projection the projection to apply to the query
160            * @return the number of rows that match the dynamic query
161            * @throws SystemException if a system exception occurred
162            */
163            public long dynamicQueryCount(
164                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
165                    com.liferay.portal.kernel.dao.orm.Projection projection)
166                    throws com.liferay.portal.kernel.exception.SystemException;
167    
168            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
169            public com.liferay.portlet.bookmarks.model.BookmarksFolder fetchBookmarksFolder(
170                    long folderId)
171                    throws com.liferay.portal.kernel.exception.SystemException;
172    
173            /**
174            * Returns the bookmarks folder with the matching UUID and company.
175            *
176            * @param uuid the bookmarks folder's UUID
177            * @param companyId the primary key of the company
178            * @return the matching bookmarks folder, or <code>null</code> if a matching bookmarks folder 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.bookmarks.model.BookmarksFolder fetchBookmarksFolderByUuidAndCompanyId(
183                    java.lang.String uuid, long companyId)
184                    throws com.liferay.portal.kernel.exception.SystemException;
185    
186            /**
187            * Returns the bookmarks folder matching the UUID and group.
188            *
189            * @param uuid the bookmarks folder's UUID
190            * @param groupId the primary key of the group
191            * @return the matching bookmarks folder, or <code>null</code> if a matching bookmarks folder could not be found
192            * @throws SystemException if a system exception occurred
193            */
194            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
195            public com.liferay.portlet.bookmarks.model.BookmarksFolder fetchBookmarksFolderByUuidAndGroupId(
196                    java.lang.String uuid, long groupId)
197                    throws com.liferay.portal.kernel.exception.SystemException;
198    
199            /**
200            * Returns the bookmarks folder with the primary key.
201            *
202            * @param folderId the primary key of the bookmarks folder
203            * @return the bookmarks folder
204            * @throws PortalException if a bookmarks folder with the primary key could not be found
205            * @throws SystemException if a system exception occurred
206            */
207            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
208            public com.liferay.portlet.bookmarks.model.BookmarksFolder getBookmarksFolder(
209                    long folderId)
210                    throws com.liferay.portal.kernel.exception.PortalException,
211                            com.liferay.portal.kernel.exception.SystemException;
212    
213            @Override
214            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
215            public com.liferay.portal.model.PersistedModel getPersistedModel(
216                    java.io.Serializable primaryKeyObj)
217                    throws com.liferay.portal.kernel.exception.PortalException,
218                            com.liferay.portal.kernel.exception.SystemException;
219    
220            /**
221            * Returns the bookmarks folder with the matching UUID and company.
222            *
223            * @param uuid the bookmarks folder's UUID
224            * @param companyId the primary key of the company
225            * @return the matching bookmarks folder
226            * @throws PortalException if a matching bookmarks folder could not be found
227            * @throws SystemException if a system exception occurred
228            */
229            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
230            public com.liferay.portlet.bookmarks.model.BookmarksFolder getBookmarksFolderByUuidAndCompanyId(
231                    java.lang.String uuid, long companyId)
232                    throws com.liferay.portal.kernel.exception.PortalException,
233                            com.liferay.portal.kernel.exception.SystemException;
234    
235            /**
236            * Returns the bookmarks folder matching the UUID and group.
237            *
238            * @param uuid the bookmarks folder's UUID
239            * @param groupId the primary key of the group
240            * @return the matching bookmarks folder
241            * @throws PortalException if a matching bookmarks folder could not be found
242            * @throws SystemException if a system exception occurred
243            */
244            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
245            public com.liferay.portlet.bookmarks.model.BookmarksFolder getBookmarksFolderByUuidAndGroupId(
246                    java.lang.String uuid, long groupId)
247                    throws com.liferay.portal.kernel.exception.PortalException,
248                            com.liferay.portal.kernel.exception.SystemException;
249    
250            /**
251            * Returns a range of all the bookmarks folders.
252            *
253            * <p>
254            * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.bookmarks.model.impl.BookmarksFolderModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
255            * </p>
256            *
257            * @param start the lower bound of the range of bookmarks folders
258            * @param end the upper bound of the range of bookmarks folders (not inclusive)
259            * @return the range of bookmarks folders
260            * @throws SystemException if a system exception occurred
261            */
262            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
263            public java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getBookmarksFolders(
264                    int start, int end)
265                    throws com.liferay.portal.kernel.exception.SystemException;
266    
267            /**
268            * Returns the number of bookmarks folders.
269            *
270            * @return the number of bookmarks folders
271            * @throws SystemException if a system exception occurred
272            */
273            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
274            public int getBookmarksFoldersCount()
275                    throws com.liferay.portal.kernel.exception.SystemException;
276    
277            /**
278            * Updates the bookmarks folder in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
279            *
280            * @param bookmarksFolder the bookmarks folder
281            * @return the bookmarks folder that was updated
282            * @throws SystemException if a system exception occurred
283            */
284            public com.liferay.portlet.bookmarks.model.BookmarksFolder updateBookmarksFolder(
285                    com.liferay.portlet.bookmarks.model.BookmarksFolder bookmarksFolder)
286                    throws com.liferay.portal.kernel.exception.SystemException;
287    
288            /**
289            * Returns the Spring bean ID for this bean.
290            *
291            * @return the Spring bean ID for this bean
292            */
293            public java.lang.String getBeanIdentifier();
294    
295            /**
296            * Sets the Spring bean ID for this bean.
297            *
298            * @param beanIdentifier the Spring bean ID for this bean
299            */
300            public void setBeanIdentifier(java.lang.String beanIdentifier);
301    
302            public com.liferay.portlet.bookmarks.model.BookmarksFolder addFolder(
303                    long userId, long parentFolderId, java.lang.String name,
304                    java.lang.String description,
305                    com.liferay.portal.service.ServiceContext serviceContext)
306                    throws com.liferay.portal.kernel.exception.PortalException,
307                            com.liferay.portal.kernel.exception.SystemException;
308    
309            public com.liferay.portlet.bookmarks.model.BookmarksFolder deleteFolder(
310                    com.liferay.portlet.bookmarks.model.BookmarksFolder folder)
311                    throws com.liferay.portal.kernel.exception.PortalException,
312                            com.liferay.portal.kernel.exception.SystemException;
313    
314            public com.liferay.portlet.bookmarks.model.BookmarksFolder deleteFolder(
315                    com.liferay.portlet.bookmarks.model.BookmarksFolder folder,
316                    boolean includeTrashedEntries)
317                    throws com.liferay.portal.kernel.exception.PortalException,
318                            com.liferay.portal.kernel.exception.SystemException;
319    
320            public com.liferay.portlet.bookmarks.model.BookmarksFolder deleteFolder(
321                    long folderId)
322                    throws com.liferay.portal.kernel.exception.PortalException,
323                            com.liferay.portal.kernel.exception.SystemException;
324    
325            public com.liferay.portlet.bookmarks.model.BookmarksFolder deleteFolder(
326                    long folderId, boolean includeTrashedEntries)
327                    throws com.liferay.portal.kernel.exception.PortalException,
328                            com.liferay.portal.kernel.exception.SystemException;
329    
330            public void deleteFolders(long groupId)
331                    throws com.liferay.portal.kernel.exception.PortalException,
332                            com.liferay.portal.kernel.exception.SystemException;
333    
334            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
335            public java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getCompanyFolders(
336                    long companyId, int start, int end)
337                    throws com.liferay.portal.kernel.exception.SystemException;
338    
339            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
340            public int getCompanyFoldersCount(long companyId)
341                    throws com.liferay.portal.kernel.exception.SystemException;
342    
343            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
344            public com.liferay.portlet.bookmarks.model.BookmarksFolder getFolder(
345                    long folderId)
346                    throws com.liferay.portal.kernel.exception.PortalException,
347                            com.liferay.portal.kernel.exception.SystemException;
348    
349            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
350            public java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getFolders(
351                    long groupId)
352                    throws com.liferay.portal.kernel.exception.SystemException;
353    
354            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
355            public java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getFolders(
356                    long groupId, long parentFolderId)
357                    throws com.liferay.portal.kernel.exception.SystemException;
358    
359            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
360            public java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getFolders(
361                    long groupId, long parentFolderId, int start, int end)
362                    throws com.liferay.portal.kernel.exception.SystemException;
363    
364            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
365            public java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getFolders(
366                    long groupId, long parentFolderId, int status, int start, int end)
367                    throws com.liferay.portal.kernel.exception.SystemException;
368    
369            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
370            public java.util.List<java.lang.Object> getFoldersAndEntries(long groupId,
371                    long folderId)
372                    throws com.liferay.portal.kernel.exception.SystemException;
373    
374            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
375            public java.util.List<java.lang.Object> getFoldersAndEntries(long groupId,
376                    long folderId, int status)
377                    throws com.liferay.portal.kernel.exception.SystemException;
378    
379            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
380            public java.util.List<java.lang.Object> getFoldersAndEntries(long groupId,
381                    long folderId, int status, int start, int end)
382                    throws com.liferay.portal.kernel.exception.SystemException;
383    
384            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
385            public int getFoldersAndEntriesCount(long groupId, long folderId, int status)
386                    throws com.liferay.portal.kernel.exception.SystemException;
387    
388            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
389            public int getFoldersCount(long groupId, long parentFolderId)
390                    throws com.liferay.portal.kernel.exception.SystemException;
391    
392            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
393            public int getFoldersCount(long groupId, long parentFolderId, 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.bookmarks.model.BookmarksFolder> getNoAssetFolders()
398                    throws com.liferay.portal.kernel.exception.SystemException;
399    
400            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
401            public void getSubfolderIds(java.util.List<java.lang.Long> folderIds,
402                    long groupId, long folderId)
403                    throws com.liferay.portal.kernel.exception.SystemException;
404    
405            public com.liferay.portlet.bookmarks.model.BookmarksFolder moveFolder(
406                    long folderId, long parentFolderId)
407                    throws com.liferay.portal.kernel.exception.PortalException,
408                            com.liferay.portal.kernel.exception.SystemException;
409    
410            public com.liferay.portlet.bookmarks.model.BookmarksFolder moveFolderFromTrash(
411                    long userId, long folderId, long parentFolderId)
412                    throws com.liferay.portal.kernel.exception.PortalException,
413                            com.liferay.portal.kernel.exception.SystemException;
414    
415            public com.liferay.portlet.bookmarks.model.BookmarksFolder moveFolderToTrash(
416                    long userId, long folderId)
417                    throws com.liferay.portal.kernel.exception.PortalException,
418                            com.liferay.portal.kernel.exception.SystemException;
419    
420            public void restoreFolderFromTrash(long userId, long folderId)
421                    throws com.liferay.portal.kernel.exception.PortalException,
422                            com.liferay.portal.kernel.exception.SystemException;
423    
424            public void subscribeFolder(long userId, long groupId, long folderId)
425                    throws com.liferay.portal.kernel.exception.PortalException,
426                            com.liferay.portal.kernel.exception.SystemException;
427    
428            public void unsubscribeFolder(long userId, long groupId, long folderId)
429                    throws com.liferay.portal.kernel.exception.PortalException,
430                            com.liferay.portal.kernel.exception.SystemException;
431    
432            public void updateAsset(long userId,
433                    com.liferay.portlet.bookmarks.model.BookmarksFolder folder,
434                    long[] assetCategoryIds, java.lang.String[] assetTagNames,
435                    long[] assetLinkEntryIds)
436                    throws com.liferay.portal.kernel.exception.PortalException,
437                            com.liferay.portal.kernel.exception.SystemException;
438    
439            public com.liferay.portlet.bookmarks.model.BookmarksFolder updateFolder(
440                    long userId, long folderId, long parentFolderId, java.lang.String name,
441                    java.lang.String description, boolean mergeWithParentFolder,
442                    com.liferay.portal.service.ServiceContext serviceContext)
443                    throws com.liferay.portal.kernel.exception.PortalException,
444                            com.liferay.portal.kernel.exception.SystemException;
445    
446            public com.liferay.portlet.bookmarks.model.BookmarksFolder updateStatus(
447                    long userId,
448                    com.liferay.portlet.bookmarks.model.BookmarksFolder folder, int status)
449                    throws com.liferay.portal.kernel.exception.PortalException,
450                            com.liferay.portal.kernel.exception.SystemException;
451    }