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     * The interface for the bookmarks folder 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 BookmarksFolderLocalServiceUtil
034     * @see com.liferay.portlet.bookmarks.service.base.BookmarksFolderLocalServiceBaseImpl
035     * @see com.liferay.portlet.bookmarks.service.impl.BookmarksFolderLocalServiceImpl
036     * @generated
037     */
038    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
039            PortalException.class, SystemException.class})
040    public interface BookmarksFolderLocalService extends BaseLocalService,
041            PermissionedModelLocalService {
042            /*
043             * NOTE FOR DEVELOPERS:
044             *
045             * 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.
046             */
047    
048            /**
049            * Adds the bookmarks folder to the database. Also notifies the appropriate model listeners.
050            *
051            * @param bookmarksFolder the bookmarks folder
052            * @return the bookmarks folder that was added
053            * @throws SystemException if a system exception occurred
054            */
055            public com.liferay.portlet.bookmarks.model.BookmarksFolder addBookmarksFolder(
056                    com.liferay.portlet.bookmarks.model.BookmarksFolder bookmarksFolder)
057                    throws com.liferay.portal.kernel.exception.SystemException;
058    
059            /**
060            * Creates a new bookmarks folder with the primary key. Does not add the bookmarks folder to the database.
061            *
062            * @param folderId the primary key for the new bookmarks folder
063            * @return the new bookmarks folder
064            */
065            public com.liferay.portlet.bookmarks.model.BookmarksFolder createBookmarksFolder(
066                    long folderId);
067    
068            /**
069            * Deletes the bookmarks folder with the primary key from the database. Also notifies the appropriate model listeners.
070            *
071            * @param folderId the primary key of the bookmarks folder
072            * @return the bookmarks folder that was removed
073            * @throws PortalException if a bookmarks folder with the primary key could not be found
074            * @throws SystemException if a system exception occurred
075            */
076            public com.liferay.portlet.bookmarks.model.BookmarksFolder deleteBookmarksFolder(
077                    long folderId)
078                    throws com.liferay.portal.kernel.exception.PortalException,
079                            com.liferay.portal.kernel.exception.SystemException;
080    
081            /**
082            * Deletes the bookmarks folder from the database. Also notifies the appropriate model listeners.
083            *
084            * @param bookmarksFolder the bookmarks folder
085            * @return the bookmarks folder that was removed
086            * @throws SystemException if a system exception occurred
087            */
088            public com.liferay.portlet.bookmarks.model.BookmarksFolder deleteBookmarksFolder(
089                    com.liferay.portlet.bookmarks.model.BookmarksFolder bookmarksFolder)
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. 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.
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. 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.
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.bookmarks.model.BookmarksFolder fetchBookmarksFolder(
158                    long folderId)
159                    throws com.liferay.portal.kernel.exception.SystemException;
160    
161            /**
162            * Returns the bookmarks folder with the primary key.
163            *
164            * @param folderId the primary key of the bookmarks folder
165            * @return the bookmarks folder
166            * @throws PortalException if a bookmarks folder 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.bookmarks.model.BookmarksFolder getBookmarksFolder(
171                    long folderId)
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 bookmarks folder matching the UUID and group.
183            *
184            * @param uuid the bookmarks folder's UUID
185            * @param groupId the primary key of the group
186            * @return the matching bookmarks folder
187            * @throws PortalException if a matching bookmarks folder 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.bookmarks.model.BookmarksFolder getBookmarksFolderByUuidAndGroupId(
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 bookmarks folders.
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. 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.
201            * </p>
202            *
203            * @param start the lower bound of the range of bookmarks folders
204            * @param end the upper bound of the range of bookmarks folders (not inclusive)
205            * @return the range of bookmarks folders
206            * @throws SystemException if a system exception occurred
207            */
208            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
209            public java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getBookmarksFolders(
210                    int start, int end)
211                    throws com.liferay.portal.kernel.exception.SystemException;
212    
213            /**
214            * Returns the number of bookmarks folders.
215            *
216            * @return the number of bookmarks folders
217            * @throws SystemException if a system exception occurred
218            */
219            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
220            public int getBookmarksFoldersCount()
221                    throws com.liferay.portal.kernel.exception.SystemException;
222    
223            /**
224            * Updates the bookmarks folder in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
225            *
226            * @param bookmarksFolder the bookmarks folder
227            * @return the bookmarks folder that was updated
228            * @throws SystemException if a system exception occurred
229            */
230            public com.liferay.portlet.bookmarks.model.BookmarksFolder updateBookmarksFolder(
231                    com.liferay.portlet.bookmarks.model.BookmarksFolder bookmarksFolder)
232                    throws com.liferay.portal.kernel.exception.SystemException;
233    
234            /**
235            * Returns the Spring bean ID for this bean.
236            *
237            * @return the Spring bean ID for this bean
238            */
239            public java.lang.String getBeanIdentifier();
240    
241            /**
242            * Sets the Spring bean ID for this bean.
243            *
244            * @param beanIdentifier the Spring bean ID for this bean
245            */
246            public void setBeanIdentifier(java.lang.String beanIdentifier);
247    
248            public com.liferay.portlet.bookmarks.model.BookmarksFolder addFolder(
249                    long userId, long parentFolderId, java.lang.String name,
250                    java.lang.String description,
251                    com.liferay.portal.service.ServiceContext serviceContext)
252                    throws com.liferay.portal.kernel.exception.PortalException,
253                            com.liferay.portal.kernel.exception.SystemException;
254    
255            public com.liferay.portlet.bookmarks.model.BookmarksFolder deleteFolder(
256                    com.liferay.portlet.bookmarks.model.BookmarksFolder folder)
257                    throws com.liferay.portal.kernel.exception.PortalException,
258                            com.liferay.portal.kernel.exception.SystemException;
259    
260            public com.liferay.portlet.bookmarks.model.BookmarksFolder deleteFolder(
261                    com.liferay.portlet.bookmarks.model.BookmarksFolder folder,
262                    boolean includeTrashedEntries)
263                    throws com.liferay.portal.kernel.exception.PortalException,
264                            com.liferay.portal.kernel.exception.SystemException;
265    
266            public com.liferay.portlet.bookmarks.model.BookmarksFolder deleteFolder(
267                    long folderId)
268                    throws com.liferay.portal.kernel.exception.PortalException,
269                            com.liferay.portal.kernel.exception.SystemException;
270    
271            public com.liferay.portlet.bookmarks.model.BookmarksFolder deleteFolder(
272                    long folderId, boolean includeTrashedEntries)
273                    throws com.liferay.portal.kernel.exception.PortalException,
274                            com.liferay.portal.kernel.exception.SystemException;
275    
276            public void deleteFolders(long groupId)
277                    throws com.liferay.portal.kernel.exception.PortalException,
278                            com.liferay.portal.kernel.exception.SystemException;
279    
280            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
281            public java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getCompanyFolders(
282                    long companyId, int start, int end)
283                    throws com.liferay.portal.kernel.exception.SystemException;
284    
285            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
286            public int getCompanyFoldersCount(long companyId)
287                    throws com.liferay.portal.kernel.exception.SystemException;
288    
289            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
290            public com.liferay.portlet.bookmarks.model.BookmarksFolder getFolder(
291                    long folderId)
292                    throws com.liferay.portal.kernel.exception.PortalException,
293                            com.liferay.portal.kernel.exception.SystemException;
294    
295            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
296            public java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getFolders(
297                    long groupId)
298                    throws com.liferay.portal.kernel.exception.SystemException;
299    
300            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
301            public java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getFolders(
302                    long groupId, long parentFolderId)
303                    throws com.liferay.portal.kernel.exception.SystemException;
304    
305            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
306            public java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getFolders(
307                    long groupId, long parentFolderId, int start, int end)
308                    throws com.liferay.portal.kernel.exception.SystemException;
309    
310            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
311            public java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getFolders(
312                    long groupId, long parentFolderId, int status, int start, int end)
313                    throws com.liferay.portal.kernel.exception.SystemException;
314    
315            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
316            public java.util.List<java.lang.Object> getFoldersAndEntries(long groupId,
317                    long folderId)
318                    throws com.liferay.portal.kernel.exception.SystemException;
319    
320            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
321            public java.util.List<java.lang.Object> getFoldersAndEntries(long groupId,
322                    long folderId, int status)
323                    throws com.liferay.portal.kernel.exception.SystemException;
324    
325            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
326            public java.util.List<java.lang.Object> getFoldersAndEntries(long groupId,
327                    long folderId, int status, int start, int end)
328                    throws com.liferay.portal.kernel.exception.SystemException;
329    
330            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
331            public int getFoldersAndEntriesCount(long groupId, long folderId, int status)
332                    throws com.liferay.portal.kernel.exception.SystemException;
333    
334            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
335            public int getFoldersCount(long groupId, long parentFolderId)
336                    throws com.liferay.portal.kernel.exception.SystemException;
337    
338            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
339            public int getFoldersCount(long groupId, long parentFolderId, int status)
340                    throws com.liferay.portal.kernel.exception.SystemException;
341    
342            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
343            public java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getNoAssetFolders()
344                    throws com.liferay.portal.kernel.exception.SystemException;
345    
346            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
347            public void getSubfolderIds(java.util.List<java.lang.Long> folderIds,
348                    long groupId, long folderId)
349                    throws com.liferay.portal.kernel.exception.SystemException;
350    
351            public com.liferay.portlet.bookmarks.model.BookmarksFolder moveFolder(
352                    long folderId, long parentFolderId)
353                    throws com.liferay.portal.kernel.exception.PortalException,
354                            com.liferay.portal.kernel.exception.SystemException;
355    
356            public com.liferay.portlet.bookmarks.model.BookmarksFolder moveFolderFromTrash(
357                    long userId, long folderId, long parentFolderId)
358                    throws com.liferay.portal.kernel.exception.PortalException,
359                            com.liferay.portal.kernel.exception.SystemException;
360    
361            public void moveFolderToTrash(long userId, long folderId)
362                    throws com.liferay.portal.kernel.exception.PortalException,
363                            com.liferay.portal.kernel.exception.SystemException;
364    
365            public void restoreFolderFromTrash(long userId, long folderId)
366                    throws com.liferay.portal.kernel.exception.PortalException,
367                            com.liferay.portal.kernel.exception.SystemException;
368    
369            public void subscribeFolder(long userId, long groupId, long folderId)
370                    throws com.liferay.portal.kernel.exception.PortalException,
371                            com.liferay.portal.kernel.exception.SystemException;
372    
373            public void unsubscribeFolder(long userId, long groupId, long folderId)
374                    throws com.liferay.portal.kernel.exception.PortalException,
375                            com.liferay.portal.kernel.exception.SystemException;
376    
377            public void updateAsset(long userId,
378                    com.liferay.portlet.bookmarks.model.BookmarksFolder folder,
379                    long[] assetCategoryIds, java.lang.String[] assetTagNames,
380                    long[] assetLinkEntryIds)
381                    throws com.liferay.portal.kernel.exception.PortalException,
382                            com.liferay.portal.kernel.exception.SystemException;
383    
384            public com.liferay.portlet.bookmarks.model.BookmarksFolder updateFolder(
385                    long userId, long folderId, long parentFolderId, java.lang.String name,
386                    java.lang.String description, boolean mergeWithParentFolder,
387                    com.liferay.portal.service.ServiceContext serviceContext)
388                    throws com.liferay.portal.kernel.exception.PortalException,
389                            com.liferay.portal.kernel.exception.SystemException;
390    
391            public com.liferay.portlet.bookmarks.model.BookmarksFolder updateStatus(
392                    long userId,
393                    com.liferay.portlet.bookmarks.model.BookmarksFolder folder, int status)
394                    throws com.liferay.portal.kernel.exception.PortalException,
395                            com.liferay.portal.kernel.exception.SystemException;
396    }