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