001    /**
002     * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
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            * Updates the document library folder in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
236            *
237            * @param dlFolder the document library folder
238            * @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.
239            * @return the document library folder that was updated
240            * @throws SystemException if a system exception occurred
241            */
242            public com.liferay.portlet.documentlibrary.model.DLFolder updateDLFolder(
243                    com.liferay.portlet.documentlibrary.model.DLFolder dlFolder,
244                    boolean merge)
245                    throws com.liferay.portal.kernel.exception.SystemException;
246    
247            /**
248            * Returns the Spring bean ID for this bean.
249            *
250            * @return the Spring bean ID for this bean
251            */
252            public java.lang.String getBeanIdentifier();
253    
254            /**
255            * Sets the Spring bean ID for this bean.
256            *
257            * @param beanIdentifier the Spring bean ID for this bean
258            */
259            public void setBeanIdentifier(java.lang.String beanIdentifier);
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            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
278            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getCompanyFolders(
279                    long companyId, int start, int end)
280                    throws com.liferay.portal.kernel.exception.SystemException;
281    
282            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
283            public int getCompanyFoldersCount(long companyId)
284                    throws com.liferay.portal.kernel.exception.SystemException;
285    
286            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
287            public java.util.List<java.lang.Object> getFileEntriesAndFileShortcuts(
288                    long groupId, long folderId, int status, int start, int end)
289                    throws com.liferay.portal.kernel.exception.SystemException;
290    
291            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
292            public int getFileEntriesAndFileShortcutsCount(long groupId, long folderId,
293                    int status) throws com.liferay.portal.kernel.exception.SystemException;
294    
295            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
296            public com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
297                    long folderId)
298                    throws com.liferay.portal.kernel.exception.PortalException,
299                            com.liferay.portal.kernel.exception.SystemException;
300    
301            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
302            public com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
303                    long groupId, long parentFolderId, java.lang.String name)
304                    throws com.liferay.portal.kernel.exception.PortalException,
305                            com.liferay.portal.kernel.exception.SystemException;
306    
307            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
308            public long getFolderId(long companyId, long folderId)
309                    throws com.liferay.portal.kernel.exception.SystemException;
310    
311            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
312            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
313                    long groupId, long parentFolderId)
314                    throws com.liferay.portal.kernel.exception.SystemException;
315    
316            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
317            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
318                    long groupId, long parentFolderId, boolean includeMountfolders)
319                    throws com.liferay.portal.kernel.exception.SystemException;
320    
321            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
322            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
323                    long groupId, long parentFolderId, boolean includeMountfolders,
324                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
325                    throws com.liferay.portal.kernel.exception.SystemException;
326    
327            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
328            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
329                    long groupId, long parentFolderId, int start, int end,
330                    com.liferay.portal.kernel.util.OrderByComparator obc)
331                    throws com.liferay.portal.kernel.exception.SystemException;
332    
333            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
334            public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(
335                    long groupId, long folderId, int status, boolean includeMountFolders,
336                    int start, int end, 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 java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(
341                    long groupId, long folderId, int status, java.lang.String[] mimeTypes,
342                    boolean includeMountFolders, int start, int end,
343                    com.liferay.portal.kernel.util.OrderByComparator obc)
344                    throws com.liferay.portal.kernel.exception.SystemException;
345    
346            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
347            public int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
348                    long folderId, int status, boolean includeMountFolders)
349                    throws com.liferay.portal.kernel.exception.SystemException;
350    
351            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
352            public int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
353                    long folderId, int status, java.lang.String[] mimeTypes,
354                    boolean includeMountFolders)
355                    throws com.liferay.portal.kernel.exception.SystemException;
356    
357            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
358            public int getFoldersCount(long groupId, long parentFolderId)
359                    throws com.liferay.portal.kernel.exception.SystemException;
360    
361            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
362            public int getFoldersCount(long groupId, long parentFolderId,
363                    boolean includeMountfolders)
364                    throws com.liferay.portal.kernel.exception.SystemException;
365    
366            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
367            public int getFoldersFileEntriesCount(long groupId,
368                    java.util.List<java.lang.Long> folderIds, int status)
369                    throws com.liferay.portal.kernel.exception.SystemException;
370    
371            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
372            public com.liferay.portlet.documentlibrary.model.DLFolder getMountFolder(
373                    long repositoryId)
374                    throws com.liferay.portal.kernel.exception.PortalException,
375                            com.liferay.portal.kernel.exception.SystemException;
376    
377            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
378            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getMountFolders(
379                    long groupId, long parentFolderId, int start, int end,
380                    com.liferay.portal.kernel.util.OrderByComparator obc)
381                    throws com.liferay.portal.kernel.exception.SystemException;
382    
383            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
384            public int getMountFoldersCount(long groupId, long parentFolderId)
385                    throws com.liferay.portal.kernel.exception.SystemException;
386    
387            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
388            public void getSubfolderIds(java.util.List<java.lang.Long> folderIds,
389                    long groupId, long folderId)
390                    throws com.liferay.portal.kernel.exception.SystemException;
391    
392            public com.liferay.portlet.documentlibrary.model.DLFolder moveFolder(
393                    long folderId, long parentFolderId,
394                    com.liferay.portal.service.ServiceContext serviceContext)
395                    throws com.liferay.portal.kernel.exception.PortalException,
396                            com.liferay.portal.kernel.exception.SystemException;
397    
398            public com.liferay.portlet.documentlibrary.model.DLFolder updateFolder(
399                    long folderId, long parentFolderId, java.lang.String name,
400                    java.lang.String description, long defaultFileEntryTypeId,
401                    java.util.List<java.lang.Long> fileEntryTypeIds,
402                    boolean overrideFileEntryTypes,
403                    com.liferay.portal.service.ServiceContext serviceContext)
404                    throws com.liferay.portal.kernel.exception.PortalException,
405                            com.liferay.portal.kernel.exception.SystemException;
406    
407            public com.liferay.portlet.documentlibrary.model.DLFolder updateFolder(
408                    long folderId, java.lang.String name, java.lang.String description,
409                    long defaultFileEntryTypeId,
410                    java.util.List<java.lang.Long> fileEntryTypeIds,
411                    boolean overrideFileEntryTypes,
412                    com.liferay.portal.service.ServiceContext serviceContext)
413                    throws com.liferay.portal.kernel.exception.PortalException,
414                            com.liferay.portal.kernel.exception.SystemException;
415    
416            public com.liferay.portlet.documentlibrary.model.DLFolder updateFolderAndFileEntryTypes(
417                    long folderId, long parentFolderId, java.lang.String name,
418                    java.lang.String description, long defaultFileEntryTypeId,
419                    java.util.List<java.lang.Long> fileEntryTypeIds,
420                    boolean overrideFileEntryTypes,
421                    com.liferay.portal.service.ServiceContext serviceContext)
422                    throws com.liferay.portal.kernel.exception.PortalException,
423                            com.liferay.portal.kernel.exception.SystemException;
424    
425            public void updateLastPostDate(long folderId, java.util.Date lastPostDate)
426                    throws com.liferay.portal.kernel.exception.PortalException,
427                            com.liferay.portal.kernel.exception.SystemException;
428    }