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