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 aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
020    import com.liferay.portal.kernel.util.ReferenceRegistry;
021    
022    /**
023     * Provides the remote service utility for BookmarksFolder. This utility wraps
024     * {@link com.liferay.portlet.bookmarks.service.impl.BookmarksFolderServiceImpl} and is the
025     * primary access point for service operations in application layer code running
026     * on a remote server. Methods of this service are expected to have security
027     * checks based on the propagated JAAS credentials because this service can be
028     * accessed remotely.
029     *
030     * @author Brian Wing Shun Chan
031     * @see BookmarksFolderService
032     * @see com.liferay.portlet.bookmarks.service.base.BookmarksFolderServiceBaseImpl
033     * @see com.liferay.portlet.bookmarks.service.impl.BookmarksFolderServiceImpl
034     * @generated
035     */
036    @ProviderType
037    public class BookmarksFolderServiceUtil {
038            /*
039             * NOTE FOR DEVELOPERS:
040             *
041             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.bookmarks.service.impl.BookmarksFolderServiceImpl} and rerun ServiceBuilder to regenerate this class.
042             */
043    
044            /**
045            * Returns the Spring bean ID for this bean.
046            *
047            * @return the Spring bean ID for this bean
048            */
049            public static java.lang.String getBeanIdentifier() {
050                    return getService().getBeanIdentifier();
051            }
052    
053            /**
054            * Sets the Spring bean ID for this bean.
055            *
056            * @param beanIdentifier the Spring bean ID for this bean
057            */
058            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
059                    getService().setBeanIdentifier(beanIdentifier);
060            }
061    
062            public static com.liferay.portlet.bookmarks.model.BookmarksFolder addFolder(
063                    long parentFolderId, java.lang.String name,
064                    java.lang.String description,
065                    com.liferay.portal.service.ServiceContext serviceContext)
066                    throws com.liferay.portal.kernel.exception.PortalException,
067                            com.liferay.portal.kernel.exception.SystemException {
068                    return getService()
069                                       .addFolder(parentFolderId, name, description, serviceContext);
070            }
071    
072            public static void deleteFolder(long folderId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteFolder(folderId);
076            }
077    
078            public static void deleteFolder(long folderId, boolean includeTrashedEntries)
079                    throws com.liferay.portal.kernel.exception.PortalException,
080                            com.liferay.portal.kernel.exception.SystemException {
081                    getService().deleteFolder(folderId, includeTrashedEntries);
082            }
083    
084            public static com.liferay.portlet.bookmarks.model.BookmarksFolder getFolder(
085                    long folderId)
086                    throws com.liferay.portal.kernel.exception.PortalException,
087                            com.liferay.portal.kernel.exception.SystemException {
088                    return getService().getFolder(folderId);
089            }
090    
091            public static java.util.List<java.lang.Long> getFolderIds(long groupId,
092                    long folderId)
093                    throws com.liferay.portal.kernel.exception.PortalException,
094                            com.liferay.portal.kernel.exception.SystemException {
095                    return getService().getFolderIds(groupId, folderId);
096            }
097    
098            public static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getFolders(
099                    long groupId)
100                    throws com.liferay.portal.kernel.exception.SystemException {
101                    return getService().getFolders(groupId);
102            }
103    
104            public static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getFolders(
105                    long groupId, long parentFolderId)
106                    throws com.liferay.portal.kernel.exception.SystemException {
107                    return getService().getFolders(groupId, parentFolderId);
108            }
109    
110            public static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getFolders(
111                    long groupId, long parentFolderId, int start, int end)
112                    throws com.liferay.portal.kernel.exception.SystemException {
113                    return getService().getFolders(groupId, parentFolderId, start, end);
114            }
115    
116            public static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getFolders(
117                    long groupId, long parentFolderId, int status, int start, int end)
118                    throws com.liferay.portal.kernel.exception.SystemException {
119                    return getService()
120                                       .getFolders(groupId, parentFolderId, status, start, end);
121            }
122    
123            public static java.util.List<java.lang.Object> getFoldersAndEntries(
124                    long groupId, long folderId)
125                    throws com.liferay.portal.kernel.exception.SystemException {
126                    return getService().getFoldersAndEntries(groupId, folderId);
127            }
128    
129            public static java.util.List<java.lang.Object> getFoldersAndEntries(
130                    long groupId, long folderId, int status)
131                    throws com.liferay.portal.kernel.exception.SystemException {
132                    return getService().getFoldersAndEntries(groupId, folderId, status);
133            }
134    
135            public static java.util.List<java.lang.Object> getFoldersAndEntries(
136                    long groupId, long folderId, int status, int start, int end)
137                    throws com.liferay.portal.kernel.exception.SystemException {
138                    return getService()
139                                       .getFoldersAndEntries(groupId, folderId, status, start, end);
140            }
141    
142            public static int getFoldersAndEntriesCount(long groupId, long folderId)
143                    throws com.liferay.portal.kernel.exception.SystemException {
144                    return getService().getFoldersAndEntriesCount(groupId, folderId);
145            }
146    
147            public static int getFoldersAndEntriesCount(long groupId, long folderId,
148                    int status) throws com.liferay.portal.kernel.exception.SystemException {
149                    return getService().getFoldersAndEntriesCount(groupId, folderId, status);
150            }
151    
152            public static int getFoldersCount(long groupId, long parentFolderId)
153                    throws com.liferay.portal.kernel.exception.SystemException {
154                    return getService().getFoldersCount(groupId, parentFolderId);
155            }
156    
157            public static int getFoldersCount(long groupId, long parentFolderId,
158                    int status) throws com.liferay.portal.kernel.exception.SystemException {
159                    return getService().getFoldersCount(groupId, parentFolderId, status);
160            }
161    
162            /**
163            * @deprecated As of 7.0.0, replaced by {@link #getSubfolderIds(List, long,
164            long, boolean)}
165            */
166            @Deprecated
167            public static void getSubfolderIds(
168                    java.util.List<java.lang.Long> folderIds, long groupId, long folderId)
169                    throws com.liferay.portal.kernel.exception.SystemException {
170                    getService().getSubfolderIds(folderIds, groupId, folderId);
171            }
172    
173            public static void getSubfolderIds(
174                    java.util.List<java.lang.Long> folderIds, long groupId, long folderId,
175                    boolean recurse)
176                    throws com.liferay.portal.kernel.exception.SystemException {
177                    getService().getSubfolderIds(folderIds, groupId, folderId, recurse);
178            }
179    
180            public static java.util.List<java.lang.Long> getSubfolderIds(long groupId,
181                    long folderId, boolean recurse)
182                    throws com.liferay.portal.kernel.exception.SystemException {
183                    return getService().getSubfolderIds(groupId, folderId, recurse);
184            }
185    
186            public static com.liferay.portlet.bookmarks.model.BookmarksFolder moveFolder(
187                    long folderId, long parentFolderId)
188                    throws com.liferay.portal.kernel.exception.PortalException,
189                            com.liferay.portal.kernel.exception.SystemException {
190                    return getService().moveFolder(folderId, parentFolderId);
191            }
192    
193            public static com.liferay.portlet.bookmarks.model.BookmarksFolder moveFolderFromTrash(
194                    long folderId, long parentFolderId)
195                    throws com.liferay.portal.kernel.exception.PortalException,
196                            com.liferay.portal.kernel.exception.SystemException {
197                    return getService().moveFolderFromTrash(folderId, parentFolderId);
198            }
199    
200            public static com.liferay.portlet.bookmarks.model.BookmarksFolder moveFolderToTrash(
201                    long folderId)
202                    throws com.liferay.portal.kernel.exception.PortalException,
203                            com.liferay.portal.kernel.exception.SystemException {
204                    return getService().moveFolderToTrash(folderId);
205            }
206    
207            public static void restoreFolderFromTrash(long folderId)
208                    throws com.liferay.portal.kernel.exception.PortalException,
209                            com.liferay.portal.kernel.exception.SystemException {
210                    getService().restoreFolderFromTrash(folderId);
211            }
212    
213            public static void subscribeFolder(long groupId, long folderId)
214                    throws com.liferay.portal.kernel.exception.PortalException,
215                            com.liferay.portal.kernel.exception.SystemException {
216                    getService().subscribeFolder(groupId, folderId);
217            }
218    
219            public static void unsubscribeFolder(long groupId, long folderId)
220                    throws com.liferay.portal.kernel.exception.PortalException,
221                            com.liferay.portal.kernel.exception.SystemException {
222                    getService().unsubscribeFolder(groupId, folderId);
223            }
224    
225            public static com.liferay.portlet.bookmarks.model.BookmarksFolder updateFolder(
226                    long folderId, long parentFolderId, java.lang.String name,
227                    java.lang.String description, boolean mergeWithParentFolder,
228                    com.liferay.portal.service.ServiceContext serviceContext)
229                    throws com.liferay.portal.kernel.exception.PortalException,
230                            com.liferay.portal.kernel.exception.SystemException {
231                    return getService()
232                                       .updateFolder(folderId, parentFolderId, name, description,
233                            mergeWithParentFolder, serviceContext);
234            }
235    
236            public static BookmarksFolderService getService() {
237                    if (_service == null) {
238                            _service = (BookmarksFolderService)PortalBeanLocatorUtil.locate(BookmarksFolderService.class.getName());
239    
240                            ReferenceRegistry.registerReference(BookmarksFolderServiceUtil.class,
241                                    "_service");
242                    }
243    
244                    return _service;
245            }
246    
247            /**
248             * @deprecated As of 6.2.0
249             */
250            public void setService(BookmarksFolderService service) {
251            }
252    
253            private static BookmarksFolderService _service;
254    }