001    /**
002     * Copyright (c) 2000-2012 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.ReferenceRegistry;
019    
020    /**
021     * 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.
022     *
023     * <p>
024     * 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.
025     * </p>
026     *
027     * @author Brian Wing Shun Chan
028     * @see BookmarksFolderLocalService
029     * @see com.liferay.portlet.bookmarks.service.base.BookmarksFolderLocalServiceBaseImpl
030     * @see com.liferay.portlet.bookmarks.service.impl.BookmarksFolderLocalServiceImpl
031     * @generated
032     */
033    public class BookmarksFolderLocalServiceUtil {
034            /*
035             * NOTE FOR DEVELOPERS:
036             *
037             * 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.
038             */
039    
040            /**
041            * Adds the bookmarks folder to the database. Also notifies the appropriate model listeners.
042            *
043            * @param bookmarksFolder the bookmarks folder
044            * @return the bookmarks folder that was added
045            * @throws SystemException if a system exception occurred
046            */
047            public static com.liferay.portlet.bookmarks.model.BookmarksFolder addBookmarksFolder(
048                    com.liferay.portlet.bookmarks.model.BookmarksFolder bookmarksFolder)
049                    throws com.liferay.portal.kernel.exception.SystemException {
050                    return getService().addBookmarksFolder(bookmarksFolder);
051            }
052    
053            /**
054            * Creates a new bookmarks folder with the primary key. Does not add the bookmarks folder to the database.
055            *
056            * @param folderId the primary key for the new bookmarks folder
057            * @return the new bookmarks folder
058            */
059            public static com.liferay.portlet.bookmarks.model.BookmarksFolder createBookmarksFolder(
060                    long folderId) {
061                    return getService().createBookmarksFolder(folderId);
062            }
063    
064            /**
065            * Deletes the bookmarks folder with the primary key from the database. Also notifies the appropriate model listeners.
066            *
067            * @param folderId the primary key of the bookmarks folder
068            * @return the bookmarks folder that was removed
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 com.liferay.portlet.bookmarks.model.BookmarksFolder deleteBookmarksFolder(
073                    long folderId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException {
076                    return getService().deleteBookmarksFolder(folderId);
077            }
078    
079            /**
080            * Deletes the bookmarks folder from the database. Also notifies the appropriate model listeners.
081            *
082            * @param bookmarksFolder the bookmarks folder
083            * @return the bookmarks folder that was removed
084            * @throws SystemException if a system exception occurred
085            */
086            public static com.liferay.portlet.bookmarks.model.BookmarksFolder deleteBookmarksFolder(
087                    com.liferay.portlet.bookmarks.model.BookmarksFolder bookmarksFolder)
088                    throws com.liferay.portal.kernel.exception.SystemException {
089                    return getService().deleteBookmarksFolder(bookmarksFolder);
090            }
091    
092            public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
093                    return getService().dynamicQuery();
094            }
095    
096            /**
097            * Performs a dynamic query on the database and returns the matching rows.
098            *
099            * @param dynamicQuery the dynamic query
100            * @return the matching rows
101            * @throws SystemException if a system exception occurred
102            */
103            @SuppressWarnings("rawtypes")
104            public static java.util.List dynamicQuery(
105                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
106                    throws com.liferay.portal.kernel.exception.SystemException {
107                    return getService().dynamicQuery(dynamicQuery);
108            }
109    
110            /**
111            * Performs a dynamic query on the database and returns a range of the matching rows.
112            *
113            * <p>
114            * 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.
115            * </p>
116            *
117            * @param dynamicQuery the dynamic query
118            * @param start the lower bound of the range of model instances
119            * @param end the upper bound of the range of model instances (not inclusive)
120            * @return the range of matching rows
121            * @throws SystemException if a system exception occurred
122            */
123            @SuppressWarnings("rawtypes")
124            public static java.util.List dynamicQuery(
125                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
126                    int end) throws com.liferay.portal.kernel.exception.SystemException {
127                    return getService().dynamicQuery(dynamicQuery, start, end);
128            }
129    
130            /**
131            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
132            *
133            * <p>
134            * 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.
135            * </p>
136            *
137            * @param dynamicQuery the dynamic query
138            * @param start the lower bound of the range of model instances
139            * @param end the upper bound of the range of model instances (not inclusive)
140            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
141            * @return the ordered range of matching rows
142            * @throws SystemException if a system exception occurred
143            */
144            @SuppressWarnings("rawtypes")
145            public static java.util.List dynamicQuery(
146                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
147                    int end,
148                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
149                    throws com.liferay.portal.kernel.exception.SystemException {
150                    return getService()
151                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
152            }
153    
154            /**
155            * Returns the number of rows that match the dynamic query.
156            *
157            * @param dynamicQuery the dynamic query
158            * @return the number of rows that match the dynamic query
159            * @throws SystemException if a system exception occurred
160            */
161            public static long dynamicQueryCount(
162                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
163                    throws com.liferay.portal.kernel.exception.SystemException {
164                    return getService().dynamicQueryCount(dynamicQuery);
165            }
166    
167            public static com.liferay.portlet.bookmarks.model.BookmarksFolder fetchBookmarksFolder(
168                    long folderId)
169                    throws com.liferay.portal.kernel.exception.SystemException {
170                    return getService().fetchBookmarksFolder(folderId);
171            }
172    
173            /**
174            * Returns the bookmarks folder with the primary key.
175            *
176            * @param folderId the primary key of the bookmarks folder
177            * @return the bookmarks folder
178            * @throws PortalException if a bookmarks folder with the primary key could not be found
179            * @throws SystemException if a system exception occurred
180            */
181            public static com.liferay.portlet.bookmarks.model.BookmarksFolder getBookmarksFolder(
182                    long folderId)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return getService().getBookmarksFolder(folderId);
186            }
187    
188            public static com.liferay.portal.model.PersistedModel getPersistedModel(
189                    java.io.Serializable primaryKeyObj)
190                    throws com.liferay.portal.kernel.exception.PortalException,
191                            com.liferay.portal.kernel.exception.SystemException {
192                    return getService().getPersistedModel(primaryKeyObj);
193            }
194    
195            /**
196            * Returns the bookmarks folder with the UUID in the group.
197            *
198            * @param uuid the UUID of bookmarks folder
199            * @param groupId the group id of the bookmarks folder
200            * @return the bookmarks folder
201            * @throws PortalException if a bookmarks folder with the UUID in the group could not be found
202            * @throws SystemException if a system exception occurred
203            */
204            public static com.liferay.portlet.bookmarks.model.BookmarksFolder getBookmarksFolderByUuidAndGroupId(
205                    java.lang.String uuid, long groupId)
206                    throws com.liferay.portal.kernel.exception.PortalException,
207                            com.liferay.portal.kernel.exception.SystemException {
208                    return getService().getBookmarksFolderByUuidAndGroupId(uuid, groupId);
209            }
210    
211            /**
212            * Returns a range of all the bookmarks folders.
213            *
214            * <p>
215            * 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.
216            * </p>
217            *
218            * @param start the lower bound of the range of bookmarks folders
219            * @param end the upper bound of the range of bookmarks folders (not inclusive)
220            * @return the range of bookmarks folders
221            * @throws SystemException if a system exception occurred
222            */
223            public static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getBookmarksFolders(
224                    int start, int end)
225                    throws com.liferay.portal.kernel.exception.SystemException {
226                    return getService().getBookmarksFolders(start, end);
227            }
228    
229            /**
230            * Returns the number of bookmarks folders.
231            *
232            * @return the number of bookmarks folders
233            * @throws SystemException if a system exception occurred
234            */
235            public static int getBookmarksFoldersCount()
236                    throws com.liferay.portal.kernel.exception.SystemException {
237                    return getService().getBookmarksFoldersCount();
238            }
239    
240            /**
241            * Updates the bookmarks folder in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
242            *
243            * @param bookmarksFolder the bookmarks folder
244            * @return the bookmarks folder that was updated
245            * @throws SystemException if a system exception occurred
246            */
247            public static com.liferay.portlet.bookmarks.model.BookmarksFolder updateBookmarksFolder(
248                    com.liferay.portlet.bookmarks.model.BookmarksFolder bookmarksFolder)
249                    throws com.liferay.portal.kernel.exception.SystemException {
250                    return getService().updateBookmarksFolder(bookmarksFolder);
251            }
252    
253            /**
254            * Returns the Spring bean ID for this bean.
255            *
256            * @return the Spring bean ID for this bean
257            */
258            public static java.lang.String getBeanIdentifier() {
259                    return getService().getBeanIdentifier();
260            }
261    
262            /**
263            * Sets the Spring bean ID for this bean.
264            *
265            * @param beanIdentifier the Spring bean ID for this bean
266            */
267            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
268                    getService().setBeanIdentifier(beanIdentifier);
269            }
270    
271            public static com.liferay.portlet.bookmarks.model.BookmarksFolder addFolder(
272                    long userId, long parentFolderId, java.lang.String name,
273                    java.lang.String description,
274                    com.liferay.portal.service.ServiceContext serviceContext)
275                    throws com.liferay.portal.kernel.exception.PortalException,
276                            com.liferay.portal.kernel.exception.SystemException {
277                    return getService()
278                                       .addFolder(userId, parentFolderId, name, description,
279                            serviceContext);
280            }
281    
282            public static com.liferay.portlet.bookmarks.model.BookmarksFolder deleteFolder(
283                    com.liferay.portlet.bookmarks.model.BookmarksFolder folder)
284                    throws com.liferay.portal.kernel.exception.PortalException,
285                            com.liferay.portal.kernel.exception.SystemException {
286                    return getService().deleteFolder(folder);
287            }
288    
289            public static com.liferay.portlet.bookmarks.model.BookmarksFolder deleteFolder(
290                    com.liferay.portlet.bookmarks.model.BookmarksFolder folder,
291                    boolean includeTrashedEntries)
292                    throws com.liferay.portal.kernel.exception.PortalException,
293                            com.liferay.portal.kernel.exception.SystemException {
294                    return getService().deleteFolder(folder, includeTrashedEntries);
295            }
296    
297            public static com.liferay.portlet.bookmarks.model.BookmarksFolder deleteFolder(
298                    long folderId)
299                    throws com.liferay.portal.kernel.exception.PortalException,
300                            com.liferay.portal.kernel.exception.SystemException {
301                    return getService().deleteFolder(folderId);
302            }
303    
304            public static com.liferay.portlet.bookmarks.model.BookmarksFolder deleteFolder(
305                    long folderId, boolean includeTrashedEntries)
306                    throws com.liferay.portal.kernel.exception.PortalException,
307                            com.liferay.portal.kernel.exception.SystemException {
308                    return getService().deleteFolder(folderId, includeTrashedEntries);
309            }
310    
311            public static void deleteFolders(long groupId)
312                    throws com.liferay.portal.kernel.exception.PortalException,
313                            com.liferay.portal.kernel.exception.SystemException {
314                    getService().deleteFolders(groupId);
315            }
316    
317            public static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getCompanyFolders(
318                    long companyId, int start, int end)
319                    throws com.liferay.portal.kernel.exception.SystemException {
320                    return getService().getCompanyFolders(companyId, start, end);
321            }
322    
323            public static int getCompanyFoldersCount(long companyId)
324                    throws com.liferay.portal.kernel.exception.SystemException {
325                    return getService().getCompanyFoldersCount(companyId);
326            }
327    
328            public static com.liferay.portlet.bookmarks.model.BookmarksFolder getFolder(
329                    long folderId)
330                    throws com.liferay.portal.kernel.exception.PortalException,
331                            com.liferay.portal.kernel.exception.SystemException {
332                    return getService().getFolder(folderId);
333            }
334    
335            public static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getFolders(
336                    long groupId)
337                    throws com.liferay.portal.kernel.exception.SystemException {
338                    return getService().getFolders(groupId);
339            }
340    
341            public static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getFolders(
342                    long groupId, long parentFolderId)
343                    throws com.liferay.portal.kernel.exception.SystemException {
344                    return getService().getFolders(groupId, parentFolderId);
345            }
346    
347            public static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getFolders(
348                    long groupId, long parentFolderId, int start, int end)
349                    throws com.liferay.portal.kernel.exception.SystemException {
350                    return getService().getFolders(groupId, parentFolderId, start, end);
351            }
352    
353            public static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getFolders(
354                    long groupId, long parentFolderId, int status, int start, int end)
355                    throws com.liferay.portal.kernel.exception.SystemException {
356                    return getService()
357                                       .getFolders(groupId, parentFolderId, status, start, end);
358            }
359    
360            public static java.util.List<java.lang.Object> getFoldersAndEntries(
361                    long groupId, long folderId)
362                    throws com.liferay.portal.kernel.exception.SystemException {
363                    return getService().getFoldersAndEntries(groupId, folderId);
364            }
365    
366            public static java.util.List<java.lang.Object> getFoldersAndEntries(
367                    long groupId, long folderId, int status)
368                    throws com.liferay.portal.kernel.exception.SystemException {
369                    return getService().getFoldersAndEntries(groupId, folderId, status);
370            }
371    
372            public static java.util.List<java.lang.Object> getFoldersAndEntries(
373                    long groupId, long folderId, int status, int start, int end)
374                    throws com.liferay.portal.kernel.exception.SystemException {
375                    return getService()
376                                       .getFoldersAndEntries(groupId, folderId, status, start, end);
377            }
378    
379            public static int getFoldersAndEntriesCount(long groupId, long folderId,
380                    int status) throws com.liferay.portal.kernel.exception.SystemException {
381                    return getService().getFoldersAndEntriesCount(groupId, folderId, status);
382            }
383    
384            public static int getFoldersCount(long groupId, long parentFolderId)
385                    throws com.liferay.portal.kernel.exception.SystemException {
386                    return getService().getFoldersCount(groupId, parentFolderId);
387            }
388    
389            public static int getFoldersCount(long groupId, long parentFolderId,
390                    int status) throws com.liferay.portal.kernel.exception.SystemException {
391                    return getService().getFoldersCount(groupId, parentFolderId, status);
392            }
393    
394            public static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getNoAssetFolders()
395                    throws com.liferay.portal.kernel.exception.SystemException {
396                    return getService().getNoAssetFolders();
397            }
398    
399            public static void getSubfolderIds(
400                    java.util.List<java.lang.Long> folderIds, long groupId, long folderId)
401                    throws com.liferay.portal.kernel.exception.SystemException {
402                    getService().getSubfolderIds(folderIds, groupId, folderId);
403            }
404    
405            public static 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                    return getService().moveFolder(folderId, parentFolderId);
410            }
411    
412            public static com.liferay.portlet.bookmarks.model.BookmarksFolder moveFolderFromTrash(
413                    long userId, long folderId, long parentFolderId)
414                    throws com.liferay.portal.kernel.exception.PortalException,
415                            com.liferay.portal.kernel.exception.SystemException {
416                    return getService().moveFolderFromTrash(userId, folderId, parentFolderId);
417            }
418    
419            public static void moveFolderToTrash(long userId, long folderId)
420                    throws com.liferay.portal.kernel.exception.PortalException,
421                            com.liferay.portal.kernel.exception.SystemException {
422                    getService().moveFolderToTrash(userId, folderId);
423            }
424    
425            public static void restoreFolderFromTrash(long userId, long folderId)
426                    throws com.liferay.portal.kernel.exception.PortalException,
427                            com.liferay.portal.kernel.exception.SystemException {
428                    getService().restoreFolderFromTrash(userId, folderId);
429            }
430    
431            public static void subscribeFolder(long userId, long groupId, long folderId)
432                    throws com.liferay.portal.kernel.exception.PortalException,
433                            com.liferay.portal.kernel.exception.SystemException {
434                    getService().subscribeFolder(userId, groupId, folderId);
435            }
436    
437            public static void unsubscribeFolder(long userId, long groupId,
438                    long folderId)
439                    throws com.liferay.portal.kernel.exception.PortalException,
440                            com.liferay.portal.kernel.exception.SystemException {
441                    getService().unsubscribeFolder(userId, groupId, folderId);
442            }
443    
444            public static void updateAsset(long userId,
445                    com.liferay.portlet.bookmarks.model.BookmarksFolder folder,
446                    long[] assetCategoryIds, java.lang.String[] assetTagNames,
447                    long[] assetLinkEntryIds)
448                    throws com.liferay.portal.kernel.exception.PortalException,
449                            com.liferay.portal.kernel.exception.SystemException {
450                    getService()
451                            .updateAsset(userId, folder, assetCategoryIds, assetTagNames,
452                            assetLinkEntryIds);
453            }
454    
455            public static com.liferay.portlet.bookmarks.model.BookmarksFolder updateFolder(
456                    long userId, long folderId, long parentFolderId, java.lang.String name,
457                    java.lang.String description, boolean mergeWithParentFolder,
458                    com.liferay.portal.service.ServiceContext serviceContext)
459                    throws com.liferay.portal.kernel.exception.PortalException,
460                            com.liferay.portal.kernel.exception.SystemException {
461                    return getService()
462                                       .updateFolder(userId, folderId, parentFolderId, name,
463                            description, mergeWithParentFolder, serviceContext);
464            }
465    
466            public static com.liferay.portlet.bookmarks.model.BookmarksFolder updateStatus(
467                    long userId,
468                    com.liferay.portlet.bookmarks.model.BookmarksFolder folder, int status)
469                    throws com.liferay.portal.kernel.exception.PortalException,
470                            com.liferay.portal.kernel.exception.SystemException {
471                    return getService().updateStatus(userId, folder, status);
472            }
473    
474            public static BookmarksFolderLocalService getService() {
475                    if (_service == null) {
476                            _service = (BookmarksFolderLocalService)PortalBeanLocatorUtil.locate(BookmarksFolderLocalService.class.getName());
477    
478                            ReferenceRegistry.registerReference(BookmarksFolderLocalServiceUtil.class,
479                                    "_service");
480                    }
481    
482                    return _service;
483            }
484    
485            /**
486             * @deprecated
487             */
488            public void setService(BookmarksFolderLocalService service) {
489            }
490    
491            private static BookmarksFolderLocalService _service;
492    }