org.wisepersist.gwt.uploader.client.events

Class UploadErrorEvent

java.lang.Object

org.wisepersist.gwt.uploader.client.events.UploadEvent

org.wisepersist.gwt.uploader.client.events.UploadErrorEvent

public class UploadErrorEvent
extends UploadEvent

Provides access to the raw information provided by Uploader when an 'uploader error' event occurs. This class should not be instantiated directly, but instead you should create a UploadErrorHandler and register it via the .Uploader#setUploadErrorHandler(UploadErrorHandler) method in order to access uploader error events.

Note that the 'uploadError' event is fired any time an uploader is interrupted or does not complete successfully. The error code parameter indicates the type of error that occurred.

Stopping, Cancelling or returning 'false' from uploadStart will cause uploadError to fire. Uploader error will not fire for files that are cancelled but still waiting in the queue.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UploadErrorEvent.ErrorCode An enumeration of reported uploaded error code types.

Constructor Summary

Constructors

Constructor and Description
UploadErrorEvent(File file, int errorCode, java.lang.String message) This constructor is intended for internal use only.

Method Summary

Modifier and Type	Method and Description
UploadErrorEvent.ErrorCode	getErrorCode() The error code returned by the Uploader component in the case of an uploader failure, conveniently converted to an enumeration type.
int	getErrorCodeAsInt() The original numeric error code returned by the Uploader component in the case of an uploader failure.
java.lang.String	getMessage() Return a human readable error message explaining the cause of the uploader failure.

Methods inherited from class org.wisepersist.gwt.uploader.client.events.UploadEvent

getFile

Methods inherited from class java.lang.Object

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

Constructor Detail

UploadErrorEvent

public UploadErrorEvent(File file,
                        int errorCode,
                        java.lang.String message)

This constructor is intended for internal use only. You should not create uploader error events directly, but instead should register a UploadErrorHandler.

Parameters:

file - The native javascript object containing the details of the file being uploaded.

errorCode - The error code returned by the Uploader component in the case of an uploader failure.

message - A human readable error message explaining the cause of the uploader failure.

Method Detail

getErrorCode

public UploadErrorEvent.ErrorCode getErrorCode()

The error code returned by the Uploader component in the case of an uploader failure, conveniently converted to an enumeration type.

Returns:

ErrorCode

getErrorCodeAsInt

public int getErrorCodeAsInt()

The original numeric error code returned by the Uploader component in the case of an uploader failure.

Returns:

int

getMessage

public java.lang.String getMessage()

Return a human readable error message explaining the cause of the uploader failure.

Returns:

String