Liferay 7.0-ce-b4

com.liferay.portlet.documentlibrary.service
Interface DLTrashService

All Superinterfaces:
BaseService
All Known Implementing Classes:
DLTrashServiceBaseImpl, DLTrashServiceImpl, DLTrashServiceWrapper

@AccessControlled
@JSONWebService
@ProviderType
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface DLTrashService
extends BaseService

Provides the remote service interface for DLTrash. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.

See Also:
DLTrashServiceUtil, DLTrashServiceBaseImpl, DLTrashServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 String getOSGiServiceIdentifier()
          Returns the OSGi service identifier.
 FileEntry moveFileEntryFromTrash(long fileEntryId, long newFolderId, ServiceContext serviceContext)
          Moves the file entry from a trashed folder to the new folder.
 FileEntry moveFileEntryToTrash(long fileEntryId)
          Moves the file entry with the primary key to the trash portlet.
 FileShortcut moveFileShortcutFromTrash(long fileShortcutId, long newFolderId, ServiceContext serviceContext)
          Moves the file shortcut from a trashed folder to the new folder.
 FileShortcut moveFileShortcutToTrash(long fileShortcutId)
          Moves the file shortcut with the primary key to the trash portlet.
 Folder moveFolderFromTrash(long folderId, long parentFolderId, ServiceContext serviceContext)
          Moves the folder with the primary key from the trash portlet to the new parent folder with the primary key.
 Folder moveFolderToTrash(long folderId)
          Moves the folder with the primary key to the trash portlet.
 void restoreFileEntryFromTrash(long fileEntryId)
          Restores the file entry with the primary key from the trash portlet.
 void restoreFileShortcutFromTrash(long fileShortcutId)
          Restores the file shortcut with the primary key from the trash portlet.
 void restoreFolderFromTrash(long folderId)
          Restores the folder with the primary key from the trash portlet.
 

Method Detail

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()
Returns the OSGi service identifier.

Returns:
the OSGi service identifier

moveFileEntryFromTrash

FileEntry moveFileEntryFromTrash(long fileEntryId,
                                 long newFolderId,
                                 ServiceContext serviceContext)
                                 throws PortalException
Moves the file entry from a trashed folder to the new folder.

Parameters:
fileEntryId - the primary key of the file entry
newFolderId - the primary key of the new folder
serviceContext - the service context to be applied
Returns:
the file entry
Throws:
PortalException

moveFileEntryToTrash

FileEntry moveFileEntryToTrash(long fileEntryId)
                               throws PortalException
Moves the file entry with the primary key to the trash portlet.

Parameters:
fileEntryId - the primary key of the file entry
Returns:
the file entry
Throws:
PortalException

moveFileShortcutFromTrash

FileShortcut moveFileShortcutFromTrash(long fileShortcutId,
                                       long newFolderId,
                                       ServiceContext serviceContext)
                                       throws PortalException
Moves the file shortcut from a trashed folder to the new folder.

Parameters:
fileShortcutId - the primary key of the file shortcut
newFolderId - the primary key of the new folder
serviceContext - the service context to be applied
Returns:
the file shortcut
Throws:
PortalException

moveFileShortcutToTrash

FileShortcut moveFileShortcutToTrash(long fileShortcutId)
                                     throws PortalException
Moves the file shortcut with the primary key to the trash portlet.

Parameters:
fileShortcutId - the primary key of the file shortcut
Returns:
the file shortcut
Throws:
PortalException

moveFolderFromTrash

Folder moveFolderFromTrash(long folderId,
                           long parentFolderId,
                           ServiceContext serviceContext)
                           throws PortalException
Moves the folder with the primary key from the trash portlet to the new parent folder with the primary key.

Parameters:
folderId - the primary key of the folder
parentFolderId - the primary key of the new parent folder
serviceContext - the service context to be applied
Returns:
the file entry
Throws:
PortalException

moveFolderToTrash

Folder moveFolderToTrash(long folderId)
                         throws PortalException
Moves the folder with the primary key to the trash portlet.

Parameters:
folderId - the primary key of the folder
Returns:
the file entry
Throws:
PortalException

restoreFileEntryFromTrash

void restoreFileEntryFromTrash(long fileEntryId)
                               throws PortalException
Restores the file entry with the primary key from the trash portlet.

Parameters:
fileEntryId - the primary key of the file entry
Throws:
PortalException

restoreFileShortcutFromTrash

void restoreFileShortcutFromTrash(long fileShortcutId)
                                  throws PortalException
Restores the file shortcut with the primary key from the trash portlet.

Parameters:
fileShortcutId - the primary key of the file shortcut
Throws:
PortalException

restoreFolderFromTrash

void restoreFolderFromTrash(long folderId)
                            throws PortalException
Restores the folder with the primary key from the trash portlet.

Parameters:
folderId - the primary key of the folder
Throws:
PortalException

Liferay 7.0-ce-b4