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