Interface DLTrashService
- All Superinterfaces:
BaseService
- All Known Implementing Classes:
DLTrashServiceWrapper
@AccessControlled
@CTAware
@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.
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionReturns the OSGi service identifier.moveFileEntryFromTrash
(long fileEntryId, long newFolderId, ServiceContext serviceContext) Moves the file entry from a trashed folder to the new folder.moveFileEntryToTrash
(long fileEntryId) Moves the file entry with the primary key to the trash portlet.moveFileShortcutFromTrash
(long fileShortcutId, long newFolderId, ServiceContext serviceContext) Moves the file shortcut from a trashed folder to the new folder.moveFileShortcutToTrash
(long fileShortcutId) Moves the file shortcut with the primary key to the trash portlet.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.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 Details
-
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 entrynewFolderId
- the primary key of the new folderserviceContext
- the service context to be applied- Returns:
- the file entry
- Throws:
PortalException
-
moveFileEntryToTrash
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 shortcutnewFolderId
- the primary key of the new folderserviceContext
- the service context to be applied- Returns:
- the file shortcut
- Throws:
PortalException
-
moveFileShortcutToTrash
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 folderparentFolderId
- the primary key of the new parent folderserviceContext
- the service context to be applied- Returns:
- the file entry
- Throws:
PortalException
-
moveFolderToTrash
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
Restores the file entry with the primary key from the trash portlet.- Parameters:
fileEntryId
- the primary key of the file entry- Throws:
PortalException
-
restoreFileShortcutFromTrash
Restores the file shortcut with the primary key from the trash portlet.- Parameters:
fileShortcutId
- the primary key of the file shortcut- Throws:
PortalException
-
restoreFolderFromTrash
Restores the folder with the primary key from the trash portlet.- Parameters:
folderId
- the primary key of the folder- Throws:
PortalException
-