com.smartgwt.client.util

Class AsyncOperationResult

java.lang.Object

com.smartgwt.client.core.JsObject

com.smartgwt.client.core.DataClass

com.smartgwt.client.core.RefDataClass

com.smartgwt.client.util.AsyncOperationResult

All Implemented Interfaces:

com.google.gwt.event.shared.HasHandlers

Direct Known Subclasses:

AIResponse, BuildViaAIResponse, SummarizeRecordsPartialResult, SummarizeRecordsResult, SummarizeValueResult

public class AsyncOperationResult
extends RefDataClass

An object containing information about the result of an asynchronous operation.

Note: isc.defaultAsyncOperationCatchCallback() can be used to provide default error handling for a Promise-based asynchronous operation.

Field Summary

Fields inherited from class com.smartgwt.client.core.RefDataClass

id

Fields inherited from class com.smartgwt.client.core.DataClass

factoryCreated, factoryProperties

Fields inherited from class com.smartgwt.client.core.JsObject

jsObj

Constructor Summary

Constructors

Constructor and Description
AsyncOperationResult()
AsyncOperationResult(com.google.gwt.core.client.JavaScriptObject jsObj)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCancellationReason() If this is a CANCELED-type result, the reason for cancellation, if provided.
java.lang.String	getErrorMessage() If this is an ERROR-type result, a message describing the error, if available.
static AsyncOperationResult	getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
AsyncOperationResultType	getType() The result type.
AsyncOperationResult	setCancellationReason(java.lang.String cancellationReason) If this is a CANCELED-type result, the reason for cancellation, if provided.
AsyncOperationResult	setErrorMessage(java.lang.String errorMessage) If this is an ERROR-type result, a message describing the error, if available.
AsyncOperationResult	setType(AsyncOperationResultType type) The result type.

Methods inherited from class com.smartgwt.client.core.RefDataClass

getRef, getRef, internalSetID

Methods inherited from class com.smartgwt.client.core.DataClass

applyFactoryProperties, doAddHandler, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsDoubleArray, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getAttributes, getHandlerCount, isFactoryCreated, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreated

Methods inherited from class com.smartgwt.client.core.JsObject

equals, getJsObj, hashCode, isCreated, setJavaScriptObject, setJsObj

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncOperationResult

public AsyncOperationResult()

AsyncOperationResult

public AsyncOperationResult(com.google.gwt.core.client.JavaScriptObject jsObj)

Method Detail

getOrCreateRef

public static AsyncOperationResult getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)

setCancellationReason

public AsyncOperationResult setCancellationReason(java.lang.String cancellationReason)

If this is a CANCELED-type result, the reason for cancellation, if provided.

Parameters:

cancellationReason - New cancellationReason value. Default value is null

Returns:

AsyncOperationResult instance, for chaining setter calls

See Also:

CancellationController.cancel()

getCancellationReason

public java.lang.String getCancellationReason()

If this is a CANCELED-type result, the reason for cancellation, if provided.

Returns:

Current cancellationReason value. Default value is null

See Also:

CancellationController.cancel()

setErrorMessage

public AsyncOperationResult setErrorMessage(java.lang.String errorMessage)

If this is an ERROR-type result, a message describing the error, if available.

Parameters:

errorMessage - New errorMessage value. Default value is null

Returns:

AsyncOperationResult instance, for chaining setter calls

getErrorMessage

public java.lang.String getErrorMessage()

If this is an ERROR-type result, a message describing the error, if available.

Returns:

Current errorMessage value. Default value is null

setType

public AsyncOperationResult setType(AsyncOperationResultType type)

The result type.

It is up to the implementation to define the meaning of type null. It is recommended, though, that implementations do not use null and instead specify an explicit AsyncOperationResultType.

Parameters:

type - New type value. Default value is *initialized by the implementation*

Returns:

AsyncOperationResult instance, for chaining setter calls

getType

public AsyncOperationResultType getType()

The result type.

It is up to the implementation to define the meaning of type null. It is recommended, though, that implementations do not use null and instead specify an explicit AsyncOperationResultType.

Returns:

Current type value. Default value is *initialized by the implementation*