UpdateRequestTask

Overview

This class is an inheritor of RequestTask and is returned as a result of RemoteDataAdapter calls. No result value is expected to get from the task, as provided tables will be optionally updated internally on task completion.

Check base class for additional customization options.

Location

 

constructor (Callable<Void>, UpdateRequestTask.Callback)  protected    (declared in RequestTask<TResult,TCallback>)

 

constructor(aCallable: Callable<Void>; aCallback: UpdateRequestTask.Callback)

 

UpdateRequestTask(Callable<Void> aCallable, UpdateRequestTask.Callback aCallback)

Parameters:

  • aCallable:
  • aCallback:

constructor (Runnable, Callback)  protected

 

constructor(aRunnable: Runnable; aCallback: Callback)

 

UpdateRequestTask(Runnable aRunnable, Callback aCallback)

Parameters:

  • aRunnable:
  • aCallback:

constructor (Runnable, Void, UpdateRequestTask.Callback)  protected    (declared in RequestTask<TResult,TCallback>)

 

constructor(aRunnable: Runnable; aResult: Void; aCallback: UpdateRequestTask.Callback)

 

UpdateRequestTask(Runnable aRunnable, Void aResult, UpdateRequestTask.Callback aCallback)

Parameters:

  • aRunnable:
  • aResult:
  • aCallback:

CallbackExecutor    (declared in RequestTask<TResult,TCallback>)

 

property CallbackExecutor: Executor read write;

 

Executor CallbackExecutor { __get; __set; }

cancel    (declared in RequestTask<TResult,TCallback>)

Attempts to cancel execution of this task. This attempt will fail if the task has already completed, already been cancelled, or could not be cancelled for some other reason. If successful, and this task has not started when cancel is called, this task should never run. If the task has already started, then the mayInterruptIfRunning parameter determines whether the thread executing this task should be interrupted in an attempt to stop the task.

 

method cancel(mayInterruptIfRunning: Boolean): Boolean

 

Boolean cancel(Boolean mayInterruptIfRunning)

Parameters:

  • mayInterruptIfRunning: TRUE if the thread executing this task should be interrupted; otherwise, in-progress tasks are allowed to complete

execute    (declared in RequestTask<TResult,TCallback>)

Executes the given command at some time in the future. The command may execute in a new thread, in a pooled thread, or in the calling thread, at the discretion of the Executor implementation.


Executor    (declared in RequestTask<TResult,TCallback>)

 

property Executor: Executor read write;

 

Executor Executor { __get; __set; }

FailureCause    (declared in RequestTask<TResult,TCallback>)

 

property FailureCause: Throwable read write;

 

Throwable FailureCause { __get; __set; }

get    (declared in RequestTask<TResult,TCallback>)

Waits if necessary for the computation to complete, and then retrieves its result.

 

method get: Void

 

Void get()

get (Long, TimeUnit)    (declared in RequestTask<TResult,TCallback>)

Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.

 

method get(aTimeout: Long; aUnit: TimeUnit): Void

 

Void get(Long aTimeout, TimeUnit aUnit)

Parameters:

  • aTimeout: the maximum time to wait
  • aUnit: the time unit of the timeout argument

isCancelled    (declared in RequestTask<TResult,TCallback>)

Returns TRUE if this task was cancelled before it completed normally.

 

method isCancelled: Boolean

 

Boolean isCancelled()

isFailed    (declared in RequestTask<TResult,TCallback>)

Returns TRUE if an exception was thrown during task execution. Call getFailureCause to get the exception.

 

method isFailed: Boolean

 

Boolean isFailed()

onFutureDone  protected    (declared in RequestTask<TResult,TCallback>)

 

method onFutureDone

 

void onFutureDone()

setCallback  protected    (declared in RequestTask<TResult,TCallback>)

Sets the callback to invoke on task completion. NULL is possible.

 

method setCallback(aCallback: UpdateRequestTask.Callback)

 

void setCallback(UpdateRequestTask.Callback aCallback)

Parameters:

  • aCallback: the callback instance to invoke.

State    (declared in RequestTask<TResult,TCallback>)

 

property State: Object read write;

 

Object State { __get; __set; }

