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 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 As of 6.2.0, replaced by {@link #getFileShortcuts(long, long,
112            boolean, int)}
113            */
114            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
115            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileShortcut> getFileShortcuts(
116                    long groupId, long folderId, int status)
117                    throws com.liferay.portal.kernel.exception.SystemException;
118    
119            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
120            public int getFileShortcutsCount(long groupId, long folderId,
121                    boolean active, int status)
122                    throws com.liferay.portal.kernel.exception.SystemException;
123    
124            /**
125            * @deprecated As of 6.2.0, replaced by {@link #getFileShortcutsCount(long,
126            long, boolean, int)}
127            */
128            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
129            public int getFileShortcutsCount(long groupId, long folderId, int status)
130                    throws com.liferay.portal.kernel.exception.SystemException;
131    
132            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
133            public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getNoAssetFileEntries();
134    
135            public void moveFileEntry(
136                    com.liferay.portal.kernel.repository.model.FileEntry fileEntry)
137                    throws com.liferay.portal.kernel.exception.PortalException,
138                            com.liferay.portal.kernel.exception.SystemException;
139    
140            public com.liferay.portal.kernel.repository.model.FileEntry moveFileEntryFromTrash(
141                    long userId,
142                    com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
143                    long newFolderId,
144                    com.liferay.portal.service.ServiceContext serviceContext)
145                    throws com.liferay.portal.kernel.exception.PortalException,
146                            com.liferay.portal.kernel.exception.SystemException;
147    
148            /**
149            * Moves the file entry to the recycle bin.
150            *
151            * @param userId the primary key of the user moving the file entry
152            * @param fileEntry the file entry to be moved
153            * @return the moved file entry
154            * @throws PortalException if a user with the primary key could not be found
155            * @throws SystemException if a system exception occurred
156            */
157            public com.liferay.portal.kernel.repository.model.FileEntry moveFileEntryToTrash(
158                    long userId,
159                    com.liferay.portal.kernel.repository.model.FileEntry fileEntry)
160                    throws com.liferay.portal.kernel.exception.PortalException,
161                            com.liferay.portal.kernel.exception.SystemException;
162    
163            public com.liferay.portlet.documentlibrary.model.DLFileShortcut moveFileShortcutFromTrash(
164                    long userId,
165                    com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut,
166                    long newFolderId,
167                    com.liferay.portal.service.ServiceContext serviceContext)
168                    throws com.liferay.portal.kernel.exception.PortalException,
169                            com.liferay.portal.kernel.exception.SystemException;
170    
171            /**
172            * Moves the file shortcut to the recycle bin.
173            *
174            * @param userId the primary key of the user moving the file shortcut
175            * @param dlFileShortcut the file shortcut to be moved
176            * @return the moved file shortcut
177            * @throws PortalException if a user with the primary key could not be found
178            * @throws SystemException if a system exception occurred
179            */
180            public com.liferay.portlet.documentlibrary.model.DLFileShortcut moveFileShortcutToTrash(
181                    long userId,
182                    com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException;
185    
186            public void moveFolder(
187                    com.liferay.portal.kernel.repository.model.Folder folder)
188                    throws com.liferay.portal.kernel.exception.PortalException,
189                            com.liferay.portal.kernel.exception.SystemException;
190    
191            public com.liferay.portal.kernel.repository.model.Folder moveFolderFromTrash(
192                    long userId, com.liferay.portal.kernel.repository.model.Folder folder,
193                    long parentFolderId,
194                    com.liferay.portal.service.ServiceContext serviceContext)
195                    throws com.liferay.portal.kernel.exception.PortalException,
196                            com.liferay.portal.kernel.exception.SystemException;
197    
198            /**
199            * Moves the folder to the recycle bin.
200            *
201            * @param userId the primary key of the user moving the folder
202            * @param folder the folder to be moved
203            * @return the moved folder
204            * @throws PortalException if a user with the primary key could not be found
205            * @throws SystemException if a system exception occurred
206            */
207            public com.liferay.portal.kernel.repository.model.Folder moveFolderToTrash(
208                    long userId, com.liferay.portal.kernel.repository.model.Folder folder)
209                    throws com.liferay.portal.kernel.exception.PortalException,
210                            com.liferay.portal.kernel.exception.SystemException;
211    
212            public void restoreFileEntryFromTrash(long userId,
213                    com.liferay.portal.kernel.repository.model.FileEntry fileEntry)
214                    throws com.liferay.portal.kernel.exception.PortalException,
215                            com.liferay.portal.kernel.exception.SystemException;
216    
217            public void restoreFileShortcutFromTrash(long userId,
218                    com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut)
219                    throws com.liferay.portal.kernel.exception.PortalException,
220                            com.liferay.portal.kernel.exception.SystemException;
221    
222            public void restoreFolderFromTrash(long userId,
223                    com.liferay.portal.kernel.repository.model.Folder folder)
224                    throws com.liferay.portal.kernel.exception.PortalException,
225                            com.liferay.portal.kernel.exception.SystemException;
226    
227            public com.liferay.portlet.asset.model.AssetEntry updateAsset(long userId,
228                    com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
229                    com.liferay.portal.kernel.repository.model.FileVersion fileVersion,
230                    long assetClassPk)
231                    throws com.liferay.portal.kernel.exception.PortalException,
232                            com.liferay.portal.kernel.exception.SystemException;
233    
234            public com.liferay.portlet.asset.model.AssetEntry updateAsset(long userId,
235                    com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
236                    com.liferay.portal.kernel.repository.model.FileVersion fileVersion,
237                    long[] assetCategoryIds, java.lang.String[] assetTagNames,
238                    long[] assetLinkEntryIds)
239                    throws com.liferay.portal.kernel.exception.PortalException,
240                            com.liferay.portal.kernel.exception.SystemException;
241    
242            public com.liferay.portlet.asset.model.AssetEntry updateAsset(long userId,
243                    com.liferay.portal.kernel.repository.model.Folder folder,
244                    long[] assetCategoryIds, java.lang.String[] assetTagNames,
245                    long[] assetLinkEntryIds)
246                    throws com.liferay.portal.kernel.exception.PortalException,
247                            com.liferay.portal.kernel.exception.SystemException;
248    
249            public void updateDependentStatus(com.liferay.portal.model.User user,
250                    java.util.List<java.lang.Object> dlFileEntriesAndDLFolders, int status)
251                    throws com.liferay.portal.kernel.exception.PortalException,
252                            com.liferay.portal.kernel.exception.SystemException;
253    
254            public void updateFileEntry(long userId,
255                    com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
256                    com.liferay.portal.kernel.repository.model.FileVersion sourceFileVersion,
257                    com.liferay.portal.kernel.repository.model.FileVersion destinationFileVersion,
258                    long assetClassPk)
259                    throws com.liferay.portal.kernel.exception.PortalException,
260                            com.liferay.portal.kernel.exception.SystemException;
261    
262            public void updateFileEntry(long userId,
263                    com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
264                    com.liferay.portal.kernel.repository.model.FileVersion sourceFileVersion,
265                    com.liferay.portal.kernel.repository.model.FileVersion destinationFileVersion,
266                    com.liferay.portal.service.ServiceContext serviceContext)
267                    throws com.liferay.portal.kernel.exception.PortalException,
268                            com.liferay.portal.kernel.exception.SystemException;
269    
270            public void updateFolder(long userId,
271                    com.liferay.portal.kernel.repository.model.Folder folder,
272                    com.liferay.portal.service.ServiceContext serviceContext)
273                    throws com.liferay.portal.kernel.exception.PortalException,
274                            com.liferay.portal.kernel.exception.SystemException;
275    
276            public void updateStatus(long userId,
277                    com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
278                    com.liferay.portal.kernel.repository.model.FileVersion latestFileVersion,
279                    int oldStatus, int newStatus,
280                    java.util.Map<java.lang.String, java.io.Serializable> workflowContext,
281                    com.liferay.portal.service.ServiceContext serviceContext)
282                    throws com.liferay.portal.kernel.exception.PortalException,
283                            com.liferay.portal.kernel.exception.SystemException;
284    }