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