001    /**
002     * Copyright (c) 2000-2010 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.bean.PortalBeanLocatorUtil;
018    
019    /**
020     * The utility for the bookmarks folder local service. This utility wraps {@link com.liferay.portlet.bookmarks.service.impl.BookmarksFolderLocalServiceImpl} and is the primary access point for service operations in application layer code running on the local server.
021     *
022     * <p>
023     * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.bookmarks.service.impl.BookmarksFolderLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
024     * </p>
025     *
026     * <p>
027     * 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.
028     * </p>
029     *
030     * @author Brian Wing Shun Chan
031     * @see BookmarksFolderLocalService
032     * @see com.liferay.portlet.bookmarks.service.base.BookmarksFolderLocalServiceBaseImpl
033     * @see com.liferay.portlet.bookmarks.service.impl.BookmarksFolderLocalServiceImpl
034     * @generated
035     */
036    public class BookmarksFolderLocalServiceUtil {
037            /**
038            * Adds the bookmarks folder to the database. Also notifies the appropriate model listeners.
039            *
040            * @param bookmarksFolder the bookmarks folder to add
041            * @return the bookmarks folder that was added
042            * @throws SystemException if a system exception occurred
043            */
044            public static com.liferay.portlet.bookmarks.model.BookmarksFolder addBookmarksFolder(
045                    com.liferay.portlet.bookmarks.model.BookmarksFolder bookmarksFolder)
046                    throws com.liferay.portal.kernel.exception.SystemException {
047                    return getService().addBookmarksFolder(bookmarksFolder);
048            }
049    
050            /**
051            * Creates a new bookmarks folder with the primary key. Does not add the bookmarks folder to the database.
052            *
053            * @param folderId the primary key for the new bookmarks folder
054            * @return the new bookmarks folder
055            */
056            public static com.liferay.portlet.bookmarks.model.BookmarksFolder createBookmarksFolder(
057                    long folderId) {
058                    return getService().createBookmarksFolder(folderId);
059            }
060    
061            /**
062            * Deletes the bookmarks folder with the primary key from the database. Also notifies the appropriate model listeners.
063            *
064            * @param folderId the primary key of the bookmarks folder to delete
065            * @throws PortalException if a bookmarks folder with the primary key could not be found
066            * @throws SystemException if a system exception occurred
067            */
068            public static void deleteBookmarksFolder(long folderId)
069                    throws com.liferay.portal.kernel.exception.PortalException,
070                            com.liferay.portal.kernel.exception.SystemException {
071                    getService().deleteBookmarksFolder(folderId);
072            }
073    
074            /**
075            * Deletes the bookmarks folder from the database. Also notifies the appropriate model listeners.
076            *
077            * @param bookmarksFolder the bookmarks folder to delete
078            * @throws SystemException if a system exception occurred
079            */
080            public static void deleteBookmarksFolder(
081                    com.liferay.portlet.bookmarks.model.BookmarksFolder bookmarksFolder)
082                    throws com.liferay.portal.kernel.exception.SystemException {
083                    getService().deleteBookmarksFolder(bookmarksFolder);
084            }
085    
086            /**
087            * Performs a dynamic query on the database and returns the matching rows.
088            *
089            * @param dynamicQuery the dynamic query to search with
090            * @return the matching rows
091            * @throws SystemException if a system exception occurred
092            */
093            @SuppressWarnings("rawtypes")
094            public static java.util.List dynamicQuery(
095                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
096                    throws com.liferay.portal.kernel.exception.SystemException {
097                    return getService().dynamicQuery(dynamicQuery);
098            }
099    
100            /**
101            * Performs a dynamic query on the database and returns a range of the matching rows.
102            *
103            * <p>
104            * 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.
105            * </p>
106            *
107            * @param dynamicQuery the dynamic query to search with
108            * @param start the lower bound of the range of model instances to return
109            * @param end the upper bound of the range of model instances to return (not inclusive)
110            * @return the range of matching rows
111            * @throws SystemException if a system exception occurred
112            */
113            @SuppressWarnings("rawtypes")
114            public static java.util.List dynamicQuery(
115                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
116                    int end) throws com.liferay.portal.kernel.exception.SystemException {
117                    return getService().dynamicQuery(dynamicQuery, start, end);
118            }
119    
120            /**
121            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
122            *
123            * <p>
124            * 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.
125            * </p>
126            *
127            * @param dynamicQuery the dynamic query to search with
128            * @param start the lower bound of the range of model instances to return
129            * @param end the upper bound of the range of model instances to return (not inclusive)
130            * @param orderByComparator the comparator to order the results by
131            * @return the ordered range of matching rows
132            * @throws SystemException if a system exception occurred
133            */
134            @SuppressWarnings("rawtypes")
135            public static java.util.List dynamicQuery(
136                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
137                    int end,
138                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
139                    throws com.liferay.portal.kernel.exception.SystemException {
140                    return getService()
141                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
142            }
143    
144            /**
145            * Counts the number of rows that match the dynamic query.
146            *
147            * @param dynamicQuery the dynamic query to search with
148            * @return the number of rows that match the dynamic query
149            * @throws SystemException if a system exception occurred
150            */
151            public static long dynamicQueryCount(
152                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
153                    throws com.liferay.portal.kernel.exception.SystemException {
154                    return getService().dynamicQueryCount(dynamicQuery);
155            }
156    
157            /**
158            * Gets the bookmarks folder with the primary key.
159            *
160            * @param folderId the primary key of the bookmarks folder to get
161            * @return the bookmarks folder
162            * @throws PortalException if a bookmarks folder with the primary key could not be found
163            * @throws SystemException if a system exception occurred
164            */
165            public static com.liferay.portlet.bookmarks.model.BookmarksFolder getBookmarksFolder(
166                    long folderId)
167                    throws com.liferay.portal.kernel.exception.PortalException,
168                            com.liferay.portal.kernel.exception.SystemException {
169                    return getService().getBookmarksFolder(folderId);
170            }
171    
172            /**
173            * Gets the bookmarks folder with the UUID and group id.
174            *
175            * @param uuid the UUID of bookmarks folder to get
176            * @param groupId the group id of the bookmarks folder to get
177            * @return the bookmarks folder
178            * @throws PortalException if a bookmarks folder with the UUID and group id could not be found
179            * @throws SystemException if a system exception occurred
180            */
181            public static com.liferay.portlet.bookmarks.model.BookmarksFolder getBookmarksFolderByUuidAndGroupId(
182                    java.lang.String uuid, long groupId)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return getService().getBookmarksFolderByUuidAndGroupId(uuid, groupId);
186            }
187    
188            /**
189            * Gets a range of all the bookmarks folders.
190            *
191            * <p>
192            * 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.
193            * </p>
194            *
195            * @param start the lower bound of the range of bookmarks folders to return
196            * @param end the upper bound of the range of bookmarks folders to return (not inclusive)
197            * @return the range of bookmarks folders
198            * @throws SystemException if a system exception occurred
199            */
200            public static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getBookmarksFolders(
201                    int start, int end)
202                    throws com.liferay.portal.kernel.exception.SystemException {
203                    return getService().getBookmarksFolders(start, end);
204            }
205    
206            /**
207            * Gets the number of bookmarks folders.
208            *
209            * @return the number of bookmarks folders
210            * @throws SystemException if a system exception occurred
211            */
212            public static int getBookmarksFoldersCount()
213                    throws com.liferay.portal.kernel.exception.SystemException {
214                    return getService().getBookmarksFoldersCount();
215            }
216    
217            /**
218            * Updates the bookmarks folder in the database. Also notifies the appropriate model listeners.
219            *
220            * @param bookmarksFolder the bookmarks folder to update
221            * @return the bookmarks folder that was updated
222            * @throws SystemException if a system exception occurred
223            */
224            public static com.liferay.portlet.bookmarks.model.BookmarksFolder updateBookmarksFolder(
225                    com.liferay.portlet.bookmarks.model.BookmarksFolder bookmarksFolder)
226                    throws com.liferay.portal.kernel.exception.SystemException {
227                    return getService().updateBookmarksFolder(bookmarksFolder);
228            }
229    
230            /**
231            * Updates the bookmarks folder in the database. Also notifies the appropriate model listeners.
232            *
233            * @param bookmarksFolder the bookmarks folder to update
234            * @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.
235            * @return the bookmarks folder that was updated
236            * @throws SystemException if a system exception occurred
237            */
238            public static com.liferay.portlet.bookmarks.model.BookmarksFolder updateBookmarksFolder(
239                    com.liferay.portlet.bookmarks.model.BookmarksFolder bookmarksFolder,
240                    boolean merge)
241                    throws com.liferay.portal.kernel.exception.SystemException {
242                    return getService().updateBookmarksFolder(bookmarksFolder, merge);
243            }
244    
245            public static com.liferay.portlet.bookmarks.model.BookmarksFolder addFolder(
246                    long userId, long parentFolderId, java.lang.String name,
247                    java.lang.String description,
248                    com.liferay.portal.service.ServiceContext serviceContext)
249                    throws com.liferay.portal.kernel.exception.PortalException,
250                            com.liferay.portal.kernel.exception.SystemException {
251                    return getService()
252                                       .addFolder(userId, parentFolderId, name, description,
253                            serviceContext);
254            }
255    
256            public static void addFolderResources(
257                    com.liferay.portlet.bookmarks.model.BookmarksFolder folder,
258                    boolean addCommunityPermissions, boolean addGuestPermissions)
259                    throws com.liferay.portal.kernel.exception.PortalException,
260                            com.liferay.portal.kernel.exception.SystemException {
261                    getService()
262                            .addFolderResources(folder, addCommunityPermissions,
263                            addGuestPermissions);
264            }
265    
266            public static void addFolderResources(
267                    com.liferay.portlet.bookmarks.model.BookmarksFolder folder,
268                    java.lang.String[] communityPermissions,
269                    java.lang.String[] guestPermissions)
270                    throws com.liferay.portal.kernel.exception.PortalException,
271                            com.liferay.portal.kernel.exception.SystemException {
272                    getService()
273                            .addFolderResources(folder, communityPermissions, guestPermissions);
274            }
275    
276            public static void addFolderResources(long folderId,
277                    boolean addCommunityPermissions, boolean addGuestPermissions)
278                    throws com.liferay.portal.kernel.exception.PortalException,
279                            com.liferay.portal.kernel.exception.SystemException {
280                    getService()
281                            .addFolderResources(folderId, addCommunityPermissions,
282                            addGuestPermissions);
283            }
284    
285            public static void addFolderResources(long folderId,
286                    java.lang.String[] communityPermissions,
287                    java.lang.String[] guestPermissions)
288                    throws com.liferay.portal.kernel.exception.PortalException,
289                            com.liferay.portal.kernel.exception.SystemException {
290                    getService()
291                            .addFolderResources(folderId, communityPermissions, guestPermissions);
292            }
293    
294            public static void deleteFolder(
295                    com.liferay.portlet.bookmarks.model.BookmarksFolder folder)
296                    throws com.liferay.portal.kernel.exception.PortalException,
297                            com.liferay.portal.kernel.exception.SystemException {
298                    getService().deleteFolder(folder);
299            }
300    
301            public static void deleteFolder(long folderId)
302                    throws com.liferay.portal.kernel.exception.PortalException,
303                            com.liferay.portal.kernel.exception.SystemException {
304                    getService().deleteFolder(folderId);
305            }
306    
307            public static void deleteFolders(long groupId)
308                    throws com.liferay.portal.kernel.exception.PortalException,
309                            com.liferay.portal.kernel.exception.SystemException {
310                    getService().deleteFolders(groupId);
311            }
312    
313            public static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getCompanyFolders(
314                    long companyId, int start, int end)
315                    throws com.liferay.portal.kernel.exception.SystemException {
316                    return getService().getCompanyFolders(companyId, start, end);
317            }
318    
319            public static int getCompanyFoldersCount(long companyId)
320                    throws com.liferay.portal.kernel.exception.SystemException {
321                    return getService().getCompanyFoldersCount(companyId);
322            }
323    
324            public static com.liferay.portlet.bookmarks.model.BookmarksFolder getFolder(
325                    long folderId)
326                    throws com.liferay.portal.kernel.exception.PortalException,
327                            com.liferay.portal.kernel.exception.SystemException {
328                    return getService().getFolder(folderId);
329            }
330    
331            public static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getFolders(
332                    long groupId)
333                    throws com.liferay.portal.kernel.exception.SystemException {
334                    return getService().getFolders(groupId);
335            }
336    
337            public static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getFolders(
338                    long groupId, long parentFolderId)
339                    throws com.liferay.portal.kernel.exception.SystemException {
340                    return getService().getFolders(groupId, parentFolderId);
341            }
342    
343            public static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getFolders(
344                    long groupId, long parentFolderId, int start, int end)
345                    throws com.liferay.portal.kernel.exception.SystemException {
346                    return getService().getFolders(groupId, parentFolderId, start, end);
347            }
348    
349            public static int getFoldersCount(long groupId, long parentFolderId)
350                    throws com.liferay.portal.kernel.exception.SystemException {
351                    return getService().getFoldersCount(groupId, parentFolderId);
352            }
353    
354            public static void getSubfolderIds(
355                    java.util.List<java.lang.Long> folderIds, long groupId, long folderId)
356                    throws com.liferay.portal.kernel.exception.SystemException {
357                    getService().getSubfolderIds(folderIds, groupId, folderId);
358            }
359    
360            public static com.liferay.portlet.bookmarks.model.BookmarksFolder updateFolder(
361                    long folderId, long parentFolderId, java.lang.String name,
362                    java.lang.String description, boolean mergeWithParentFolder,
363                    com.liferay.portal.service.ServiceContext serviceContext)
364                    throws com.liferay.portal.kernel.exception.PortalException,
365                            com.liferay.portal.kernel.exception.SystemException {
366                    return getService()
367                                       .updateFolder(folderId, parentFolderId, name, description,
368                            mergeWithParentFolder, serviceContext);
369            }
370    
371            public static BookmarksFolderLocalService getService() {
372                    if (_service == null) {
373                            _service = (BookmarksFolderLocalService)PortalBeanLocatorUtil.locate(BookmarksFolderLocalService.class.getName());
374                    }
375    
376                    return _service;
377            }
378    
379            public void setService(BookmarksFolderLocalService service) {
380                    _service = service;
381            }
382    
383            private static BookmarksFolderLocalService _service;
384    }