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     * Provides the local service interface for DLAppHelper. Methods of this
026     * service will not have security checks based on the propagated JAAS
027     * credentials because this service can only be accessed from within the same
028     * VM.
029     *
030     * @author Brian Wing Shun Chan
031     * @see DLAppHelperLocalServiceUtil
032     * @see com.liferay.portlet.documentlibrary.service.base.DLAppHelperLocalServiceBaseImpl
033     * @see com.liferay.portlet.documentlibrary.service.impl.DLAppHelperLocalServiceImpl
034     * @generated
035     */
036    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
037            PortalException.class, SystemException.class})
038    public interface DLAppHelperLocalService extends BaseLocalService {
039            /*
040             * NOTE FOR DEVELOPERS:
041             *
042             * 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.
043             */
044    
045            /**
046            * Returns the Spring bean ID for this bean.
047            *
048            * @return the Spring bean ID for this bean
049            */
050            public java.lang.String getBeanIdentifier();
051    
052            /**
053            * Sets the Spring bean ID for this bean.
054            *
055            * @param beanIdentifier the Spring bean ID for this bean
056            */
057            public void setBeanIdentifier(java.lang.String beanIdentifier);
058    
059            public void addFileEntry(long userId,
060                    com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
061                    com.liferay.portal.kernel.repository.model.FileVersion fileVersion,
062                    com.liferay.portal.service.ServiceContext serviceContext)
063                    throws com.liferay.portal.kernel.exception.PortalException,
064                            com.liferay.portal.kernel.exception.SystemException;
065    
066            public void addFolder(long userId,
067                    com.liferay.portal.kernel.repository.model.Folder folder,
068                    com.liferay.portal.service.ServiceContext serviceContext)
069                    throws com.liferay.portal.kernel.exception.PortalException,
070                            com.liferay.portal.kernel.exception.SystemException;
071    
072            public void cancelCheckOut(long userId,
073                    com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
074                    com.liferay.portal.kernel.repository.model.FileVersion sourceFileVersion,
075                    com.liferay.portal.kernel.repository.model.FileVersion destinationFileVersion,
076                    com.liferay.portal.kernel.repository.model.FileVersion draftFileVersion,
077                    com.liferay.portal.service.ServiceContext serviceContext)
078                    throws com.liferay.portal.kernel.exception.PortalException,
079                            com.liferay.portal.kernel.exception.SystemException;
080    
081            public void checkAssetEntry(long userId,
082                    com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
083                    com.liferay.portal.kernel.repository.model.FileVersion fileVersion)
084                    throws com.liferay.portal.kernel.exception.PortalException,
085                            com.liferay.portal.kernel.exception.SystemException;
086    
087            public void deleteFileEntry(
088                    com.liferay.portal.kernel.repository.model.FileEntry fileEntry)
089                    throws com.liferay.portal.kernel.exception.PortalException,
090                            com.liferay.portal.kernel.exception.SystemException;
091    
092            public void deleteFolder(
093                    com.liferay.portal.kernel.repository.model.Folder folder)
094                    throws com.liferay.portal.kernel.exception.PortalException,
095                            com.liferay.portal.kernel.exception.SystemException;
096    
097            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
098            public void getFileAsStream(long userId,
099                    com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
100                    boolean incrementCounter)
101                    throws com.liferay.portal.kernel.exception.SystemException;
102    
103            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
104            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileShortcut> getFileShortcuts(
105                    long groupId, long folderId, boolean active, int status)
106                    throws com.liferay.portal.kernel.exception.SystemException;
107    
108            /**
109            * @deprecated As of 6.2.0, replaced by {@link #getFileShortcuts(long, long,
110            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 As of 6.2.0, replaced by {@link #getFileShortcutsCount(long,
124            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.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 registerDLSyncEventCallback(java.lang.String event,
210                    java.lang.String type, long typePK)
211                    throws com.liferay.portal.kernel.exception.SystemException;
212    
213            public void restoreFileEntryFromTrash(long userId,
214                    com.liferay.portal.kernel.repository.model.FileEntry fileEntry)
215                    throws com.liferay.portal.kernel.exception.PortalException,
216                            com.liferay.portal.kernel.exception.SystemException;
217    
218            public void restoreFileShortcutFromTrash(long userId,
219                    com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut)
220                    throws com.liferay.portal.kernel.exception.PortalException,
221                            com.liferay.portal.kernel.exception.SystemException;
222    
223            public void restoreFolderFromTrash(long userId,
224                    com.liferay.portal.kernel.repository.model.Folder folder)
225                    throws com.liferay.portal.kernel.exception.PortalException,
226                            com.liferay.portal.kernel.exception.SystemException;
227    
228            public com.liferay.portlet.asset.model.AssetEntry updateAsset(long userId,
229                    com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
230                    com.liferay.portal.kernel.repository.model.FileVersion fileVersion,
231                    long assetClassPk)
232                    throws com.liferay.portal.kernel.exception.PortalException,
233                            com.liferay.portal.kernel.exception.SystemException;
234    
235            public com.liferay.portlet.asset.model.AssetEntry updateAsset(long userId,
236                    com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
237                    com.liferay.portal.kernel.repository.model.FileVersion fileVersion,
238                    long[] assetCategoryIds, java.lang.String[] assetTagNames,
239                    long[] assetLinkEntryIds)
240                    throws com.liferay.portal.kernel.exception.PortalException,
241                            com.liferay.portal.kernel.exception.SystemException;
242    
243            public com.liferay.portlet.asset.model.AssetEntry updateAsset(long userId,
244                    com.liferay.portal.kernel.repository.model.Folder folder,
245                    long[] assetCategoryIds, java.lang.String[] assetTagNames,
246                    long[] assetLinkEntryIds)
247                    throws com.liferay.portal.kernel.exception.PortalException,
248                            com.liferay.portal.kernel.exception.SystemException;
249    
250            public void updateDependentStatus(com.liferay.portal.model.User user,
251                    java.util.List<java.lang.Object> dlFileEntriesAndDLFolders, int status)
252                    throws com.liferay.portal.kernel.exception.PortalException,
253                            com.liferay.portal.kernel.exception.SystemException;
254    
255            public void updateFileEntry(long userId,
256                    com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
257                    com.liferay.portal.kernel.repository.model.FileVersion sourceFileVersion,
258                    com.liferay.portal.kernel.repository.model.FileVersion destinationFileVersion,
259                    long assetClassPk)
260                    throws com.liferay.portal.kernel.exception.PortalException,
261                            com.liferay.portal.kernel.exception.SystemException;
262    
263            public void updateFileEntry(long userId,
264                    com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
265                    com.liferay.portal.kernel.repository.model.FileVersion sourceFileVersion,
266                    com.liferay.portal.kernel.repository.model.FileVersion destinationFileVersion,
267                    com.liferay.portal.service.ServiceContext serviceContext)
268                    throws com.liferay.portal.kernel.exception.PortalException,
269                            com.liferay.portal.kernel.exception.SystemException;
270    
271            public void updateFolder(long userId,
272                    com.liferay.portal.kernel.repository.model.Folder folder,
273                    com.liferay.portal.service.ServiceContext serviceContext)
274                    throws com.liferay.portal.kernel.exception.PortalException,
275                            com.liferay.portal.kernel.exception.SystemException;
276    
277            public void updateStatus(long userId,
278                    com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
279                    com.liferay.portal.kernel.repository.model.FileVersion latestFileVersion,
280                    int oldStatus, int newStatus,
281                    java.util.Map<java.lang.String, java.io.Serializable> workflowContext,
282                    com.liferay.portal.service.ServiceContext serviceContext)
283                    throws com.liferay.portal.kernel.exception.PortalException,
284                            com.liferay.portal.kernel.exception.SystemException;
285    }