001    /**
002     * Copyright (c) 2000-present 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            public static com.liferay.portlet.bookmarks.model.BookmarksFolder addFolder(
044                    long parentFolderId, java.lang.String name,
045                    java.lang.String description,
046                    com.liferay.portal.service.ServiceContext serviceContext)
047                    throws com.liferay.portal.kernel.exception.PortalException {
048                    return getService()
049                                       .addFolder(parentFolderId, name, description, serviceContext);
050            }
051    
052            public static void deleteFolder(long folderId)
053                    throws com.liferay.portal.kernel.exception.PortalException {
054                    getService().deleteFolder(folderId);
055            }
056    
057            public static void deleteFolder(long folderId, boolean includeTrashedEntries)
058                    throws com.liferay.portal.kernel.exception.PortalException {
059                    getService().deleteFolder(folderId, includeTrashedEntries);
060            }
061    
062            /**
063            * Returns the Spring bean ID for this bean.
064            *
065            * @return the Spring bean ID for this bean
066            */
067            public static java.lang.String getBeanIdentifier() {
068                    return getService().getBeanIdentifier();
069            }
070    
071            public static com.liferay.portlet.bookmarks.model.BookmarksFolder getFolder(
072                    long folderId)
073                    throws com.liferay.portal.kernel.exception.PortalException {
074                    return getService().getFolder(folderId);
075            }
076    
077            public static java.util.List<java.lang.Long> getFolderIds(long groupId,
078                    long folderId)
079                    throws com.liferay.portal.kernel.exception.PortalException {
080                    return getService().getFolderIds(groupId, folderId);
081            }
082    
083            public static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getFolders(
084                    long groupId) {
085                    return getService().getFolders(groupId);
086            }
087    
088            public static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getFolders(
089                    long groupId, long parentFolderId) {
090                    return getService().getFolders(groupId, parentFolderId);
091            }
092    
093            public static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getFolders(
094                    long groupId, long parentFolderId, int start, int end) {
095                    return getService().getFolders(groupId, parentFolderId, start, end);
096            }
097    
098            public static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getFolders(
099                    long groupId, long parentFolderId, int status, int start, int end) {
100                    return getService()
101                                       .getFolders(groupId, parentFolderId, status, start, end);
102            }
103    
104            public static java.util.List<java.lang.Object> getFoldersAndEntries(
105                    long groupId, long folderId) {
106                    return getService().getFoldersAndEntries(groupId, folderId);
107            }
108    
109            public static java.util.List<java.lang.Object> getFoldersAndEntries(
110                    long groupId, long folderId, int status) {
111                    return getService().getFoldersAndEntries(groupId, folderId, status);
112            }
113    
114            public static java.util.List<java.lang.Object> getFoldersAndEntries(
115                    long groupId, long folderId, int status, int start, int end) {
116                    return getService()
117                                       .getFoldersAndEntries(groupId, folderId, status, start, end);
118            }
119    
120            public static int getFoldersAndEntriesCount(long groupId, long folderId) {
121                    return getService().getFoldersAndEntriesCount(groupId, folderId);
122            }
123    
124            public static int getFoldersAndEntriesCount(long groupId, long folderId,
125                    int status) {
126                    return getService().getFoldersAndEntriesCount(groupId, folderId, status);
127            }
128    
129            public static int getFoldersCount(long groupId, long parentFolderId) {
130                    return getService().getFoldersCount(groupId, parentFolderId);
131            }
132    
133            public static int getFoldersCount(long groupId, long parentFolderId,
134                    int status) {
135                    return getService().getFoldersCount(groupId, parentFolderId, status);
136            }
137    
138            /**
139            * @deprecated As of 7.0.0, replaced by {@link #getSubfolderIds(List, long,
140            long, boolean)}
141            */
142            @Deprecated
143            public static void getSubfolderIds(
144                    java.util.List<java.lang.Long> folderIds, long groupId, long folderId) {
145                    getService().getSubfolderIds(folderIds, groupId, folderId);
146            }
147    
148            public static void getSubfolderIds(
149                    java.util.List<java.lang.Long> folderIds, long groupId, long folderId,
150                    boolean recurse) {
151                    getService().getSubfolderIds(folderIds, groupId, folderId, recurse);
152            }
153    
154            public static java.util.List<java.lang.Long> getSubfolderIds(long groupId,
155                    long folderId, boolean recurse) {
156                    return getService().getSubfolderIds(groupId, folderId, recurse);
157            }
158    
159            public static com.liferay.portlet.bookmarks.model.BookmarksFolder moveFolder(
160                    long folderId, long parentFolderId)
161                    throws com.liferay.portal.kernel.exception.PortalException {
162                    return getService().moveFolder(folderId, parentFolderId);
163            }
164    
165            public static com.liferay.portlet.bookmarks.model.BookmarksFolder moveFolderFromTrash(
166                    long folderId, long parentFolderId)
167                    throws com.liferay.portal.kernel.exception.PortalException {
168                    return getService().moveFolderFromTrash(folderId, parentFolderId);
169            }
170    
171            public static com.liferay.portlet.bookmarks.model.BookmarksFolder moveFolderToTrash(
172                    long folderId)
173                    throws com.liferay.portal.kernel.exception.PortalException {
174                    return getService().moveFolderToTrash(folderId);
175            }
176    
177            public static void restoreFolderFromTrash(long folderId)
178                    throws com.liferay.portal.kernel.exception.PortalException {
179                    getService().restoreFolderFromTrash(folderId);
180            }
181    
182            /**
183            * Sets the Spring bean ID for this bean.
184            *
185            * @param beanIdentifier the Spring bean ID for this bean
186            */
187            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
188                    getService().setBeanIdentifier(beanIdentifier);
189            }
190    
191            public static void subscribeFolder(long groupId, long folderId)
192                    throws com.liferay.portal.kernel.exception.PortalException {
193                    getService().subscribeFolder(groupId, folderId);
194            }
195    
196            public static void unsubscribeFolder(long groupId, long folderId)
197                    throws com.liferay.portal.kernel.exception.PortalException {
198                    getService().unsubscribeFolder(groupId, folderId);
199            }
200    
201            public static com.liferay.portlet.bookmarks.model.BookmarksFolder updateFolder(
202                    long folderId, long parentFolderId, java.lang.String name,
203                    java.lang.String description, boolean mergeWithParentFolder,
204                    com.liferay.portal.service.ServiceContext serviceContext)
205                    throws com.liferay.portal.kernel.exception.PortalException {
206                    return getService()
207                                       .updateFolder(folderId, parentFolderId, name, description,
208                            mergeWithParentFolder, serviceContext);
209            }
210    
211            public static BookmarksFolderService getService() {
212                    if (_service == null) {
213                            _service = (BookmarksFolderService)PortalBeanLocatorUtil.locate(BookmarksFolderService.class.getName());
214    
215                            ReferenceRegistry.registerReference(BookmarksFolderServiceUtil.class,
216                                    "_service");
217                    }
218    
219                    return _service;
220            }
221    
222            /**
223             * @deprecated As of 6.2.0
224             */
225            @Deprecated
226            public void setService(BookmarksFolderService service) {
227            }
228    
229            private static BookmarksFolderService _service;
230    }