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