Status    (declared in RequestTask<TResult,TCallback>)

 

property Status: Status read;

 

Status Status { __get; }

 

CallbackExecutor    (declared in RequestTask<TResult,TCallback>)

 

property CallbackExecutor: Executor read write;

 

Executor CallbackExecutor { __get; __set; }

Executor    (declared in RequestTask<TResult,TCallback>)

 

property Executor: Executor read write;

 

Executor Executor { __get; __set; }

FailureCause    (declared in RequestTask<TResult,TCallback>)

 

property FailureCause: Throwable read write;

 

Throwable FailureCause { __get; __set; }

State    (declared in RequestTask<TResult,TCallback>)

 

property State: Object read write;

 

Object State { __get; __set; }

Status    (declared in RequestTask<TResult,TCallback>)

 

property Status: Status read;

 

Status Status { __get; }

 

constructor (Callable<Void>, UpdateRequestTask.Callback)  protected    (declared in RequestTask<TResult,TCallback>)

 

constructor(aCallable: Callable<Void>; aCallback: UpdateRequestTask.Callback)

 

UpdateRequestTask(Callable<Void> aCallable, UpdateRequestTask.Callback aCallback)

Parameters:

  • aCallable:
  • aCallback:

constructor (Runnable, Callback)  protected

 

constructor(aRunnable: Runnable; aCallback: Callback)

 

UpdateRequestTask(Runnable aRunnable, Callback aCallback)

Parameters:

  • aRunnable:
  • aCallback:

constructor (Runnable, Void, UpdateRequestTask.Callback)  protected    (declared in RequestTask<TResult,TCallback>)

 

constructor(aRunnable: Runnable; aResult: Void; aCallback: UpdateRequestTask.Callback)

 

UpdateRequestTask(Runnable aRunnable, Void aResult, UpdateRequestTask.Callback aCallback)

Parameters:

  • aRunnable:
  • aResult:
  • aCallback:

cancel    (declared in RequestTask<TResult,TCallback>)

Attempts to cancel execution of this task. This attempt will fail if the task has already completed, already been cancelled, or could not be cancelled for some other reason. If successful, and this task has not started when cancel is called, this task should never run. If the task has already started, then the mayInterruptIfRunning parameter determines whether the thread executing this task should be interrupted in an attempt to stop the task.

 

method cancel(mayInterruptIfRunning: Boolean): Boolean

 

Boolean cancel(Boolean mayInterruptIfRunning)

Parameters:

  • mayInterruptIfRunning: TRUE if the thread executing this task should be interrupted; otherwise, in-progress tasks are allowed to complete

execute    (declared in RequestTask<TResult,TCallback>)

Executes the given command at some time in the future. The command may execute in a new thread, in a pooled thread, or in the calling thread, at the discretion of the Executor implementation.


get    (declared in RequestTask<TResult,TCallback>)

Waits if necessary for the computation to complete, and then retrieves its result.

 

method get: Void

 

Void get()

get (Long, TimeUnit)    (declared in RequestTask<TResult,TCallback>)

Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.

 

method get(aTimeout: Long; aUnit: TimeUnit): Void

 

Void get(Long aTimeout, TimeUnit aUnit)

Parameters:

  • aTimeout: the maximum time to wait
  • aUnit: the time unit of the timeout argument

isCancelled    (declared in RequestTask<TResult,TCallback>)

Returns TRUE if this task was cancelled before it completed normally.

 

method isCancelled: Boolean

 

Boolean isCancelled()

isFailed    (declared in RequestTask<TResult,TCallback>)

Returns TRUE if an exception was thrown during task execution. Call getFailureCause to get the exception.

 

method isFailed: Boolean

 

Boolean isFailed()

onFutureDone  protected    (declared in RequestTask<TResult,TCallback>)

 

method onFutureDone

 

void onFutureDone()

setCallback  protected    (declared in RequestTask<TResult,TCallback>)

Sets the callback to invoke on task completion. NULL is possible.

 

method setCallback(aCallback: UpdateRequestTask.Callback)

 

void setCallback(UpdateRequestTask.Callback aCallback)

Parameters:

  • aCallback: the callback instance to invoke.