Package org.opencms.gwt.shared.rpc

Interface I_CmsUploadService

All Superinterfaces:

com.google.gwt.user.client.rpc.RemoteService

All Known Implementing Classes:

CmsUploadService

public interface I_CmsUploadService
extends com.google.gwt.user.client.rpc.RemoteService

Handles all RPC services related to the upload dialog.

Since:

8.0.0

See Also:

• CmsUploadService
• I_CmsUploadService
• I_CmsUploadServiceAsync

Method Summary

Modifier and Type	Method	Description
Boolean	cancelUpload()	Cancels the upload.
CmsUploadFileBean	checkUploadFiles(List<String> fileNames, String targetFolder, boolean isRootPath)	Checks the availability of a resource in the VFS, using the CmsResourceFilter.IGNORE_EXPIRATION filter.
CmsUploadProgessInfo	getUploadProgressInfo()	Returns the upload progress information.

Method Details

cancelUpload

Boolean cancelUpload()

Cancels the upload.

Returns:

true if the listener was canceled false otherwise

checkUploadFiles

CmsUploadFileBean checkUploadFiles(List<String> fileNames,
 String targetFolder,
 boolean isRootPath)

Checks the availability of a resource in the VFS, using the CmsResourceFilter.IGNORE_EXPIRATION filter.

Calculates the VFS path for each filename in the given list and checks its availability.

Parameters:

fileNames - the filenames to check

targetFolder - the folder to check

isRootPath - true in case the target folder path is a root path

Returns:

a CmsUploadFileBean that holds the list of resource names (without the path) that already exist in the VFS and a list of filenames that are invalid

getUploadProgressInfo

CmsUploadProgessInfo getUploadProgressInfo()
                                    throws CmsRpcException

Returns the upload progress information.

Returns:

the upload progress information

Throws:

CmsRpcException - if something goes wrong