Package ch.ethz.sis.openbis.generic.dssapi.v3.fastdownload

Class FastDownloadResult

java.lang.Object

ch.ethz.sis.openbis.generic.dssapi.v3.fastdownload.FastDownloadResult

public class FastDownloadResult
extends Object

The result of a download session.

Method Summary

Modifier and Type	Method	Description
String	getDownloadSessionId()	Returns the download session ID.
String	getFileTransferUserSessionId()	Returns the user session ID.
Map<IDataSetFileId,Path>	getPathsById()	Returns the map of data set file IDs to local download paths.
ch.ethz.sis.filetransfer.DownloadStatus	getStatus()	Returns the status of the download session.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

getStatus

public ch.ethz.sis.filetransfer.DownloadStatus getStatus()

Returns the status of the download session.

getPathsById

public Map<IDataSetFileId,Path> getPathsById()

Returns the map of data set file IDs to local download paths.

Returns:

an empty map if the download status isn't FINISHED.

getFileTransferUserSessionId

public String getFileTransferUserSessionId()

Returns the user session ID.

getDownloadSessionId

public String getDownloadSessionId()

Returns the download session ID.

Returns:

null if the download status is NEW.

toString

public String toString()

Overrides:

toString in class Object