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    import com.liferay.portal.service.PersistedModelLocalService;
024    
025    /**
026     * The interface for the document library folder local service.
027     *
028     * <p>
029     * 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.
030     * </p>
031     *
032     * @author Brian Wing Shun Chan
033     * @see DLFolderLocalServiceUtil
034     * @see com.liferay.portlet.documentlibrary.service.base.DLFolderLocalServiceBaseImpl
035     * @see com.liferay.portlet.documentlibrary.service.impl.DLFolderLocalServiceImpl
036     * @generated
037     */
038    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
039            PortalException.class, SystemException.class})
040    public interface DLFolderLocalService extends BaseLocalService,
041            PersistedModelLocalService {
042            /*
043             * NOTE FOR DEVELOPERS:
044             *
045             * Never modify or reference this interface directly. Always use {@link DLFolderLocalServiceUtil} to access the document library folder local service. Add custom service methods to {@link com.liferay.portlet.documentlibrary.service.impl.DLFolderLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
046             */
047    
048            /**
049            * Adds the document library folder to the database. Also notifies the appropriate model listeners.
050            *
051            * @param dlFolder the document library folder
052            * @return the document library folder that was added
053            * @throws SystemException if a system exception occurred
054            */
055            public com.liferay.portlet.documentlibrary.model.DLFolder addDLFolder(
056                    com.liferay.portlet.documentlibrary.model.DLFolder dlFolder)
057                    throws com.liferay.portal.kernel.exception.SystemException;
058    
059            /**
060            * Creates a new document library folder with the primary key. Does not add the document library folder to the database.
061            *
062            * @param folderId the primary key for the new document library folder
063            * @return the new document library folder
064            */
065            public com.liferay.portlet.documentlibrary.model.DLFolder createDLFolder(
066                    long folderId);
067    
068            /**
069            * Deletes the document library folder with the primary key from the database. Also notifies the appropriate model listeners.
070            *
071            * @param folderId the primary key of the document library folder
072            * @return the document library folder that was removed
073            * @throws PortalException if a document library folder with the primary key could not be found
074            * @throws SystemException if a system exception occurred
075            */
076            public com.liferay.portlet.documentlibrary.model.DLFolder deleteDLFolder(
077                    long folderId)
078                    throws com.liferay.portal.kernel.exception.PortalException,
079                            com.liferay.portal.kernel.exception.SystemException;
080    
081            /**
082            * Deletes the document library folder from the database. Also notifies the appropriate model listeners.
083            *
084            * @param dlFolder the document library folder
085            * @return the document library folder that was removed
086            * @throws SystemException if a system exception occurred
087            */
088            public com.liferay.portlet.documentlibrary.model.DLFolder deleteDLFolder(
089                    com.liferay.portlet.documentlibrary.model.DLFolder dlFolder)
090                    throws com.liferay.portal.kernel.exception.SystemException;
091    
092            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
093    
094            /**
095            * Performs a dynamic query on the database and returns the matching rows.
096            *
097            * @param dynamicQuery the dynamic query
098            * @return the matching rows
099            * @throws SystemException if a system exception occurred
100            */
101            @SuppressWarnings("rawtypes")
102            public java.util.List dynamicQuery(
103                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
104                    throws com.liferay.portal.kernel.exception.SystemException;
105    
106            /**
107            * Performs a dynamic query on the database and returns a range of the matching rows.
108            *
109            * <p>
110            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
111            * </p>
112            *
113            * @param dynamicQuery the dynamic query
114            * @param start the lower bound of the range of model instances
115            * @param end the upper bound of the range of model instances (not inclusive)
116            * @return the range of matching rows
117            * @throws SystemException if a system exception occurred
118            */
119            @SuppressWarnings("rawtypes")
120            public java.util.List dynamicQuery(
121                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
122                    int end) throws com.liferay.portal.kernel.exception.SystemException;
123    
124            /**
125            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
126            *
127            * <p>
128            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
129            * </p>
130            *
131            * @param dynamicQuery the dynamic query
132            * @param start the lower bound of the range of model instances
133            * @param end the upper bound of the range of model instances (not inclusive)
134            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
135            * @return the ordered range of matching rows
136            * @throws SystemException if a system exception occurred
137            */
138            @SuppressWarnings("rawtypes")
139            public java.util.List dynamicQuery(
140                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
141                    int end,
142                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
143                    throws com.liferay.portal.kernel.exception.SystemException;
144    
145            /**
146            * Returns the number of rows that match the dynamic query.
147            *
148            * @param dynamicQuery the dynamic query
149            * @return the number of rows that match the dynamic query
150            * @throws SystemException if a system exception occurred
151            */
152            public long dynamicQueryCount(
153                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
154                    throws com.liferay.portal.kernel.exception.SystemException;
155    
156            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
157            public com.liferay.portlet.documentlibrary.model.DLFolder fetchDLFolder(
158                    long folderId)
159                    throws com.liferay.portal.kernel.exception.SystemException;
160    
161            /**
162            * Returns the document library folder with the primary key.
163            *
164            * @param folderId the primary key of the document library folder
165            * @return the document library folder
166            * @throws PortalException if a document library folder with the primary key could not be found
167            * @throws SystemException if a system exception occurred
168            */
169            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
170            public com.liferay.portlet.documentlibrary.model.DLFolder getDLFolder(
171                    long folderId)
172                    throws com.liferay.portal.kernel.exception.PortalException,
173                            com.liferay.portal.kernel.exception.SystemException;
174    
175            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
176            public com.liferay.portal.model.PersistedModel getPersistedModel(
177                    java.io.Serializable primaryKeyObj)
178                    throws com.liferay.portal.kernel.exception.PortalException,
179                            com.liferay.portal.kernel.exception.SystemException;
180    
181            /**
182            * Returns the document library folder with the UUID in the group.
183            *
184            * @param uuid the UUID of document library folder
185            * @param groupId the group id of the document library folder
186            * @return the document library folder
187            * @throws PortalException if a document library folder with the UUID in the group could not be found
188            * @throws SystemException if a system exception occurred
189            */
190            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
191            public com.liferay.portlet.documentlibrary.model.DLFolder getDLFolderByUuidAndGroupId(
192                    java.lang.String uuid, long groupId)
193                    throws com.liferay.portal.kernel.exception.PortalException,
194                            com.liferay.portal.kernel.exception.SystemException;
195    
196            /**
197            * Returns a range of all the document library folders.
198            *
199            * <p>
200            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
201            * </p>
202            *
203            * @param start the lower bound of the range of document library folders
204            * @param end the upper bound of the range of document library folders (not inclusive)
205            * @return the range of document library folders
206            * @throws SystemException if a system exception occurred
207            */
208            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
209            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getDLFolders(
210                    int start, int end)
211                    throws com.liferay.portal.kernel.exception.SystemException;
212    
213            /**
214            * Returns the number of document library folders.
215            *
216            * @return the number of document library folders
217            * @throws SystemException if a system exception occurred
218            */
219            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
220            public int getDLFoldersCount()
221                    throws com.liferay.portal.kernel.exception.SystemException;
222    
223            /**
224            * Updates the document library folder in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
225            *
226            * @param dlFolder the document library folder
227            * @return the document library folder that was updated
228            * @throws SystemException if a system exception occurred
229            */
230            public com.liferay.portlet.documentlibrary.model.DLFolder updateDLFolder(
231                    com.liferay.portlet.documentlibrary.model.DLFolder dlFolder)
232                    throws com.liferay.portal.kernel.exception.SystemException;
233    
234            /**
235            * Returns the Spring bean ID for this bean.
236            *
237            * @return the Spring bean ID for this bean
238            */
239            public java.lang.String getBeanIdentifier();
240    
241            /**
242            * Sets the Spring bean ID for this bean.
243            *
244            * @param beanIdentifier the Spring bean ID for this bean
245            */
246            public void setBeanIdentifier(java.lang.String beanIdentifier);
247    
248            public com.liferay.portlet.documentlibrary.model.DLFolder addFolder(
249                    long userId, long groupId, long repositoryId, boolean mountPoint,
250                    long parentFolderId, java.lang.String name,
251                    java.lang.String description, boolean hidden,
252                    com.liferay.portal.service.ServiceContext serviceContext)
253                    throws com.liferay.portal.kernel.exception.PortalException,
254                            com.liferay.portal.kernel.exception.SystemException;
255    
256            /**
257            * @deprecated As of 6.2, replaced by more general {@link #addFolder(long,
258            long, long, boolean, long, String, String, boolean,
259            ServiceContext)}
260            */
261            public com.liferay.portlet.documentlibrary.model.DLFolder addFolder(
262                    long userId, long groupId, long repositoryId, boolean mountPoint,
263                    long parentFolderId, java.lang.String name,
264                    java.lang.String description,
265                    com.liferay.portal.service.ServiceContext serviceContext)
266                    throws com.liferay.portal.kernel.exception.PortalException,
267                            com.liferay.portal.kernel.exception.SystemException;
268    
269            public void deleteAll(long groupId)
270                    throws com.liferay.portal.kernel.exception.PortalException,
271                            com.liferay.portal.kernel.exception.SystemException;
272    
273            public void deleteFolder(long folderId)
274                    throws com.liferay.portal.kernel.exception.PortalException,
275                            com.liferay.portal.kernel.exception.SystemException;
276    
277            public void deleteFolder(long folderId, boolean includeTrashedEntries)
278                    throws com.liferay.portal.kernel.exception.PortalException,
279                            com.liferay.portal.kernel.exception.SystemException;
280    
281            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
282            public com.liferay.portlet.documentlibrary.model.DLFolder fetchFolder(
283                    long groupId, long parentFolderId, java.lang.String name)
284                    throws com.liferay.portal.kernel.exception.SystemException;
285    
286            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
287            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getCompanyFolders(
288                    long companyId, int start, int end)
289                    throws com.liferay.portal.kernel.exception.SystemException;
290    
291            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
292            public int getCompanyFoldersCount(long companyId)
293                    throws com.liferay.portal.kernel.exception.SystemException;
294    
295            /**
296            * @deprecated Replaced by {@link #getFileEntriesAndFileShortcuts(long,
297            long, QueryDefinition)}
298            */
299            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
300            public java.util.List<java.lang.Object> getFileEntriesAndFileShortcuts(
301                    long groupId, long folderId, int status, int start, int end)
302                    throws com.liferay.portal.kernel.exception.SystemException;
303    
304            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
305            public java.util.List<java.lang.Object> getFileEntriesAndFileShortcuts(
306                    long groupId, long folderId,
307                    com.liferay.portal.kernel.dao.orm.QueryDefinition queryDefinition)
308                    throws com.liferay.portal.kernel.exception.SystemException;
309    
310            /**
311            * @deprecated Replaced by {@link #getFileEntriesAndFileShortcutsCount(long,
312            long, QueryDefinition)}
313            */
314            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
315            public int getFileEntriesAndFileShortcutsCount(long groupId, long folderId,
316                    int status) throws com.liferay.portal.kernel.exception.SystemException;
317    
318            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
319            public int getFileEntriesAndFileShortcutsCount(long groupId, long folderId,
320                    com.liferay.portal.kernel.dao.orm.QueryDefinition queryDefinition)
321                    throws com.liferay.portal.kernel.exception.SystemException;
322    
323            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
324            public com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
325                    long folderId)
326                    throws com.liferay.portal.kernel.exception.PortalException,
327                            com.liferay.portal.kernel.exception.SystemException;
328    
329            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
330            public com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
331                    long groupId, long parentFolderId, java.lang.String name)
332                    throws com.liferay.portal.kernel.exception.PortalException,
333                            com.liferay.portal.kernel.exception.SystemException;
334    
335            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
336            public long getFolderId(long companyId, long folderId)
337                    throws com.liferay.portal.kernel.exception.SystemException;
338    
339            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
340            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
341                    long groupId, long parentFolderId)
342                    throws com.liferay.portal.kernel.exception.SystemException;
343    
344            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
345            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
346                    long groupId, long parentFolderId, boolean includeMountfolders)
347                    throws com.liferay.portal.kernel.exception.SystemException;
348    
349            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
350            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
351                    long groupId, long parentFolderId, boolean includeMountfolders,
352                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
353                    throws com.liferay.portal.kernel.exception.SystemException;
354    
355            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
356            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
357                    long groupId, long parentFolderId, int start, int end,
358                    com.liferay.portal.kernel.util.OrderByComparator obc)
359                    throws com.liferay.portal.kernel.exception.SystemException;
360    
361            /**
362            * @deprecated Replaced by {@link
363            #getFoldersAndFileEntriesAndFileShortcuts(long, long,
364            String[], boolean, QueryDefinition)}
365            */
366            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
367            public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(
368                    long groupId, long folderId, int status, boolean includeMountFolders,
369                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
370                    throws com.liferay.portal.kernel.exception.SystemException;
371    
372            /**
373            * @deprecated Replaced by {@link
374            #getFoldersAndFileEntriesAndFileShortcutsCount(long, long,
375            String[], boolean, QueryDefinition)}
376            */
377            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
378            public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(
379                    long groupId, long folderId, int status, java.lang.String[] mimeTypes,
380                    boolean includeMountFolders, int start, int end,
381                    com.liferay.portal.kernel.util.OrderByComparator obc)
382                    throws com.liferay.portal.kernel.exception.SystemException;
383    
384            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
385            public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(
386                    long groupId, long folderId, java.lang.String[] mimeTypes,
387                    boolean includeMountFolders,
388                    com.liferay.portal.kernel.dao.orm.QueryDefinition queryDefinition)
389                    throws com.liferay.portal.kernel.exception.SystemException;
390    
391            /**
392            * @deprecated Replaced by {@link
393            #getFoldersAndFileEntriesAndFileShortcutsCount(long, long,
394            String[], boolean, QueryDefinition)}
395            */
396            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
397            public int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
398                    long folderId, int status, boolean includeMountFolders)
399                    throws com.liferay.portal.kernel.exception.SystemException;
400    
401            /**
402            * @deprecated Replaced by {@link
403            #getFoldersAndFileEntriesAndFileShortcutsCount(long, long,
404            String[], boolean, QueryDefinition)}
405            */
406            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
407            public int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
408                    long folderId, int status, java.lang.String[] mimeTypes,
409                    boolean includeMountFolders)
410                    throws com.liferay.portal.kernel.exception.SystemException;
411    
412            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
413            public int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
414                    long folderId, java.lang.String[] mimeTypes,
415                    boolean includeMountFolders,
416                    com.liferay.portal.kernel.dao.orm.QueryDefinition queryDefinition)
417                    throws com.liferay.portal.kernel.exception.SystemException;
418    
419            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
420            public int getFoldersCount(long groupId, long parentFolderId)
421                    throws com.liferay.portal.kernel.exception.SystemException;
422    
423            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
424            public int getFoldersCount(long groupId, long parentFolderId,
425                    boolean includeMountfolders)
426                    throws com.liferay.portal.kernel.exception.SystemException;
427    
428            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
429            public com.liferay.portlet.documentlibrary.model.DLFolder getMountFolder(
430                    long repositoryId)
431                    throws com.liferay.portal.kernel.exception.PortalException,
432                            com.liferay.portal.kernel.exception.SystemException;
433    
434            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
435            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getMountFolders(
436                    long groupId, long parentFolderId, int start, int end,
437                    com.liferay.portal.kernel.util.OrderByComparator obc)
438                    throws com.liferay.portal.kernel.exception.SystemException;
439    
440            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
441            public int getMountFoldersCount(long groupId, long parentFolderId)
442                    throws com.liferay.portal.kernel.exception.SystemException;
443    
444            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
445            public void getSubfolderIds(java.util.List<java.lang.Long> folderIds,
446                    long groupId, long folderId)
447                    throws com.liferay.portal.kernel.exception.SystemException;
448    
449            public com.liferay.portlet.documentlibrary.model.DLFolder moveFolder(
450                    long folderId, long parentFolderId,
451                    com.liferay.portal.service.ServiceContext serviceContext)
452                    throws com.liferay.portal.kernel.exception.PortalException,
453                            com.liferay.portal.kernel.exception.SystemException;
454    
455            public com.liferay.portlet.documentlibrary.model.DLFolder updateFolder(
456                    long folderId, long parentFolderId, java.lang.String name,
457                    java.lang.String description, long defaultFileEntryTypeId,
458                    java.util.List<java.lang.Long> fileEntryTypeIds,
459                    boolean overrideFileEntryTypes,
460                    com.liferay.portal.service.ServiceContext serviceContext)
461                    throws com.liferay.portal.kernel.exception.PortalException,
462                            com.liferay.portal.kernel.exception.SystemException;
463    
464            public com.liferay.portlet.documentlibrary.model.DLFolder updateFolder(
465                    long folderId, java.lang.String name, java.lang.String description,
466                    long defaultFileEntryTypeId,
467                    java.util.List<java.lang.Long> fileEntryTypeIds,
468                    boolean overrideFileEntryTypes,
469                    com.liferay.portal.service.ServiceContext serviceContext)
470                    throws com.liferay.portal.kernel.exception.PortalException,
471                            com.liferay.portal.kernel.exception.SystemException;
472    
473            public com.liferay.portlet.documentlibrary.model.DLFolder updateFolderAndFileEntryTypes(
474                    long folderId, long parentFolderId, java.lang.String name,
475                    java.lang.String description, long defaultFileEntryTypeId,
476                    java.util.List<java.lang.Long> fileEntryTypeIds,
477                    boolean overrideFileEntryTypes,
478                    com.liferay.portal.service.ServiceContext serviceContext)
479                    throws com.liferay.portal.kernel.exception.PortalException,
480                            com.liferay.portal.kernel.exception.SystemException;
481    
482            public void updateLastPostDate(long folderId, java.util.Date lastPostDate)
483                    throws com.liferay.portal.kernel.exception.PortalException,
484                            com.liferay.portal.kernel.exception.SystemException;
485    
486            public com.liferay.portlet.documentlibrary.model.DLFolder updateStatus(
487                    long userId, long folderId, int status,
488                    java.util.Map<java.lang.String, java.io.Serializable> workflowContext,
489                    com.liferay.portal.service.ServiceContext serviceContext)
490                    throws com.liferay.portal.kernel.exception.PortalException,
491                            com.liferay.portal.kernel.exception.SystemException;
492    }