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.documentlibrary.service;
016    
017    import com.liferay.portal.kernel.exception.PortalException;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.kernel.transaction.Isolation;
020    import com.liferay.portal.kernel.transaction.Propagation;
021    import com.liferay.portal.kernel.transaction.Transactional;
022    import com.liferay.portal.service.BaseLocalService;
023    
024    /**
025     * The interface for the d l app helper local service.
026     *
027     * <p>
028     * 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.
029     * </p>
030     *
031     * @author Brian Wing Shun Chan
032     * @see DLAppHelperLocalServiceUtil
033     * @see com.liferay.portlet.documentlibrary.service.base.DLAppHelperLocalServiceBaseImpl
034     * @see com.liferay.portlet.documentlibrary.service.impl.DLAppHelperLocalServiceImpl
035     * @generated
036     */
037    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
038            PortalException.class, SystemException.class})
039    public interface DLAppHelperLocalService extends BaseLocalService {
040            /*
041             * NOTE FOR DEVELOPERS:
042             *
043             * Never modify or reference this interface directly. Always use {@link DLAppHelperLocalServiceUtil} to access the d l app helper local service. Add custom service methods to {@link com.liferay.portlet.documentlibrary.service.impl.DLAppHelperLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
044             */
045    
046            /**
047            * Returns the Spring bean ID for this bean.
048            *
049            * @return the Spring bean ID for this bean
050            */
051            public java.lang.String getBeanIdentifier();
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 void setBeanIdentifier(java.lang.String beanIdentifier);
059    
060            public void addFileEntry(long userId,
061                    com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
062                    com.liferay.portal.kernel.repository.model.FileVersion fileVersion,
063                    com.liferay.portal.service.ServiceContext serviceContext)
064                    throws com.liferay.portal.kernel.exception.PortalException,
065                            com.liferay.portal.kernel.exception.SystemException;
066    
067            public void addFolder(long userId,
068                    com.liferay.portal.kernel.repository.model.Folder folder,
069                    com.liferay.portal.service.ServiceContext serviceContext)
070                    throws com.liferay.portal.kernel.exception.PortalException,
071                            com.liferay.portal.kernel.exception.SystemException;
072    
073            public void cancelCheckOut(long userId,
074                    com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
075                    com.liferay.portal.kernel.repository.model.FileVersion sourceFileVersion,
076                    com.liferay.portal.kernel.repository.model.FileVersion destinationFileVersion,
077                    com.liferay.portal.kernel.repository.model.FileVersion draftFileVersion,
078                    com.liferay.portal.service.ServiceContext serviceContext)
079                    throws com.liferay.portal.kernel.exception.PortalException,
080                            com.liferay.portal.kernel.exception.SystemException;
081    
082            public void checkAssetEntry(long userId,
083                    com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
084                    com.liferay.portal.kernel.repository.model.FileVersion fileVersion)
085                    throws com.liferay.portal.kernel.exception.PortalException,
086                            com.liferay.portal.kernel.exception.SystemException;
087    
088            public void deleteFileEntry(
089                    com.liferay.portal.kernel.repository.model.FileEntry fileEntry)
090                    throws com.liferay.portal.kernel.exception.PortalException,
091                            com.liferay.portal.kernel.exception.SystemException;
092    
093            public void deleteFolder(
094                    com.liferay.portal.kernel.repository.model.Folder folder)
095                    throws com.liferay.portal.kernel.exception.PortalException,
096                            com.liferay.portal.kernel.exception.SystemException;
097    
098            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
099            public void getFileAsStream(long userId,
100                    com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
101                    boolean incrementCounter)
102                    throws com.liferay.portal.kernel.exception.PortalException,
103                            com.liferay.portal.kernel.exception.SystemException;
104    
105            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
106            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileShortcut> getFileShortcuts(
107                    long groupId, long folderId, boolean active, int status)
108                    throws com.liferay.portal.kernel.exception.SystemException;
109    
110            /**
111            * @deprecated {@link #getFileShortcuts(long, long, boolean, int)}
112            */
113            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
114            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileShortcut> getFileShortcuts(
115                    long groupId, long folderId, int status)
116                    throws com.liferay.portal.kernel.exception.SystemException;
117    
118            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
119            public int getFileShortcutsCount(long groupId, long folderId,
120                    boolean active, int status)
121                    throws com.liferay.portal.kernel.exception.SystemException;
122    
123            /**
124            * @deprecated {@link #getFileShortcutsCount(long, long, boolean, int)}
125            */
126            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
127            public int getFileShortcutsCount(long groupId, long folderId, int status)
128                    throws com.liferay.portal.kernel.exception.SystemException;
129    
130            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
131            public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getNoAssetFileEntries();
132    
133            public void moveFileEntry(
134                    com.liferay.portal.kernel.repository.model.FileEntry fileEntry)
135                    throws com.liferay.portal.kernel.exception.PortalException,
136                            com.liferay.portal.kernel.exception.SystemException;
137    
138            public com.liferay.portal.kernel.repository.model.FileEntry moveFileEntryFromTrash(
139                    long userId,
140                    com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
141                    long newFolderId,
142                    com.liferay.portal.service.ServiceContext serviceContext)
143                    throws com.liferay.portal.kernel.exception.PortalException,
144                            com.liferay.portal.kernel.exception.SystemException;
145    
146            /**
147            * Moves the file entry to the recycle bin.
148            *
149            * @param userId the primary key of the user moving the file entry
150            * @param fileEntry the file entry to be moved
151            * @return the moved file entry
152            * @throws PortalException if a user with the primary key could not be found
153            * @throws SystemException if a system exception occurred
154            */
155            public com.liferay.portal.kernel.repository.model.FileEntry moveFileEntryToTrash(
156                    long userId,
157                    com.liferay.portal.kernel.repository.model.FileEntry fileEntry)
158                    throws com.liferay.portal.kernel.exception.PortalException,
159                            com.liferay.portal.kernel.exception.SystemException;
160    
161            public com.liferay.portlet.documentlibrary.model.DLFileShortcut moveFileShortcutFromTrash(
162                    long userId,
163                    com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut,
164                    long newFolderId,
165                    com.liferay.portal.service.ServiceContext serviceContext)
166                    throws com.liferay.portal.kernel.exception.PortalException,
167                            com.liferay.portal.kernel.exception.SystemException;
168    
169            /**
170            * Moves the file shortcut to the recycle bin.
171            *
172            * @param userId the primary key of the user moving the file shortcut
173            * @param dlFileShortcut the file shortcut to be moved
174            * @return the moved file shortcut
175            * @throws PortalException if a user with the primary key could not be found
176            * @throws SystemException if a system exception occurred
177            */
178            public com.liferay.portlet.documentlibrary.model.DLFileShortcut moveFileShortcutToTrash(
179                    long userId,
180                    com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut)
181                    throws com.liferay.portal.kernel.exception.PortalException,
182                            com.liferay.portal.kernel.exception.SystemException;
183    
184            public void moveFolder(
185                    com.liferay.portal.kernel.repository.model.Folder folder)
186                    throws com.liferay.portal.kernel.exception.PortalException,
187                            com.liferay.portal.kernel.exception.SystemException;
188    
189            public com.liferay.portal.kernel.repository.model.Folder moveFolderFromTrash(
190                    long userId, com.liferay.portal.kernel.repository.model.Folder folder,
191                    long parentFolderId,
192                    com.liferay.portal.service.ServiceContext serviceContext)
193                    throws com.liferay.portal.kernel.exception.PortalException,
194                            com.liferay.portal.kernel.exception.SystemException;
195    
196            /**
197            * Moves the folder to the recycle bin.
198            *
199            * @param userId the primary key of the user moving the folder
200            * @param folder the folder to be moved
201            * @return the moved folder
202            * @throws PortalException if a user with the primary key could not be found
203            * @throws SystemException if a system exception occurred
204            */
205            public com.liferay.portal.kernel.repository.model.Folder moveFolderToTrash(
206                    long userId, com.liferay.portal.kernel.repository.model.Folder folder)
207                    throws com.liferay.portal.kernel.exception.PortalException,
208                            com.liferay.portal.kernel.exception.SystemException;
209    
210            public void restoreFileEntryFromTrash(long userId,
211                    com.liferay.portal.kernel.repository.model.FileEntry fileEntry)
212                    throws com.liferay.portal.kernel.exception.PortalException,
213                            com.liferay.portal.kernel.exception.SystemException;
214    
215            public void restoreFileShortcutFromTrash(long userId,
216                    com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut)
217                    throws com.liferay.portal.kernel.exception.PortalException,
218                            com.liferay.portal.kernel.exception.SystemException;
219    
220            public void restoreFolderFromTrash(long userId,
221                    com.liferay.portal.kernel.repository.model.Folder folder)
222                    throws com.liferay.portal.kernel.exception.PortalException,
223                            com.liferay.portal.kernel.exception.SystemException;
224    
225            public com.liferay.portlet.asset.model.AssetEntry updateAsset(long userId,
226                    com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
227                    com.liferay.portal.kernel.repository.model.FileVersion fileVersion,
228                    long assetClassPk)
229                    throws com.liferay.portal.kernel.exception.PortalException,
230                            com.liferay.portal.kernel.exception.SystemException;
231    
232            public com.liferay.portlet.asset.model.AssetEntry updateAsset(long userId,
233                    com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
234                    com.liferay.portal.kernel.repository.model.FileVersion fileVersion,
235                    long[] assetCategoryIds, java.lang.String[] assetTagNames,
236                    long[] assetLinkEntryIds)
237                    throws com.liferay.portal.kernel.exception.PortalException,
238                            com.liferay.portal.kernel.exception.SystemException;
239    
240            public com.liferay.portlet.asset.model.AssetEntry updateAsset(long userId,
241                    com.liferay.portal.kernel.repository.model.Folder folder,
242                    long[] assetCategoryIds, java.lang.String[] assetTagNames,
243                    long[] assetLinkEntryIds)
244                    throws com.liferay.portal.kernel.exception.PortalException,
245                            com.liferay.portal.kernel.exception.SystemException;
246    
247            public void updateDependentStatus(com.liferay.portal.model.User user,
248                    java.util.List<java.lang.Object> dlFileEntriesAndDLFolders, int status)
249                    throws com.liferay.portal.kernel.exception.PortalException,
250                            com.liferay.portal.kernel.exception.SystemException;
251    
252            public void updateFileEntry(long userId,
253                    com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
254                    com.liferay.portal.kernel.repository.model.FileVersion sourceFileVersion,
255                    com.liferay.portal.kernel.repository.model.FileVersion destinationFileVersion,
256                    long assetClassPk)
257                    throws com.liferay.portal.kernel.exception.PortalException,
258                            com.liferay.portal.kernel.exception.SystemException;
259    
260            public void updateFileEntry(long userId,
261                    com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
262                    com.liferay.portal.kernel.repository.model.FileVersion sourceFileVersion,
263                    com.liferay.portal.kernel.repository.model.FileVersion destinationFileVersion,
264                    com.liferay.portal.service.ServiceContext serviceContext)
265                    throws com.liferay.portal.kernel.exception.PortalException,
266                            com.liferay.portal.kernel.exception.SystemException;
267    
268            public void updateFolder(long userId,
269                    com.liferay.portal.kernel.repository.model.Folder folder,
270                    com.liferay.portal.service.ServiceContext serviceContext)
271                    throws com.liferay.portal.kernel.exception.PortalException,
272                            com.liferay.portal.kernel.exception.SystemException;
273    
274            public void updateStatus(long userId,
275                    com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
276                    com.liferay.portal.kernel.repository.model.FileVersion latestFileVersion,
277                    int oldStatus, int newStatus,
278                    java.util.Map<java.lang.String, java.io.Serializable> workflowContext,
279                    com.liferay.portal.service.ServiceContext serviceContext)
280                    throws com.liferay.portal.kernel.exception.PortalException,
281                            com.liferay.portal.kernel.exception.SystemException;
282    }