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