Liferay 7.0-ce-b4

com.liferay.portlet.documentlibrary.service
Class DLTrashServiceUtil

java.lang.Object
  extended by com.liferay.portlet.documentlibrary.service.DLTrashServiceUtil

@ProviderType
public class DLTrashServiceUtil
extends Object

Provides the remote service utility for DLTrash. This utility wraps DLTrashServiceImpl and is the primary access point for service operations in application layer code running on a remote server. 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:
DLTrashService, DLTrashServiceBaseImpl, DLTrashServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
DLTrashServiceUtil()
           
 
Method Summary
static String getOSGiServiceIdentifier()
          Returns the OSGi service identifier.
static DLTrashService getService()
           
static FileEntry moveFileEntryFromTrash(long fileEntryId, long newFolderId, ServiceContext serviceContext)
          Moves the file entry from a trashed folder to the new folder.
static FileEntry moveFileEntryToTrash(long fileEntryId)
          Moves the file entry with the primary key to the trash portlet.
static FileShortcut moveFileShortcutFromTrash(long fileShortcutId, long newFolderId, ServiceContext serviceContext)
          Moves the file shortcut from a trashed folder to the new folder.
static FileShortcut moveFileShortcutToTrash(long fileShortcutId)
          Moves the file shortcut with the primary key to the trash portlet.
static 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.
static Folder moveFolderToTrash(long folderId)
          Moves the folder with the primary key to the trash portlet.
static void restoreFileEntryFromTrash(long fileEntryId)
          Restores the file entry with the primary key from the trash portlet.
static void restoreFileShortcutFromTrash(long fileShortcutId)
          Restores the file shortcut with the primary key from the trash portlet.
static void restoreFolderFromTrash(long folderId)
          Restores the folder with the primary key from the trash portlet.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DLTrashServiceUtil

public DLTrashServiceUtil()
Method Detail

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()
Returns the OSGi service identifier.

Returns:
the OSGi service identifier

moveFileEntryFromTrash

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

getService

public static DLTrashService getService()

Liferay 7.0-ce-b4