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.exception.PortalException;
020    import com.liferay.portal.kernel.exception.SystemException;
021    import com.liferay.portal.kernel.jsonwebservice.JSONWebService;
022    import com.liferay.portal.kernel.transaction.Isolation;
023    import com.liferay.portal.kernel.transaction.Propagation;
024    import com.liferay.portal.kernel.transaction.Transactional;
025    import com.liferay.portal.security.ac.AccessControlled;
026    import com.liferay.portal.service.BaseService;
027    
028    /**
029     * Provides the remote service interface for BookmarksFolder. Methods of this
030     * service are expected to have security checks based on the propagated JAAS
031     * credentials because this service can be accessed remotely.
032     *
033     * @author Brian Wing Shun Chan
034     * @see BookmarksFolderServiceUtil
035     * @see com.liferay.portlet.bookmarks.service.base.BookmarksFolderServiceBaseImpl
036     * @see com.liferay.portlet.bookmarks.service.impl.BookmarksFolderServiceImpl
037     * @generated
038     */
039    @AccessControlled
040    @JSONWebService
041    @ProviderType
042    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
043            PortalException.class, SystemException.class})
044    public interface BookmarksFolderService extends BaseService {
045            /*
046             * NOTE FOR DEVELOPERS:
047             *
048             * Never modify or reference this interface directly. Always use {@link BookmarksFolderServiceUtil} to access the bookmarks folder remote service. Add custom service methods to {@link com.liferay.portlet.bookmarks.service.impl.BookmarksFolderServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
049             */
050            public com.liferay.portlet.bookmarks.model.BookmarksFolder addFolder(
051                    long parentFolderId, java.lang.String name,
052                    java.lang.String description,
053                    com.liferay.portal.service.ServiceContext serviceContext)
054                    throws com.liferay.portal.kernel.exception.PortalException;
055    
056            public void deleteFolder(long folderId)
057                    throws com.liferay.portal.kernel.exception.PortalException;
058    
059            public void deleteFolder(long folderId, boolean includeTrashedEntries)
060                    throws com.liferay.portal.kernel.exception.PortalException;
061    
062            /**
063            * Returns the Spring bean ID for this bean.
064            *
065            * @return the Spring bean ID for this bean
066            */
067            public java.lang.String getBeanIdentifier();
068    
069            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
070            public com.liferay.portlet.bookmarks.model.BookmarksFolder getFolder(
071                    long folderId)
072                    throws com.liferay.portal.kernel.exception.PortalException;
073    
074            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
075            public java.util.List<java.lang.Long> getFolderIds(long groupId,
076                    long folderId)
077                    throws com.liferay.portal.kernel.exception.PortalException;
078    
079            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
080            public java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getFolders(
081                    long groupId);
082    
083            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
084            public java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getFolders(
085                    long groupId, long parentFolderId);
086    
087            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
088            public java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getFolders(
089                    long groupId, long parentFolderId, int start, int end);
090    
091            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
092            public java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getFolders(
093                    long groupId, long parentFolderId, int status, int start, int end);
094    
095            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
096            public java.util.List<java.lang.Object> getFoldersAndEntries(long groupId,
097                    long folderId);
098    
099            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
100            public java.util.List<java.lang.Object> getFoldersAndEntries(long groupId,
101                    long folderId, int status);
102    
103            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
104            public java.util.List<java.lang.Object> getFoldersAndEntries(long groupId,
105                    long folderId, int status, int start, int end);
106    
107            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
108            public int getFoldersAndEntriesCount(long groupId, long folderId);
109    
110            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
111            public int getFoldersAndEntriesCount(long groupId, long folderId, int status);
112    
113            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
114            public int getFoldersCount(long groupId, long parentFolderId);
115    
116            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
117            public int getFoldersCount(long groupId, long parentFolderId, int status);
118    
119            /**
120            * @deprecated As of 7.0.0, replaced by {@link #getSubfolderIds(List, long,
121            long, boolean)}
122            */
123            @java.lang.Deprecated
124            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
125            public void getSubfolderIds(java.util.List<java.lang.Long> folderIds,
126                    long groupId, long folderId);
127    
128            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
129            public void getSubfolderIds(java.util.List<java.lang.Long> folderIds,
130                    long groupId, long folderId, boolean recurse);
131    
132            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
133            public java.util.List<java.lang.Long> getSubfolderIds(long groupId,
134                    long folderId, boolean recurse);
135    
136            public com.liferay.portlet.bookmarks.model.BookmarksFolder moveFolder(
137                    long folderId, long parentFolderId)
138                    throws com.liferay.portal.kernel.exception.PortalException;
139    
140            public com.liferay.portlet.bookmarks.model.BookmarksFolder moveFolderFromTrash(
141                    long folderId, long parentFolderId)
142                    throws com.liferay.portal.kernel.exception.PortalException;
143    
144            public com.liferay.portlet.bookmarks.model.BookmarksFolder moveFolderToTrash(
145                    long folderId)
146                    throws com.liferay.portal.kernel.exception.PortalException;
147    
148            public void restoreFolderFromTrash(long folderId)
149                    throws com.liferay.portal.kernel.exception.PortalException;
150    
151            /**
152            * Sets the Spring bean ID for this bean.
153            *
154            * @param beanIdentifier the Spring bean ID for this bean
155            */
156            public void setBeanIdentifier(java.lang.String beanIdentifier);
157    
158            public void subscribeFolder(long groupId, long folderId)
159                    throws com.liferay.portal.kernel.exception.PortalException;
160    
161            public void unsubscribeFolder(long groupId, long folderId)
162                    throws com.liferay.portal.kernel.exception.PortalException;
163    
164            public com.liferay.portlet.bookmarks.model.BookmarksFolder updateFolder(
165                    long folderId, long parentFolderId, java.lang.String name,
166                    java.lang.String description, boolean mergeWithParentFolder,
167                    com.liferay.portal.service.ServiceContext serviceContext)
168                    throws com.liferay.portal.kernel.exception.PortalException;
169    }