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.
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.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 with the UUID in the group.
183            *
184            * @param uuid the UUID of bookmarks folder
185            * @param groupId the group id of the bookmarks folder
186            * @return the bookmarks folder
187            * @throws PortalException if a bookmarks folder 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.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.
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            * Updates the bookmarks folder in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
236            *
237            * @param bookmarksFolder the bookmarks folder
238            * @param merge whether to merge the bookmarks folder 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 bookmarks folder that was updated
240            * @throws SystemException if a system exception occurred
241            */
242            public com.liferay.portlet.bookmarks.model.BookmarksFolder updateBookmarksFolder(
243                    com.liferay.portlet.bookmarks.model.BookmarksFolder bookmarksFolder,
244                    boolean merge)
245                    throws com.liferay.portal.kernel.exception.SystemException;
246    
247            /**
248            * Returns the Spring bean ID for this bean.
249            *
250            * @return the Spring bean ID for this bean
251            */
252            public java.lang.String getBeanIdentifier();
253    
254            /**
255            * Sets the Spring bean ID for this bean.
256            *
257            * @param beanIdentifier the Spring bean ID for this bean
258            */
259            public void setBeanIdentifier(java.lang.String beanIdentifier);
260    
261            public com.liferay.portlet.bookmarks.model.BookmarksFolder addFolder(
262                    long userId, long parentFolderId, java.lang.String name,
263                    java.lang.String description,
264                    com.liferay.portal.service.ServiceContext serviceContext)
265                    throws com.liferay.portal.kernel.exception.PortalException,
266                            com.liferay.portal.kernel.exception.SystemException;
267    
268            public void deleteFolder(
269                    com.liferay.portlet.bookmarks.model.BookmarksFolder folder)
270                    throws com.liferay.portal.kernel.exception.PortalException,
271                            com.liferay.portal.kernel.exception.SystemException;
272    
273            public void deleteFolder(long folderId)
274                    throws com.liferay.portal.kernel.exception.PortalException,
275                            com.liferay.portal.kernel.exception.SystemException;
276    
277            public void deleteFolders(long groupId)
278                    throws com.liferay.portal.kernel.exception.PortalException,
279                            com.liferay.portal.kernel.exception.SystemException;
280    
281            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
282            public java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getCompanyFolders(
283                    long companyId, int start, int end)
284                    throws com.liferay.portal.kernel.exception.SystemException;
285    
286            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
287            public int getCompanyFoldersCount(long companyId)
288                    throws com.liferay.portal.kernel.exception.SystemException;
289    
290            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
291            public com.liferay.portlet.bookmarks.model.BookmarksFolder getFolder(
292                    long folderId)
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 java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getFolders(
298                    long groupId)
299                    throws com.liferay.portal.kernel.exception.SystemException;
300    
301            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
302            public java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getFolders(
303                    long groupId, long parentFolderId)
304                    throws com.liferay.portal.kernel.exception.SystemException;
305    
306            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
307            public java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getFolders(
308                    long groupId, long parentFolderId, int start, int end)
309                    throws com.liferay.portal.kernel.exception.SystemException;
310    
311            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
312            public int getFoldersCount(long groupId, long parentFolderId)
313                    throws com.liferay.portal.kernel.exception.SystemException;
314    
315            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
316            public java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getNoResourceBlockFolders()
317                    throws com.liferay.portal.kernel.exception.SystemException;
318    
319            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
320            public void getSubfolderIds(java.util.List<java.lang.Long> folderIds,
321                    long groupId, long folderId)
322                    throws com.liferay.portal.kernel.exception.SystemException;
323    
324            public com.liferay.portlet.bookmarks.model.BookmarksFolder updateFolder(
325                    long folderId, long parentFolderId, java.lang.String name,
326                    java.lang.String description, boolean mergeWithParentFolder,
327                    com.liferay.portal.service.ServiceContext serviceContext)
328                    throws com.liferay.portal.kernel.exception.PortalException,
329                            com.liferay.portal.kernel.exception.SystemException;
330    }