jmaster.jumploader.model.api.upload
Interface IUploadFile

All Superinterfaces:

IFile

public interface IUploadFile
extends IFile

IUploadFile

Field Summary

static int	STATUS_DOWNLOADING
static int	STATUS_EDITING
static int	STATUS_FAILED
static int	STATUS_FINISHED
static int	STATUS_PREPROCESSING
static int	STATUS_READY
static int	STATUS_UPLOADING
static int	TYPE_DOCUMENT a document for processing
static int	TYPE_FILE generic file for upload

Method Summary

java.lang.Exception	getError() error retrieval, valid for STATUS_FAILED
int	getIndex() file index retrieval (staring at 0)
java.lang.String	getKey() retrieve general purpose key
java.lang.String	getResponseContent() server response content retrieval
IAttributeSet	getResponseHeaders() server response headers retrieval
int	getStatus() status retrieval
ITransferProgress	getTransferProgress() transfer progress retrieval, valid for STATUS_UPLOADING
int	getType() type retrieval, see constants
int	getUploadedPartitionCount()
boolean	isDocumentFileWasLocked() shows whether document file ever was locked
boolean	isDownloading() shows whether is downloading
boolean	isEditableImage() shows whether file is editable image
boolean	isEditing() shows whether is editing
boolean	isFailed() shows whether is failed
boolean	isFinished() shows whether is finished
boolean	isPreprocessing() shows whether is preprocessing
boolean	isReady() shows whether is ready
boolean	isRemovable() shows whether this item could be removed from uploader
boolean	isRetryable() shows whether this item could be retryed
boolean	isServerProcessing() shows whether is server processing
boolean	isStoppable() shows whether stop upload can be issued for this item
boolean	isTempFile() check whether file is temporary
boolean	isUploading() shows whether is uploading
void	setDocumentFileWasLocked(boolean documentFileWasLocked) set document file ever was locked flag
void	setKey(java.lang.String key) store general purpose key
void	setLength(long length) update file length
void	setUploadedPartitionCount(int uploadedPartitionCount)

Methods inherited from interface jmaster.jumploader.model.api.file.IFile

getAttributeSet, getCompressionRatio, getFile, getId, getLength, getMimeType, getName, getOriginalFilePath, getPath, isChecked, isCheckedUpdatable, isDirectory, isDrive, isFile, isFileSystem, isHidden, setChecked, setCheckedUpdatable, setId

Field Detail

TYPE_FILE

static final int TYPE_FILE

generic file for upload

See Also:

Constant Field Values

TYPE_DOCUMENT

static final int TYPE_DOCUMENT

a document for processing

See Also:

Constant Field Values

STATUS_READY

static final int STATUS_READY

See Also:

Constant Field Values

STATUS_UPLOADING

static final int STATUS_UPLOADING

See Also:

Constant Field Values

STATUS_FINISHED

static final int STATUS_FINISHED

See Also:

Constant Field Values

STATUS_FAILED

static final int STATUS_FAILED

See Also:

Constant Field Values

STATUS_PREPROCESSING

static final int STATUS_PREPROCESSING

See Also:

Constant Field Values

STATUS_DOWNLOADING

static final int STATUS_DOWNLOADING

See Also:

Constant Field Values

STATUS_EDITING

static final int STATUS_EDITING

See Also:

Constant Field Values

Method Detail

getType

int getType()

type retrieval, see constants

getStatus

int getStatus()

status retrieval

getError

java.lang.Exception getError()

error retrieval, valid for STATUS_FAILED

getTransferProgress

ITransferProgress getTransferProgress()

transfer progress retrieval, valid for STATUS_UPLOADING

isReady

boolean isReady()

shows whether is ready

isPreprocessing

boolean isPreprocessing()

shows whether is preprocessing

isServerProcessing

boolean isServerProcessing()

shows whether is server processing

isUploading

boolean isUploading()

shows whether is uploading

isFinished

boolean isFinished()

shows whether is finished

isFailed

boolean isFailed()

shows whether is failed

getIndex

int getIndex()

file index retrieval (staring at 0)

isRemovable

boolean isRemovable()

shows whether this item could be removed from uploader

isRetryable

boolean isRetryable()

shows whether this item could be retryed

isStoppable

boolean isStoppable()

shows whether stop upload can be issued for this item

getUploadedPartitionCount

int getUploadedPartitionCount()

Returns:

the uploadedPartitionCount

setUploadedPartitionCount

void setUploadedPartitionCount(int uploadedPartitionCount)

Parameters:

uploadedPartitionCount - the uploadedPartitionCount to set

isEditableImage

boolean isEditableImage()

shows whether file is editable image

getResponseContent

java.lang.String getResponseContent()

server response content retrieval

getResponseHeaders

IAttributeSet getResponseHeaders()

server response headers retrieval

setLength

void setLength(long length)

update file length

isTempFile

boolean isTempFile()

check whether file is temporary

isDownloading

boolean isDownloading()

shows whether is downloading

isEditing

boolean isEditing()

shows whether is editing

getKey

java.lang.String getKey()

retrieve general purpose key

setKey

void setKey(java.lang.String key)

store general purpose key

isDocumentFileWasLocked

boolean isDocumentFileWasLocked()

shows whether document file ever was locked

setDocumentFileWasLocked

void setDocumentFileWasLocked(boolean documentFileWasLocked)

set document file ever was locked flag