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
239 public java.lang.String getBeanIdentifier();
240
241
246 public void setBeanIdentifier(java.lang.String beanIdentifier);
247
248 public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
249 long userId, long groupId, long repositoryId, long folderId,
250 java.lang.String sourceFileName, java.lang.String mimeType,
251 java.lang.String title, java.lang.String description,
252 java.lang.String changeLog, long fileEntryTypeId,
253 java.util.Map<java.lang.String, com.liferay.portlet.dynamicdatamapping.storage.Fields> fieldsMap,
254 java.io.File file, java.io.InputStream is, long size,
255 com.liferay.portal.service.ServiceContext serviceContext)
256 throws com.liferay.portal.kernel.exception.PortalException,
257 com.liferay.portal.kernel.exception.SystemException;
258
259 public com.liferay.portlet.documentlibrary.model.DLFileVersion cancelCheckOut(
260 long userId, long fileEntryId)
261 throws com.liferay.portal.kernel.exception.PortalException,
262 com.liferay.portal.kernel.exception.SystemException;
263
264 public void checkInFileEntry(long userId, long fileEntryId,
265 boolean majorVersion, java.lang.String changeLog,
266 com.liferay.portal.service.ServiceContext serviceContext)
267 throws com.liferay.portal.kernel.exception.PortalException,
268 com.liferay.portal.kernel.exception.SystemException;
269
270
274 public void checkInFileEntry(long userId, long fileEntryId,
275 java.lang.String lockUuid)
276 throws com.liferay.portal.kernel.exception.PortalException,
277 com.liferay.portal.kernel.exception.SystemException;
278
279 public void checkInFileEntry(long userId, long fileEntryId,
280 java.lang.String lockUuid,
281 com.liferay.portal.service.ServiceContext serviceContext)
282 throws com.liferay.portal.kernel.exception.PortalException,
283 com.liferay.portal.kernel.exception.SystemException;
284
285
289 public com.liferay.portlet.documentlibrary.model.DLFileEntry checkOutFileEntry(
290 long userId, long fileEntryId)
291 throws com.liferay.portal.kernel.exception.PortalException,
292 com.liferay.portal.kernel.exception.SystemException;
293
294 public com.liferay.portlet.documentlibrary.model.DLFileEntry checkOutFileEntry(
295 long userId, long fileEntryId,
296 com.liferay.portal.service.ServiceContext serviceContext)
297 throws com.liferay.portal.kernel.exception.PortalException,
298 com.liferay.portal.kernel.exception.SystemException;
299
300
304 public com.liferay.portlet.documentlibrary.model.DLFileEntry checkOutFileEntry(
305 long userId, long fileEntryId, java.lang.String owner,
306 long expirationTime)
307 throws com.liferay.portal.kernel.exception.PortalException,
308 com.liferay.portal.kernel.exception.SystemException;
309
310 public com.liferay.portlet.documentlibrary.model.DLFileEntry checkOutFileEntry(
311 long userId, long fileEntryId, java.lang.String owner,
312 long expirationTime,
313 com.liferay.portal.service.ServiceContext serviceContext)
314 throws com.liferay.portal.kernel.exception.PortalException,
315 com.liferay.portal.kernel.exception.SystemException;
316
317 public void convertExtraSettings(java.lang.String[] keys)
318 throws com.liferay.portal.kernel.exception.PortalException,
319 com.liferay.portal.kernel.exception.SystemException;
320
321 public void copyFileEntryMetadata(long companyId, long fileEntryTypeId,
322 long fileEntryId, long fromFileVersionId, long toFileVersionId,
323 com.liferay.portal.service.ServiceContext serviceContext)
324 throws com.liferay.portal.kernel.exception.PortalException,
325 com.liferay.portal.kernel.exception.SystemException;
326
327 public void deleteFileEntries(long groupId, long folderId)
328 throws com.liferay.portal.kernel.exception.PortalException,
329 com.liferay.portal.kernel.exception.SystemException;
330
331 public void deleteFileEntries(long groupId, long folderId,
332 boolean includeTrashedEntries)
333 throws com.liferay.portal.kernel.exception.PortalException,
334 com.liferay.portal.kernel.exception.SystemException;
335
336 public com.liferay.portlet.documentlibrary.model.DLFileEntry deleteFileEntry(
337 com.liferay.portlet.documentlibrary.model.DLFileEntry dlFileEntry)
338 throws com.liferay.portal.kernel.exception.PortalException,
339 com.liferay.portal.kernel.exception.SystemException;
340
341 public com.liferay.portlet.documentlibrary.model.DLFileEntry deleteFileEntry(
342 long fileEntryId)
343 throws com.liferay.portal.kernel.exception.PortalException,
344 com.liferay.portal.kernel.exception.SystemException;
345
346 public com.liferay.portlet.documentlibrary.model.DLFileEntry deleteFileEntry(
347 long userId, long fileEntryId)
348 throws com.liferay.portal.kernel.exception.PortalException,
349 com.liferay.portal.kernel.exception.SystemException;
350
351 public com.liferay.portlet.documentlibrary.model.DLFileEntry deleteFileVersion(
352 long userId, long fileEntryId, java.lang.String version)
353 throws com.liferay.portal.kernel.exception.PortalException,
354 com.liferay.portal.kernel.exception.SystemException;
355
356 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
357 public com.liferay.portlet.documentlibrary.model.DLFileEntry fetchFileEntry(
358 long groupId, long folderId, java.lang.String title)
359 throws com.liferay.portal.kernel.exception.SystemException;
360
361 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
362 public com.liferay.portlet.documentlibrary.model.DLFileEntry fetchFileEntryByAnyImageId(
363 long imageId)
364 throws com.liferay.portal.kernel.exception.SystemException;
365
366 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
367 public com.liferay.portlet.documentlibrary.model.DLFileEntry fetchFileEntryByName(
368 long groupId, long folderId, java.lang.String name)
369 throws com.liferay.portal.kernel.exception.SystemException;
370
371 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
372 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getDDMStructureFileEntries(
373 long[] ddmStructureIds)
374 throws com.liferay.portal.kernel.exception.SystemException;
375
376 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
377 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getExtraSettingsFileEntries(
378 int start, int end)
379 throws com.liferay.portal.kernel.exception.SystemException;
380
381 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
382 public java.io.File getFile(long userId, long fileEntryId,
383 java.lang.String version, boolean incrementCounter)
384 throws com.liferay.portal.kernel.exception.PortalException,
385 com.liferay.portal.kernel.exception.SystemException;
386
387 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
388 public java.io.File getFile(long userId, long fileEntryId,
389 java.lang.String version, boolean incrementCounter, int increment)
390 throws com.liferay.portal.kernel.exception.PortalException,
391 com.liferay.portal.kernel.exception.SystemException;
392
393 public java.io.InputStream getFileAsStream(long userId, long fileEntryId,
394 java.lang.String version)
395 throws com.liferay.portal.kernel.exception.PortalException,
396 com.liferay.portal.kernel.exception.SystemException;
397
398 public java.io.InputStream getFileAsStream(long userId, long fileEntryId,
399 java.lang.String version, boolean incrementCounter)
400 throws com.liferay.portal.kernel.exception.PortalException,
401 com.liferay.portal.kernel.exception.SystemException;
402
403 public java.io.InputStream getFileAsStream(long userId, long fileEntryId,
404 java.lang.String version, boolean incrementCounter, int increment)
405 throws com.liferay.portal.kernel.exception.PortalException,
406 com.liferay.portal.kernel.exception.SystemException;
407
408 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
409 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntries(
410 int start, int end)
411 throws com.liferay.portal.kernel.exception.SystemException;
412
413 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
414 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntries(
415 long groupId, long folderId)
416 throws com.liferay.portal.kernel.exception.SystemException;
417
418 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
419 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntries(
420 long groupId, long folderId, int status, int start, int end,
421 com.liferay.portal.kernel.util.OrderByComparator obc)
422 throws com.liferay.portal.kernel.exception.SystemException;
423
424 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
425 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntries(
426 long groupId, long folderId, int start, int end,
427 com.liferay.portal.kernel.util.OrderByComparator obc)
428 throws com.liferay.portal.kernel.exception.SystemException;
429
430 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
431 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntries(
432 long folderId, java.lang.String name)
433 throws com.liferay.portal.kernel.exception.SystemException;
434
435 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
436 public int getFileEntriesCount()
437 throws com.liferay.portal.kernel.exception.SystemException;
438
439 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
440 public int getFileEntriesCount(long groupId, long folderId)
441 throws com.liferay.portal.kernel.exception.SystemException;
442
443 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
444 public int getFileEntriesCount(long groupId, long folderId, int status)
445 throws com.liferay.portal.kernel.exception.SystemException;
446
447 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
448 public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntry(
449 long fileEntryId)
450 throws com.liferay.portal.kernel.exception.PortalException,
451 com.liferay.portal.kernel.exception.SystemException;
452
453 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
454 public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntry(
455 long groupId, long folderId, java.lang.String title)
456 throws com.liferay.portal.kernel.exception.PortalException,
457 com.liferay.portal.kernel.exception.SystemException;
458
459 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
460 public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntryByName(
461 long groupId, long folderId, java.lang.String name)
462 throws com.liferay.portal.kernel.exception.PortalException,
463 com.liferay.portal.kernel.exception.SystemException;
464
465 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
466 public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntryByUuidAndGroupId(
467 java.lang.String uuid, long groupId)
468 throws com.liferay.portal.kernel.exception.PortalException,
469 com.liferay.portal.kernel.exception.SystemException;
470
471 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
472 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(
473 long groupId, int start, int end)
474 throws com.liferay.portal.kernel.exception.SystemException;
475
476 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
477 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(
478 long groupId, int start, int end,
479 com.liferay.portal.kernel.util.OrderByComparator obc)
480 throws com.liferay.portal.kernel.exception.SystemException;
481
482 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
483 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(
484 long groupId, long userId, int start, int end)
485 throws com.liferay.portal.kernel.exception.SystemException;
486
487 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
488 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(
489 long groupId, long userId, int start, int end,
490 com.liferay.portal.kernel.util.OrderByComparator obc)
491 throws com.liferay.portal.kernel.exception.SystemException;
492
493 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
494 public int getGroupFileEntriesCount(long groupId)
495 throws com.liferay.portal.kernel.exception.SystemException;
496
497 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
498 public int getGroupFileEntriesCount(long groupId, long userId)
499 throws com.liferay.portal.kernel.exception.SystemException;
500
501 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
502 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getMisversionedFileEntries()
503 throws com.liferay.portal.kernel.exception.SystemException;
504
505 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
506 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getNoAssetFileEntries()
507 throws com.liferay.portal.kernel.exception.SystemException;
508
509 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
510 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getOrphanedFileEntries()
511 throws com.liferay.portal.kernel.exception.SystemException;
512
513 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
514 public boolean hasExtraSettings()
515 throws com.liferay.portal.kernel.exception.SystemException;
516
517 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
518 public boolean hasFileEntryLock(long userId, long fileEntryId)
519 throws com.liferay.portal.kernel.exception.PortalException,
520 com.liferay.portal.kernel.exception.SystemException;
521
522 public void incrementViewCounter(
523 com.liferay.portlet.documentlibrary.model.DLFileEntry dlFileEntry,
524 int increment)
525 throws com.liferay.portal.kernel.exception.SystemException;
526
527 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
528 public boolean isFileEntryCheckedOut(long fileEntryId)
529 throws com.liferay.portal.kernel.exception.PortalException,
530 com.liferay.portal.kernel.exception.SystemException;
531
532 public com.liferay.portal.model.Lock lockFileEntry(long userId,
533 long fileEntryId)
534 throws com.liferay.portal.kernel.exception.PortalException,
535 com.liferay.portal.kernel.exception.SystemException;
536
537 public com.liferay.portlet.documentlibrary.model.DLFileEntry moveFileEntry(
538 long userId, long fileEntryId, long newFolderId,
539 com.liferay.portal.service.ServiceContext serviceContext)
540 throws com.liferay.portal.kernel.exception.PortalException,
541 com.liferay.portal.kernel.exception.SystemException;
542
543 public void revertFileEntry(long userId, long fileEntryId,
544 java.lang.String version,
545 com.liferay.portal.service.ServiceContext serviceContext)
546 throws com.liferay.portal.kernel.exception.PortalException,
547 com.liferay.portal.kernel.exception.SystemException;
548
549 public void unlockFileEntry(long fileEntryId)
550 throws com.liferay.portal.kernel.exception.SystemException;
551
552 public com.liferay.portlet.documentlibrary.model.DLFileEntry updateFileEntry(
553 long userId, long fileEntryId, java.lang.String sourceFileName,
554 java.lang.String mimeType, java.lang.String title,
555 java.lang.String description, java.lang.String changeLog,
556 boolean majorVersion, long fileEntryTypeId,
557 java.util.Map<java.lang.String, com.liferay.portlet.dynamicdatamapping.storage.Fields> fieldsMap,
558 java.io.File file, java.io.InputStream is, long size,
559 com.liferay.portal.service.ServiceContext serviceContext)
560 throws com.liferay.portal.kernel.exception.PortalException,
561 com.liferay.portal.kernel.exception.SystemException;
562
563 public void updateSmallImage(long smallImageId, long largeImageId)
564 throws com.liferay.portal.kernel.exception.PortalException,
565 com.liferay.portal.kernel.exception.SystemException;
566
567 public com.liferay.portlet.documentlibrary.model.DLFileEntry updateStatus(
568 long userId, long fileVersionId, int status,
569 java.util.Map<java.lang.String, java.io.Serializable> workflowContext,
570 com.liferay.portal.service.ServiceContext serviceContext)
571 throws com.liferay.portal.kernel.exception.PortalException,
572 com.liferay.portal.kernel.exception.SystemException;
573
574 public boolean verifyFileEntryCheckOut(long fileEntryId,
575 java.lang.String lockUuid)
576 throws com.liferay.portal.kernel.exception.PortalException,
577 com.liferay.portal.kernel.exception.SystemException;
578
579 public boolean verifyFileEntryLock(long fileEntryId,
580 java.lang.String lockUuid)
581 throws com.liferay.portal.kernel.exception.PortalException,
582 com.liferay.portal.kernel.exception.SystemException;
583 }