001
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
038 @Transactional(isolation = Isolation.PORTAL, rollbackFor = {
039 PortalException.class, SystemException.class})
040 public interface DLFileEntryLocalService extends BaseLocalService,
041 PersistedModelLocalService {
042
047
048
055 public com.liferay.portlet.documentlibrary.model.DLFileEntry addDLFileEntry(
056 com.liferay.portlet.documentlibrary.model.DLFileEntry dlFileEntry)
057 throws com.liferay.portal.kernel.exception.SystemException;
058
059
065 public com.liferay.portlet.documentlibrary.model.DLFileEntry createDLFileEntry(
066 long fileEntryId);
067
068
076 public com.liferay.portlet.documentlibrary.model.DLFileEntry deleteDLFileEntry(
077 long fileEntryId)
078 throws com.liferay.portal.kernel.exception.PortalException,
079 com.liferay.portal.kernel.exception.SystemException;
080
081
088 public com.liferay.portlet.documentlibrary.model.DLFileEntry deleteDLFileEntry(
089 com.liferay.portlet.documentlibrary.model.DLFileEntry dlFileEntry)
090 throws com.liferay.portal.kernel.exception.SystemException;
091
092 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
093
094
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
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
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
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.DLFileEntry fetchDLFileEntry(
158 long fileEntryId)
159 throws com.liferay.portal.kernel.exception.SystemException;
160
161
169 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
170 public com.liferay.portlet.documentlibrary.model.DLFileEntry getDLFileEntry(
171 long fileEntryId)
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
190 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
191 public com.liferay.portlet.documentlibrary.model.DLFileEntry getDLFileEntryByUuidAndGroupId(
192 java.lang.String uuid, long groupId)
193 throws com.liferay.portal.kernel.exception.PortalException,
194 com.liferay.portal.kernel.exception.SystemException;
195
196
208 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
209 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getDLFileEntries(
210 int start, int end)
211 throws com.liferay.portal.kernel.exception.SystemException;
212
213
219 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
220 public int getDLFileEntriesCount()
221 throws com.liferay.portal.kernel.exception.SystemException;
222
223
230 public com.liferay.portlet.documentlibrary.model.DLFileEntry updateDLFileEntry(
231 com.liferay.portlet.documentlibrary.model.DLFileEntry dlFileEntry)
232 throws com.liferay.portal.kernel.exception.SystemException;
233
234
242 public com.liferay.portlet.documentlibrary.model.DLFileEntry updateDLFileEntry(
243 com.liferay.portlet.documentlibrary.model.DLFileEntry dlFileEntry,
244 boolean merge)
245 throws com.liferay.portal.kernel.exception.SystemException;
246
247
252 public java.lang.String getBeanIdentifier();
253
254
259 public void setBeanIdentifier(java.lang.String beanIdentifier);
260
261 public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
262 long userId, long groupId, long repositoryId, long folderId,
263 java.lang.String sourceFileName, java.lang.String mimeType,
264 java.lang.String title, java.lang.String description,
265 java.lang.String changeLog, long fileEntryTypeId,
266 java.util.Map<java.lang.String, com.liferay.portlet.dynamicdatamapping.storage.Fields> fieldsMap,
267 java.io.File file, java.io.InputStream is, long size,
268 com.liferay.portal.service.ServiceContext serviceContext)
269 throws com.liferay.portal.kernel.exception.PortalException,
270 com.liferay.portal.kernel.exception.SystemException;
271
272 public void addFileEntryResources(
273 com.liferay.portlet.documentlibrary.model.DLFileEntry dlFileEntry,
274 boolean addGroupPermissions, boolean addGuestPermissions)
275 throws com.liferay.portal.kernel.exception.PortalException,
276 com.liferay.portal.kernel.exception.SystemException;
277
278 public void addFileEntryResources(
279 com.liferay.portlet.documentlibrary.model.DLFileEntry dlFileEntry,
280 java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
281 throws com.liferay.portal.kernel.exception.PortalException,
282 com.liferay.portal.kernel.exception.SystemException;
283
284 public com.liferay.portlet.documentlibrary.model.DLFileVersion cancelCheckOut(
285 long userId, long fileEntryId)
286 throws com.liferay.portal.kernel.exception.PortalException,
287 com.liferay.portal.kernel.exception.SystemException;
288
289 public void checkInFileEntry(long userId, long fileEntryId,
290 boolean majorVersion, java.lang.String changeLog,
291 com.liferay.portal.service.ServiceContext serviceContext)
292 throws com.liferay.portal.kernel.exception.PortalException,
293 com.liferay.portal.kernel.exception.SystemException;
294
295 public void checkInFileEntry(long userId, long fileEntryId,
296 java.lang.String lockUuid)
297 throws com.liferay.portal.kernel.exception.PortalException,
298 com.liferay.portal.kernel.exception.SystemException;
299
300
303 public com.liferay.portlet.documentlibrary.model.DLFileEntry checkOutFileEntry(
304 long userId, long fileEntryId)
305 throws com.liferay.portal.kernel.exception.PortalException,
306 com.liferay.portal.kernel.exception.SystemException;
307
308 public com.liferay.portlet.documentlibrary.model.DLFileEntry checkOutFileEntry(
309 long userId, long fileEntryId,
310 com.liferay.portal.service.ServiceContext serviceContext)
311 throws com.liferay.portal.kernel.exception.PortalException,
312 com.liferay.portal.kernel.exception.SystemException;
313
314
318 public com.liferay.portlet.documentlibrary.model.DLFileEntry checkOutFileEntry(
319 long userId, long fileEntryId, java.lang.String owner,
320 long expirationTime)
321 throws com.liferay.portal.kernel.exception.PortalException,
322 com.liferay.portal.kernel.exception.SystemException;
323
324 public com.liferay.portlet.documentlibrary.model.DLFileEntry checkOutFileEntry(
325 long userId, long fileEntryId, java.lang.String owner,
326 long expirationTime,
327 com.liferay.portal.service.ServiceContext serviceContext)
328 throws com.liferay.portal.kernel.exception.PortalException,
329 com.liferay.portal.kernel.exception.SystemException;
330
331 public void convertExtraSettings(java.lang.String[] keys)
332 throws com.liferay.portal.kernel.exception.PortalException,
333 com.liferay.portal.kernel.exception.SystemException;
334
335 public void copyFileEntryMetadata(long companyId, long fileEntryTypeId,
336 long fileEntryId, long fromFileVersionId, long toFileVersionId,
337 com.liferay.portal.service.ServiceContext serviceContext)
338 throws com.liferay.portal.kernel.exception.PortalException,
339 com.liferay.portal.kernel.exception.SystemException;
340
341 public void deleteFileEntries(long groupId, long folderId)
342 throws com.liferay.portal.kernel.exception.PortalException,
343 com.liferay.portal.kernel.exception.SystemException;
344
345 public void deleteFileEntry(long fileEntryId)
346 throws com.liferay.portal.kernel.exception.PortalException,
347 com.liferay.portal.kernel.exception.SystemException;
348
349 public void deleteFileEntry(long userId, long fileEntryId)
350 throws com.liferay.portal.kernel.exception.PortalException,
351 com.liferay.portal.kernel.exception.SystemException;
352
353 public void deleteFileVersion(long userId, long fileEntryId,
354 java.lang.String version)
355 throws com.liferay.portal.kernel.exception.PortalException,
356 com.liferay.portal.kernel.exception.SystemException;
357
358 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
359 public com.liferay.portlet.documentlibrary.model.DLFileEntry fetchFileEntryByAnyImageId(
360 long imageId)
361 throws com.liferay.portal.kernel.exception.SystemException;
362
363 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
364 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getExtraSettingsFileEntries(
365 int start, int end)
366 throws com.liferay.portal.kernel.exception.SystemException;
367
368 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
369 public java.io.File getFile(long userId, long fileEntryId,
370 java.lang.String version, boolean incrementCounter)
371 throws com.liferay.portal.kernel.exception.PortalException,
372 com.liferay.portal.kernel.exception.SystemException;
373
374 public java.io.InputStream getFileAsStream(long userId, long fileEntryId,
375 java.lang.String version)
376 throws com.liferay.portal.kernel.exception.PortalException,
377 com.liferay.portal.kernel.exception.SystemException;
378
379 public java.io.InputStream getFileAsStream(long userId, long fileEntryId,
380 java.lang.String version, boolean incrementCounter)
381 throws com.liferay.portal.kernel.exception.PortalException,
382 com.liferay.portal.kernel.exception.SystemException;
383
384 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
385 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntries(
386 int start, int end)
387 throws com.liferay.portal.kernel.exception.SystemException;
388
389 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
390 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntries(
391 long groupId, long folderId, int start, int end,
392 com.liferay.portal.kernel.util.OrderByComparator obc)
393 throws com.liferay.portal.kernel.exception.SystemException;
394
395 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
396 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntriesByMimeType(
397 java.lang.String mimeType)
398 throws com.liferay.portal.kernel.exception.SystemException;
399
400 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
401 public int getFileEntriesCount()
402 throws com.liferay.portal.kernel.exception.SystemException;
403
404 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
405 public int getFileEntriesCount(long groupId, long folderId)
406 throws com.liferay.portal.kernel.exception.SystemException;
407
408 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
409 public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntry(
410 long fileEntryId)
411 throws com.liferay.portal.kernel.exception.PortalException,
412 com.liferay.portal.kernel.exception.SystemException;
413
414 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
415 public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntry(
416 long groupId, long folderId, java.lang.String title)
417 throws com.liferay.portal.kernel.exception.PortalException,
418 com.liferay.portal.kernel.exception.SystemException;
419
420 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
421 public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntryByName(
422 long groupId, long folderId, java.lang.String name)
423 throws com.liferay.portal.kernel.exception.PortalException,
424 com.liferay.portal.kernel.exception.SystemException;
425
426 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
427 public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntryByUuidAndGroupId(
428 java.lang.String uuid, long groupId)
429 throws com.liferay.portal.kernel.exception.PortalException,
430 com.liferay.portal.kernel.exception.SystemException;
431
432 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
433 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(
434 long groupId, int start, int end)
435 throws com.liferay.portal.kernel.exception.SystemException;
436
437 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
438 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(
439 long groupId, int start, int end,
440 com.liferay.portal.kernel.util.OrderByComparator obc)
441 throws com.liferay.portal.kernel.exception.SystemException;
442
443 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
444 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(
445 long groupId, long userId, int start, int end)
446 throws com.liferay.portal.kernel.exception.SystemException;
447
448 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
449 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(
450 long groupId, long userId, int start, int end,
451 com.liferay.portal.kernel.util.OrderByComparator obc)
452 throws com.liferay.portal.kernel.exception.SystemException;
453
454 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
455 public int getGroupFileEntriesCount(long groupId)
456 throws com.liferay.portal.kernel.exception.SystemException;
457
458 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
459 public int getGroupFileEntriesCount(long groupId, long userId)
460 throws com.liferay.portal.kernel.exception.SystemException;
461
462 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
463 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getMisversionedFileEntries()
464 throws com.liferay.portal.kernel.exception.SystemException;
465
466 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
467 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getNoAssetFileEntries()
468 throws com.liferay.portal.kernel.exception.SystemException;
469
470 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
471 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getOrphanedFileEntries()
472 throws com.liferay.portal.kernel.exception.SystemException;
473
474 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
475 public boolean hasExtraSettings()
476 throws com.liferay.portal.kernel.exception.SystemException;
477
478 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
479 public boolean hasFileEntryLock(long userId, long fileEntryId)
480 throws com.liferay.portal.kernel.exception.PortalException,
481 com.liferay.portal.kernel.exception.SystemException;
482
483 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
484 public boolean isFileEntryCheckedOut(long fileEntryId)
485 throws com.liferay.portal.kernel.exception.PortalException,
486 com.liferay.portal.kernel.exception.SystemException;
487
488 public com.liferay.portlet.documentlibrary.model.DLFileEntry moveFileEntry(
489 long userId, long fileEntryId, long newFolderId,
490 com.liferay.portal.service.ServiceContext serviceContext)
491 throws com.liferay.portal.kernel.exception.PortalException,
492 com.liferay.portal.kernel.exception.SystemException;
493
494 public void revertFileEntry(long userId, long fileEntryId,
495 java.lang.String version,
496 com.liferay.portal.service.ServiceContext serviceContext)
497 throws com.liferay.portal.kernel.exception.PortalException,
498 com.liferay.portal.kernel.exception.SystemException;
499
500 public com.liferay.portlet.documentlibrary.model.DLFileEntry updateFileEntry(
501 long userId, long fileEntryId, java.lang.String sourceFileName,
502 java.lang.String mimeType, java.lang.String title,
503 java.lang.String description, java.lang.String changeLog,
504 boolean majorVersion, long fileEntryTypeId,
505 java.util.Map<java.lang.String, com.liferay.portlet.dynamicdatamapping.storage.Fields> fieldsMap,
506 java.io.File file, java.io.InputStream is, long size,
507 com.liferay.portal.service.ServiceContext serviceContext)
508 throws com.liferay.portal.kernel.exception.PortalException,
509 com.liferay.portal.kernel.exception.SystemException;
510
511 public void updateSmallImage(long smallImageId, long largeImageId)
512 throws com.liferay.portal.kernel.exception.PortalException,
513 com.liferay.portal.kernel.exception.SystemException;
514
515 public com.liferay.portlet.documentlibrary.model.DLFileEntry updateStatus(
516 long userId, long fileVersionId, int status,
517 java.util.Map<java.lang.String, java.io.Serializable> workflowContext,
518 com.liferay.portal.service.ServiceContext serviceContext)
519 throws com.liferay.portal.kernel.exception.PortalException,
520 com.liferay.portal.kernel.exception.SystemException;
521
522 public boolean verifyFileEntryCheckOut(long fileEntryId,
523 java.lang.String lockUuid)
524 throws com.liferay.portal.kernel.exception.PortalException,
525 com.liferay.portal.kernel.exception.SystemException;
526
527 public boolean verifyFileEntryLock(long fileEntryId,
528 java.lang.String lockUuid)
529 throws com.liferay.portal.kernel.exception.PortalException,
530 com.liferay.portal.kernel.exception.SystemException;
531 }