Class type Ext_data_Batch.t

class type t = object .. end

Inherits

method current : Js.number Js.t Js.prop

The index of the current operation being executed. Read only

method exceptions : Ext_data_Operation.t Js.js_array Js.t Js.prop

Ordered array of operations that raised an exception during the most recent batch execution and did not successfully complete

method hasException : bool Js.t Js.prop

True if this batch has encountered an exception. This is cleared at the start of each operation. Read only

Defaults to: false

method isComplete : bool Js.t Js.prop

True if this batch has been executed completely. Read only

Defaults to: false

method isRunning : bool Js.t Js.prop

True if the batch is currently running. Read only

Defaults to: false

method operations : Ext_data_Operation.t Js.js_array Js.t Js.prop

Ordered array of operations that will be executed by this batch

method total : Js.number Js.t Js.prop

The total number of operations in this batch. Read only

Defaults to: 0

method add : 'a.
         'a Js.t ->
         (< add : 'a. 'b; addEvents : 'd. 'd Js.t -> unit Js.meth;
            addListener : 'e 'f 'g 'h 'i.
                            'e Js.t ->
                            'f Js.callback Js.optdef ->
                            'g Js.t Js.optdef ->
                            'h Js.t Js.optdef -> 'i Js.t Js.meth;
            addManagedListener : 'j 'k 'l 'm 'n 'o.
                                   'j Js.t ->
                                   'k Js.t ->
                                   'l Js.callback Js.optdef ->
                                   'm Js.t Js.optdef ->
                                   'n Js.t Js.optdef -> 'o Js.t Js.meth;
            callParent : 'p 'q. 'p Js.t -> 'q Js.t Js.meth;
            callSuper : 'r 's. 'r Js.t -> 's Js.t Js.meth;
            clearListeners : unit Js.meth; clearManagedListeners : unit Js.meth;
            current : Js.number Js.t Js.prop;
            enableBubble : 't. 't Js.t -> unit Js.meth;
            exceptions : Ext_data_Operation.t Js.js_array Js.t Js.prop;
            fireEvent : 'u. Js.js_string Js.t -> 'u Js.t -> bool Js.t Js.meth;
            fireEventArgs : 'v.
                              Js.js_string Js.t ->
                              'v Js.t Js.js_array Js.t -> bool Js.t Js.meth;
            getInitialConfig : 'w. Js.js_string Js.t Js.optdef -> 'w Js.t Js.meth;
            hasException : bool Js.t Js.prop;
            hasListener : Js.js_string Js.t -> bool Js.t Js.meth;
            hasListeners : 'x. 'x Js.t Js.readonly_prop;
            initConfig : 'y. 'y Js.t -> 'c Js.t Js.meth;
            isComplete : bool Js.t Js.prop; isObservable : bool Js.t Js.prop;
            isRunning : bool Js.t Js.prop;
            mon : 'z 'a1 'b1 'c1 'd1 'e1.
                    'z Js.t ->
                    'a1 Js.t ->
                    'b1 Js.callback Js.optdef ->
                    'c1 Js.t Js.optdef -> 'd1 Js.t Js.optdef -> 'e1 Js.t Js.meth;
            mun : 'f1 'g1 'h1 'i1.
                    'f1 Js.t ->
                    'g1 Js.t ->
                    'h1 Js.callback Js.optdef -> 'i1 Js.t Js.optdef -> unit Js.meth;
            on : 'j1 'k1 'l1 'm1 'n1.
                   'j1 Js.t ->
                   'k1 Js.callback Js.optdef ->
                   'l1 Js.t Js.optdef -> 'm1 Js.t Js.optdef -> 'n1 Js.t Js.meth;
            operations : Ext_data_Operation.t Js.js_array Js.t Js.prop;
            pause : 'c Js.t Js.meth;
            relayEvents : 'o1 'p1.
                            'o1 Js.t ->
                            Js.js_string Js.t Js.js_array Js.t ->
                            Js.js_string Js.t Js.optdef -> 'p1 Js.t Js.meth;
            removeListener : 'q1 'r1.
                               Js.js_string Js.t ->
                               'q1 Js.callback -> 'r1 Js.t Js.optdef -> unit Js.meth;
            removeManagedListener : 's1 't1 'u1 'v1.
                                      's1 Js.t ->
                                      't1 Js.t ->
                                      'u1 Js.callback Js.optdef ->
                                      'v1 Js.t Js.optdef -> unit Js.meth;
            resumeEvent : Js.js_string Js.t -> unit Js.meth;
            resumeEvents : unit Js.meth; retry : 'c Js.t Js.meth;
            runOperation : Js.number Js.t -> 'c Js.t Js.meth;
            self : Ext_Class.t Js.t Js.prop;
            start : 'w1. 'w1 Js.t -> 'c Js.t Js.meth;
            statics : Ext_Class.t Js.t Js.meth;
            suspendEvent : Js.js_string Js.t -> unit Js.meth;
            suspendEvents : bool Js.t -> unit Js.meth;
            total : Js.number Js.t Js.prop;
            un : 'x1 'y1.
                   Js.js_string Js.t ->
                   'x1 Js.callback -> 'y1 Js.t Js.optdef -> unit Js.meth;
            .. >
          as 'c)
         Js.t Js.meth as 'b

Adds a new operation to this batch at the end of the operations array

Parameters:

operation: _ Js.t
The Operation object

Returns:

Ext_data_Batch.t Js.t
this

method pause : 'c Js.t Js.meth

Pauses execution of the batch, but does not cancel the current operation

Returns:

Ext_data_Batch.t Js.t
this

method retry : 'c Js.t Js.meth

Kicks off execution of the batch, continuing from the current operation. This is intended for restarting a paused batch after an exception, and the operation that raised the exception will now be retried. The batch will then continue with its normal processing until all operations are complete or another exception is encountered.

Note that if the batch is already running any call to retry will be ignored.

Returns:

Ext_data_Batch.t Js.t
this

method runOperation : Js.number Js.t -> 'c Js.t Js.meth

Executes an operation by its numeric index in the operations array

Parameters:

index: Js.number Js.t
The operation index to run

Returns:

Ext_data_Batch.t Js.t
this

method start : 'w1. 'w1 Js.t -> 'c Js.t Js.meth

Kicks off execution of the batch, continuing from the next operation if the previous operation encountered an exception, or if execution was paused. Use this method to start the batch for the first time or to restart a paused batch by skipping the current unsuccessful operation.

To retry processing the current operation before continuing to the rest of the batch (e.g. because you explicitly handled the operation's exception), call retry instead.

Note that if the batch is already running any call to start will be ignored.

Parameters:

index: _ Js.t

Returns:

Ext_data_Batch.t Js.t
this