com.blockchyp.client.dto

Class UploadStatus

java.lang.Object

com.blockchyp.client.dto.UploadStatus

All Implemented Interfaces:

IAbstractAcknowledgement

public class UploadStatus
extends Object
implements IAbstractAcknowledgement

Models the current status of a file upload.

Constructor Summary

Constructors

Constructor and Description
UploadStatus()

Method Summary

Modifier and Type	Method and Description
String	getError() Gets the error, if an error occurred.
int	getFileSize() Gets the size of the file to be uploaded in bytes.
String	getId() Gets id used to track status and progress of an upload while in progress.
String	getMediaId() Gets the media id assigned to the result.
int	getPercentage() Gets current upload progress rounded to the nearest integer.
String	getResponseDescription() Gets a narrative description of the transaction result.
String	getStatus() Gets the current status of a file upload.
String	getThumbnailLocation() Gets the url of a thumbnail for the file, if available.
int	getUploadedAmount() Gets the amount of the file already uploaded.
boolean	isComplete() Gets whether or not the upload and associated file processing is complete.
boolean	isProcessing() Gets whether or not the file is processing.
boolean	isSuccess() Gets whether or not the request succeeded.
void	setComplete(boolean value) Sets whether or not the upload and associated file processing is complete.
void	setError(String value) Sets the error, if an error occurred.
void	setFileSize(int value) Sets the size of the file to be uploaded in bytes.
void	setId(String value) Sets id used to track status and progress of an upload while in progress.
void	setMediaId(String value) Sets the media id assigned to the result.
void	setPercentage(int value) Sets current upload progress rounded to the nearest integer.
void	setProcessing(boolean value) Sets whether or not the file is processing.
void	setResponseDescription(String value) Sets a narrative description of the transaction result.
void	setStatus(String value) Sets the current status of a file upload.
void	setSuccess(boolean value) Sets whether or not the request succeeded.
void	setThumbnailLocation(String value) Sets the url of a thumbnail for the file, if available.
void	setUploadedAmount(int value) Sets the amount of the file already uploaded.

Methods inherited from class java.lang.Object

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

Constructor Detail

UploadStatus

public UploadStatus()

Method Detail

setSuccess

public void setSuccess(boolean value)

Sets whether or not the request succeeded.

Parameters:

value - whether or not the request succeeded.

isSuccess

public boolean isSuccess()

Gets whether or not the request succeeded.

Specified by:

isSuccess in interface IAbstractAcknowledgement

Returns:

whether or not the request succeeded.

setError

public void setError(String value)

Sets the error, if an error occurred.

Parameters:

value - the error, if an error occurred.

getError

public String getError()

Gets the error, if an error occurred.

Specified by:

getError in interface IAbstractAcknowledgement

Returns:

the error, if an error occurred.

setResponseDescription

public void setResponseDescription(String value)

Sets a narrative description of the transaction result.

Parameters:

value - a narrative description of the transaction result.

getResponseDescription

public String getResponseDescription()

Gets a narrative description of the transaction result.

Specified by:

getResponseDescription in interface IAbstractAcknowledgement

Returns:

a narrative description of the transaction result.

setId

public void setId(String value)

Sets id used to track status and progress of an upload while in progress.

Parameters:

value - id used to track status and progress of an upload while in progress.

getId

public String getId()

Gets id used to track status and progress of an upload while in progress.

Returns:

id used to track status and progress of an upload while in progress.

setMediaId

public void setMediaId(String value)

Sets the media id assigned to the result.

Parameters:

value - the media id assigned to the result.

getMediaId

public String getMediaId()

Gets the media id assigned to the result.

Returns:

the media id assigned to the result.

setFileSize

public void setFileSize(int value)

Sets the size of the file to be uploaded in bytes.

Parameters:

value - the size of the file to be uploaded in bytes.

getFileSize

public int getFileSize()

Gets the size of the file to be uploaded in bytes.

Returns:

the size of the file to be uploaded in bytes.

setUploadedAmount

public void setUploadedAmount(int value)

Sets the amount of the file already uploaded.

Parameters:

value - the amount of the file already uploaded.

getUploadedAmount

public int getUploadedAmount()

Gets the amount of the file already uploaded.

Returns:

the amount of the file already uploaded.

setStatus

public void setStatus(String value)

Sets the current status of a file upload.

Parameters:

value - the current status of a file upload.

getStatus

public String getStatus()

Gets the current status of a file upload.

Returns:

the current status of a file upload.

setComplete

public void setComplete(boolean value)

Sets whether or not the upload and associated file processing is complete.

Parameters:

value - whether or not the upload and associated file processing is complete.

isComplete

public boolean isComplete()

Gets whether or not the upload and associated file processing is complete.

Returns:

whether or not the upload and associated file processing is complete.

setProcessing

public void setProcessing(boolean value)

Sets whether or not the file is processing.

Parameters:

value - whether or not the file is processing. This normally applied to video files undergoing format transcoding.

isProcessing

public boolean isProcessing()

Gets whether or not the file is processing.

Returns:

whether or not the file is processing. This normally applied to video files undergoing format transcoding.

setPercentage

public void setPercentage(int value)

Sets current upload progress rounded to the nearest integer.

Parameters:

value - current upload progress rounded to the nearest integer.

getPercentage

public int getPercentage()

Gets current upload progress rounded to the nearest integer.

Returns:

current upload progress rounded to the nearest integer.

setThumbnailLocation

public void setThumbnailLocation(String value)

Sets the url of a thumbnail for the file, if available.

Parameters:

value - the url of a thumbnail for the file, if available.

getThumbnailLocation

public String getThumbnailLocation()

Gets the url of a thumbnail for the file, if available.

Returns:

the url of a thumbnail for the file, if available.