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.PersistedModelLocalService;
023
024
037 @Transactional(isolation = Isolation.PORTAL, rollbackFor = {
038 PortalException.class, SystemException.class})
039 public interface DLFileEntryLocalService extends PersistedModelLocalService {
040
045
046
053 public com.liferay.portlet.documentlibrary.model.DLFileEntry addDLFileEntry(
054 com.liferay.portlet.documentlibrary.model.DLFileEntry dlFileEntry)
055 throws com.liferay.portal.kernel.exception.SystemException;
056
057
063 public com.liferay.portlet.documentlibrary.model.DLFileEntry createDLFileEntry(
064 long fileEntryId);
065
066
073 public void deleteDLFileEntry(long fileEntryId)
074 throws com.liferay.portal.kernel.exception.PortalException,
075 com.liferay.portal.kernel.exception.SystemException;
076
077
083 public void deleteDLFileEntry(
084 com.liferay.portlet.documentlibrary.model.DLFileEntry dlFileEntry)
085 throws com.liferay.portal.kernel.exception.SystemException;
086
087
094 @SuppressWarnings("rawtypes")
095 public java.util.List dynamicQuery(
096 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
097 throws com.liferay.portal.kernel.exception.SystemException;
098
099
112 @SuppressWarnings("rawtypes")
113 public java.util.List dynamicQuery(
114 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
115 int end) throws com.liferay.portal.kernel.exception.SystemException;
116
117
131 @SuppressWarnings("rawtypes")
132 public java.util.List dynamicQuery(
133 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
134 int end,
135 com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
136 throws com.liferay.portal.kernel.exception.SystemException;
137
138
145 public long dynamicQueryCount(
146 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
147 throws com.liferay.portal.kernel.exception.SystemException;
148
149 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
150 public com.liferay.portlet.documentlibrary.model.DLFileEntry fetchDLFileEntry(
151 long fileEntryId)
152 throws com.liferay.portal.kernel.exception.SystemException;
153
154
162 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
163 public com.liferay.portlet.documentlibrary.model.DLFileEntry getDLFileEntry(
164 long fileEntryId)
165 throws com.liferay.portal.kernel.exception.PortalException,
166 com.liferay.portal.kernel.exception.SystemException;
167
168 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
169 public com.liferay.portal.model.PersistedModel getPersistedModel(
170 java.io.Serializable primaryKeyObj)
171 throws com.liferay.portal.kernel.exception.PortalException,
172 com.liferay.portal.kernel.exception.SystemException;
173
174
183 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
184 public com.liferay.portlet.documentlibrary.model.DLFileEntry getDLFileEntryByUuidAndGroupId(
185 java.lang.String uuid, long groupId)
186 throws com.liferay.portal.kernel.exception.PortalException,
187 com.liferay.portal.kernel.exception.SystemException;
188
189
201 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
202 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getDLFileEntries(
203 int start, int end)
204 throws com.liferay.portal.kernel.exception.SystemException;
205
206
212 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
213 public int getDLFileEntriesCount()
214 throws com.liferay.portal.kernel.exception.SystemException;
215
216
223 public com.liferay.portlet.documentlibrary.model.DLFileEntry updateDLFileEntry(
224 com.liferay.portlet.documentlibrary.model.DLFileEntry dlFileEntry)
225 throws com.liferay.portal.kernel.exception.SystemException;
226
227
235 public com.liferay.portlet.documentlibrary.model.DLFileEntry updateDLFileEntry(
236 com.liferay.portlet.documentlibrary.model.DLFileEntry dlFileEntry,
237 boolean merge)
238 throws com.liferay.portal.kernel.exception.SystemException;
239
240
245 public java.lang.String getBeanIdentifier();
246
247
252 public void setBeanIdentifier(java.lang.String beanIdentifier);
253
254 public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
255 long userId, long groupId, long repositoryId, long folderId,
256 java.lang.String sourceFileName, java.lang.String mimeType,
257 java.lang.String title, java.lang.String description,
258 java.lang.String changeLog, long fileEntryTypeId,
259 java.util.Map<java.lang.String, com.liferay.portlet.dynamicdatamapping.storage.Fields> fieldsMap,
260 java.io.File file, java.io.InputStream is, long size,
261 com.liferay.portal.service.ServiceContext serviceContext)
262 throws com.liferay.portal.kernel.exception.PortalException,
263 com.liferay.portal.kernel.exception.SystemException;
264
265 public void addFileEntryResources(
266 com.liferay.portlet.documentlibrary.model.DLFileEntry dlFileEntry,
267 boolean addGroupPermissions, boolean addGuestPermissions)
268 throws com.liferay.portal.kernel.exception.PortalException,
269 com.liferay.portal.kernel.exception.SystemException;
270
271 public void addFileEntryResources(
272 com.liferay.portlet.documentlibrary.model.DLFileEntry dlFileEntry,
273 java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
274 throws com.liferay.portal.kernel.exception.PortalException,
275 com.liferay.portal.kernel.exception.SystemException;
276
277 public void cancelCheckOut(long userId, long fileEntryId)
278 throws com.liferay.portal.kernel.exception.PortalException,
279 com.liferay.portal.kernel.exception.SystemException;
280
281 public void checkInFileEntry(long userId, long fileEntryId,
282 boolean majorVersion, java.lang.String changeLog,
283 com.liferay.portal.service.ServiceContext serviceContext)
284 throws com.liferay.portal.kernel.exception.PortalException,
285 com.liferay.portal.kernel.exception.SystemException;
286
287 public void checkInFileEntry(long userId, long fileEntryId,
288 java.lang.String lockUuid)
289 throws com.liferay.portal.kernel.exception.PortalException,
290 com.liferay.portal.kernel.exception.SystemException;
291
292
295 public com.liferay.portlet.documentlibrary.model.DLFileEntry checkOutFileEntry(
296 long userId, long fileEntryId)
297 throws com.liferay.portal.kernel.exception.PortalException,
298 com.liferay.portal.kernel.exception.SystemException;
299
300 public com.liferay.portlet.documentlibrary.model.DLFileEntry checkOutFileEntry(
301 long userId, long fileEntryId,
302 com.liferay.portal.service.ServiceContext serviceContext)
303 throws com.liferay.portal.kernel.exception.PortalException,
304 com.liferay.portal.kernel.exception.SystemException;
305
306
310 public com.liferay.portlet.documentlibrary.model.DLFileEntry checkOutFileEntry(
311 long userId, long fileEntryId, java.lang.String owner,
312 long expirationTime)
313 throws com.liferay.portal.kernel.exception.PortalException,
314 com.liferay.portal.kernel.exception.SystemException;
315
316 public com.liferay.portlet.documentlibrary.model.DLFileEntry checkOutFileEntry(
317 long userId, long fileEntryId, java.lang.String owner,
318 long expirationTime,
319 com.liferay.portal.service.ServiceContext serviceContext)
320 throws com.liferay.portal.kernel.exception.PortalException,
321 com.liferay.portal.kernel.exception.SystemException;
322
323 public void convertExtraSettings(java.lang.String[] keys)
324 throws com.liferay.portal.kernel.exception.PortalException,
325 com.liferay.portal.kernel.exception.SystemException;
326
327 public void copyFileEntryMetadata(long companyId, long fileEntryTypeId,
328 long fileEntryId, long fromFileVersionId, long toFileVersionId,
329 com.liferay.portal.service.ServiceContext serviceContext)
330 throws com.liferay.portal.kernel.exception.PortalException,
331 com.liferay.portal.kernel.exception.SystemException;
332
333 public void deleteFileEntries(long groupId, long folderId)
334 throws com.liferay.portal.kernel.exception.PortalException,
335 com.liferay.portal.kernel.exception.SystemException;
336
337 public void deleteFileEntry(long fileEntryId)
338 throws com.liferay.portal.kernel.exception.PortalException,
339 com.liferay.portal.kernel.exception.SystemException;
340
341 public void deleteFileEntry(long userId, long fileEntryId)
342 throws com.liferay.portal.kernel.exception.PortalException,
343 com.liferay.portal.kernel.exception.SystemException;
344
345 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
346 public com.liferay.portlet.documentlibrary.model.DLFileEntry fetchFileEntryByAnyImageId(
347 long imageId)
348 throws com.liferay.portal.kernel.exception.SystemException;
349
350 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
351 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getExtraSettingsFileEntries(
352 int start, int end)
353 throws com.liferay.portal.kernel.exception.SystemException;
354
355 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
356 public java.io.File getFile(long userId, long fileEntryId,
357 java.lang.String version, boolean incrementCounter)
358 throws com.liferay.portal.kernel.exception.PortalException,
359 com.liferay.portal.kernel.exception.SystemException;
360
361 public java.io.InputStream getFileAsStream(long userId, long fileEntryId,
362 java.lang.String version)
363 throws com.liferay.portal.kernel.exception.PortalException,
364 com.liferay.portal.kernel.exception.SystemException;
365
366 public java.io.InputStream getFileAsStream(long userId, long fileEntryId,
367 java.lang.String version, boolean incrementCounter)
368 throws com.liferay.portal.kernel.exception.PortalException,
369 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> getFileEntries(
373 int start, int end)
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> getFileEntries(
378 long groupId, long folderId, int start, int end,
379 com.liferay.portal.kernel.util.OrderByComparator obc)
380 throws com.liferay.portal.kernel.exception.SystemException;
381
382 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
383 public int getFileEntriesCount()
384 throws com.liferay.portal.kernel.exception.SystemException;
385
386 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
387 public int getFileEntriesCount(long groupId, long folderId)
388 throws com.liferay.portal.kernel.exception.SystemException;
389
390 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
391 public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntry(
392 long fileEntryId)
393 throws com.liferay.portal.kernel.exception.PortalException,
394 com.liferay.portal.kernel.exception.SystemException;
395
396 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
397 public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntry(
398 long groupId, long folderId, java.lang.String title)
399 throws com.liferay.portal.kernel.exception.PortalException,
400 com.liferay.portal.kernel.exception.SystemException;
401
402 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
403 public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntryByName(
404 long groupId, long folderId, java.lang.String name)
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 com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntryByUuidAndGroupId(
410 java.lang.String uuid, long groupId)
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 java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(
416 long groupId, int start, int end)
417 throws com.liferay.portal.kernel.exception.SystemException;
418
419 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
420 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(
421 long groupId, int start, int end,
422 com.liferay.portal.kernel.util.OrderByComparator obc)
423 throws com.liferay.portal.kernel.exception.SystemException;
424
425 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
426 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(
427 long groupId, long userId, int start, int end)
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> getGroupFileEntries(
432 long groupId, long userId, int start, int end,
433 com.liferay.portal.kernel.util.OrderByComparator obc)
434 throws com.liferay.portal.kernel.exception.SystemException;
435
436 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
437 public int getGroupFileEntriesCount(long groupId)
438 throws com.liferay.portal.kernel.exception.SystemException;
439
440 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
441 public int getGroupFileEntriesCount(long groupId, long userId)
442 throws com.liferay.portal.kernel.exception.SystemException;
443
444 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
445 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getNoAssetFileEntries()
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> getOrphanedFileEntries()
450 throws com.liferay.portal.kernel.exception.SystemException;
451
452 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
453 public boolean hasExtraSettings()
454 throws com.liferay.portal.kernel.exception.SystemException;
455
456 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
457 public boolean hasFileEntryLock(long userId, long fileEntryId)
458 throws com.liferay.portal.kernel.exception.PortalException,
459 com.liferay.portal.kernel.exception.SystemException;
460
461 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
462 public boolean isFileEntryCheckedOut(long fileEntryId)
463 throws com.liferay.portal.kernel.exception.PortalException,
464 com.liferay.portal.kernel.exception.SystemException;
465
466 public com.liferay.portal.model.Lock lockFileEntry(long userId,
467 long fileEntryId)
468 throws com.liferay.portal.kernel.exception.PortalException,
469 com.liferay.portal.kernel.exception.SystemException;
470
471 public com.liferay.portal.model.Lock lockFileEntry(long userId,
472 long fileEntryId, java.lang.String owner, long expirationTime)
473 throws com.liferay.portal.kernel.exception.PortalException,
474 com.liferay.portal.kernel.exception.SystemException;
475
476 public com.liferay.portlet.documentlibrary.model.DLFileEntry moveFileEntry(
477 long userId, long fileEntryId, long newFolderId,
478 com.liferay.portal.service.ServiceContext serviceContext)
479 throws com.liferay.portal.kernel.exception.PortalException,
480 com.liferay.portal.kernel.exception.SystemException;
481
482 public void revertFileEntry(long userId, long fileEntryId,
483 java.lang.String version,
484 com.liferay.portal.service.ServiceContext serviceContext)
485 throws com.liferay.portal.kernel.exception.PortalException,
486 com.liferay.portal.kernel.exception.SystemException;
487
488 public void unlockFileEntry(long fileEntryId)
489 throws com.liferay.portal.kernel.exception.SystemException;
490
491 public void unlockFileEntry(long fileEntryId, java.lang.String lockUuid)
492 throws com.liferay.portal.kernel.exception.PortalException,
493 com.liferay.portal.kernel.exception.SystemException;
494
495 public com.liferay.portlet.documentlibrary.model.DLFileEntry updateFileEntry(
496 long userId, long fileEntryId, java.lang.String sourceFileName,
497 java.lang.String mimeType, java.lang.String title,
498 java.lang.String description, java.lang.String changeLog,
499 boolean majorVersion, long fileEntryTypeId,
500 java.util.Map<java.lang.String, com.liferay.portlet.dynamicdatamapping.storage.Fields> fieldsMap,
501 java.io.File file, java.io.InputStream is, long size,
502 com.liferay.portal.service.ServiceContext serviceContext)
503 throws com.liferay.portal.kernel.exception.PortalException,
504 com.liferay.portal.kernel.exception.SystemException;
505
506 public void updateSmallImage(long smallImageId, long largeImageId)
507 throws com.liferay.portal.kernel.exception.PortalException,
508 com.liferay.portal.kernel.exception.SystemException;
509
510 public com.liferay.portlet.documentlibrary.model.DLFileEntry updateStatus(
511 long userId, long fileVersionId, int status,
512 java.util.Map<java.lang.String, java.io.Serializable> workflowContext,
513 com.liferay.portal.service.ServiceContext serviceContext)
514 throws com.liferay.portal.kernel.exception.PortalException,
515 com.liferay.portal.kernel.exception.SystemException;
516
517 public boolean verifyFileEntryCheckOut(long fileEntryId,
518 java.lang.String lockUuid)
519 throws com.liferay.portal.kernel.exception.PortalException,
520 com.liferay.portal.kernel.exception.SystemException;
521
522 public boolean verifyFileEntryLock(long fileEntryId,
523 java.lang.String lockUuid)
524 throws com.liferay.portal.kernel.exception.PortalException,
525 com.liferay.portal.kernel.exception.SystemException;
526 }