2 * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved.
4 * This library is free software; you can redistribute it and/or modify it under
5 * the terms of the GNU Lesser General Public License as published by the Free
6 * Software Foundation; either version 2.1 of the License, or (at your option)
9 * This library is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
15 package com.liferay.portlet.documentlibrary.folder.service;
17 import com.liferay.portal.kernel.exception.PortalException;
18 import com.liferay.portal.kernel.exception.SystemException;
19 import com.liferay.portal.kernel.transaction.Isolation;
20 import com.liferay.portal.kernel.transaction.Propagation;
21 import com.liferay.portal.kernel.transaction.Transactional;
22 import com.liferay.portal.service.BaseLocalService;
23 import com.liferay.portal.service.PersistedModelLocalService;
26 * The interface for the document library folder local service.
29 * 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.
32 * @author Brian Wing Shun Chan
33 * @see DLFolderLocalServiceUtil
34 * @see com.liferay.portlet.documentlibrary.service.base.DLFolderLocalServiceBaseImpl
35 * @see com.liferay.portlet.documentlibrary.service.impl.DLFolderLocalServiceImpl
38 @Transactional(isolation = Isolation.PORTAL, rollbackFor = {
39 PortalException.class, SystemException.class})
40 public interface DLFolderLocalService extends BaseLocalService,
41 PersistedModelLocalService {
43 * NOTE FOR DEVELOPERS:
45 * 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.
49 * Adds the document library folder to the database. Also notifies the appropriate model listeners.
51 * @param dlFolder the document library folder
52 * @return the document library folder that was added
53 * @throws SystemException if a system exception occurred
55 public com.liferay.portlet.documentlibrary.model.DLFolder addDLFolder(
56 com.liferay.portlet.documentlibrary.model.DLFolder dlFolder)
57 throws com.liferay.portal.kernel.exception.SystemException;
60 * Creates a new document library folder with the primary key. Does not add the document library folder to the database.
62 * @param folderId the primary key for the new document library folder
63 * @return the new document library folder
65 public com.liferay.portlet.documentlibrary.model.DLFolder createDLFolder(
69 * Deletes the document library folder with the primary key from the database. Also notifies the appropriate model listeners.
71 * @param folderId the primary key of the document library folder
72 * @return the document library folder that was removed
73 * @throws PortalException if a document library folder with the primary key could not be found
74 * @throws SystemException if a system exception occurred
76 public com.liferay.portlet.documentlibrary.model.DLFolder deleteDLFolder(
78 throws com.liferay.portal.kernel.exception.PortalException,
79 com.liferay.portal.kernel.exception.SystemException;
82 * Deletes the document library folder from the database. Also notifies the appropriate model listeners.
84 * @param dlFolder the document library folder
85 * @return the document library folder that was removed
86 * @throws SystemException if a system exception occurred
88 public com.liferay.portlet.documentlibrary.model.DLFolder deleteDLFolder(
89 com.liferay.portlet.documentlibrary.model.DLFolder dlFolder)
90 throws com.liferay.portal.kernel.exception.SystemException;
92 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
95 * Performs a dynamic query on the database and returns the matching rows.
97 * @param dynamicQuery the dynamic query
98 * @return the matching rows
99 * @throws SystemException if a system exception occurred
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;
107 * Performs a dynamic query on the database and returns a range of the matching rows.
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.
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
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;
125 * Performs a dynamic query on the database and returns an ordered range of the matching rows.
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.
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
138 @SuppressWarnings("rawtypes")
139 public java.util.List dynamicQuery(
140 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
142 com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
143 throws com.liferay.portal.kernel.exception.SystemException;
146 * Returns the number of rows that match the dynamic query.
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
152 public long dynamicQueryCount(
153 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
154 throws com.liferay.portal.kernel.exception.SystemException;
156 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
157 public com.liferay.portlet.documentlibrary.model.DLFolder fetchDLFolder(
159 throws com.liferay.portal.kernel.exception.SystemException;
162 * Returns the document library folder with the primary key.
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
169 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
170 public com.liferay.portlet.documentlibrary.model.DLFolder getDLFolder(
172 throws com.liferay.portal.kernel.exception.PortalException,
173 com.liferay.portal.kernel.exception.SystemException;
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;
182 * Returns the document library folder with the UUID in the group.
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
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;
197 * Returns a range of all the document library folders.
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.
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
208 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
209 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getDLFolders(
211 throws com.liferay.portal.kernel.exception.SystemException;
214 * Returns the number of document library folders.
216 * @return the number of document library folders
217 * @throws SystemException if a system exception occurred
219 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
220 public int getDLFoldersCount()
221 throws com.liferay.portal.kernel.exception.SystemException;
224 * Updates the document library folder in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
226 * @param dlFolder the document library folder
227 * @return the document library folder that was updated
228 * @throws SystemException if a system exception occurred
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;
235 * Updates the document library folder in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
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
242 public com.liferay.portlet.documentlibrary.model.DLFolder updateDLFolder(
243 com.liferay.portlet.documentlibrary.model.DLFolder dlFolder,
245 throws com.liferay.portal.kernel.exception.SystemException;
248 * Returns the Spring bean ID for this bean.
250 * @return the Spring bean ID for this bean
252 public java.lang.String getBeanIdentifier();
255 * Sets the Spring bean ID for this bean.
257 * @param beanIdentifier the Spring bean ID for this bean
259 public void setBeanIdentifier(java.lang.String beanIdentifier);
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;
269 public void deleteAll(long groupId)
270 throws com.liferay.portal.kernel.exception.PortalException,
271 com.liferay.portal.kernel.exception.SystemException;
273 public void deleteFolder(long folderId)
274 throws com.liferay.portal.kernel.exception.PortalException,
275 com.liferay.portal.kernel.exception.SystemException;
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;
282 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
283 public int getCompanyFoldersCount(long companyId)
284 throws com.liferay.portal.kernel.exception.SystemException;
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;
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;
295 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
296 public com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
298 throws com.liferay.portal.kernel.exception.PortalException,
299 com.liferay.portal.kernel.exception.SystemException;
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;
307 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
308 public long getFolderId(long companyId, long folderId)
309 throws com.liferay.portal.kernel.exception.SystemException;
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;
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;
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;
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;
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;
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;
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;
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;
357 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
358 public int getFoldersCount(long groupId, long parentFolderId)
359 throws com.liferay.portal.kernel.exception.SystemException;
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;
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;
371 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
372 public com.liferay.portlet.documentlibrary.model.DLFolder getMountFolder(
374 throws com.liferay.portal.kernel.exception.PortalException,
375 com.liferay.portal.kernel.exception.SystemException;
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;
383 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
384 public int getMountFoldersCount(long groupId, long parentFolderId)
385 throws com.liferay.portal.kernel.exception.SystemException;
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;
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;
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;
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;
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;
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 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
429 public com.liferay.portal.kernel.search.Hits search(long companyId,
430 long groupId, long userId, long[] folderIds, java.lang.String keywords,
431 int start, int end) throws com.liferay.portal.kernel.exception.SystemException;
433 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
434 public com.liferay.portal.kernel.search.Hits search(long companyId,
435 long groupId, long userId, long ownerUserId, java.lang.String keywords,
436 int start, int end) throws com.liferay.portal.kernel.exception.SystemException;
438 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
439 public com.liferay.portal.kernel.search.Hits searchByDate(long companyId,
440 long groupId, long userId, long ownerUserId, java.lang.String keywords,
441 int start, int end) throws com.liferay.portal.kernel.exception.SystemException;