X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/0494b8d9b9bb03ab6c22b34dae81261e3cd7e3e6..7a654f8d43fdb43d78b63d90528bed6e86b608cc:/docs/api/Ext.data.Operation.html diff --git a/docs/api/Ext.data.Operation.html b/docs/api/Ext.data.Operation.html new file mode 100644 index 00000000..c9e83b5c --- /dev/null +++ b/docs/api/Ext.data.Operation.html @@ -0,0 +1,113 @@ +Ext.data.Operation | Ext JS 4.0 Documentation +
For up to date documentation and features, visit +http://docs.sencha.com/ext-js/4-0

Sencha Documentation

+ + + + + +

Represents a single read or write operation performed by a Proxy. +Operation objects are used to enable communication between Stores and Proxies. Application +developers should rarely need to interact with Operation objects directly.

+ + + + +

Several Operations can be batched together in a batch.

+ +
Defined By

Config Options

Other Configs

 

The action being performed by this Operation. Should be one of 'create', 'read', 'update' or 'destroy'

+

The action being performed by this Operation. Should be one of 'create', 'read', 'update' or 'destroy'

+
 

The batch that this Operation is a part of (optional)

+

The batch that this Operation is a part of (optional)

+
 

Optional array of filter objects. Only applies to 'read' actions.

+

Optional array of filter objects. Only applies to 'read' actions.

+
 

Optional grouping configuration. Only applies to 'read' actions where grouping is desired.

+

Optional grouping configuration. Only applies to 'read' actions where grouping is desired.

+
 

The number of records to load. Used on 'read' actions when paging is being used.

+

The number of records to load. Used on 'read' actions when paging is being used.

+
 

Optional array of sorter objects. Only applies to 'read' actions.

+

Optional array of sorter objects. Only applies to 'read' actions.

+
 

The start index (offset), used in paging when running a 'read' action.

+

The start index (offset), used in paging when running a 'read' action.

+
 
True if this Operation is to be executed synchronously (defaults to true). This +property is inspected by a Batch to s...

True if this Operation is to be executed synchronously (defaults to true). This +property is inspected by a Batch to see if a series of Operations can be executed in +parallel or not.

+
Defined By

Methods

 
Operation( +Object config) + : void

 

+

Parameters

  • config : Object

    Optional config object

    +

Returns

  • void    +
 

Checks whether this operation should cause writing to occur.

+

Checks whether this operation should cause writing to occur.

+

Returns

  • Boolean   

    Whether the operation should cause a write to occur.

    +
 

Returns the error string or object that was set using setException

+

Returns the error string or object that was set using setException

+

Returns

  • Mixed   

    The error object

    +
 

Returns an array of Ext.data.Model instances as set by the Proxy.

+

Returns an array of Ext.data.Model instances as set by the Proxy.

+

Returns

  • Array   

    Any loaded Records

    +
 
Returns the ResultSet object (if set by the Proxy). This object will contain the model instances +as well as meta data...

Returns the ResultSet object (if set by the Proxy). This object will contain the model instances +as well as meta data such as number of instances fetched, number available etc

+

Returns

  • Ext.data.ResultSet   

    The ResultSet object

    +
 

Returns true if this Operation encountered an exception (see also getError)

+

Returns true if this Operation encountered an exception (see also getError)

+

Returns

  • Boolean   

    True if there was an exception

    +
 

Returns true if the Operation has been completed

+

Returns true if the Operation has been completed

+

Returns

  • Boolean   

    True if the Operation is complete

    +
 

Returns true if the Operation has been started but has not yet completed.

+

Returns true if the Operation has been started but has not yet completed.

+

Returns

  • Boolean   

    True if the Operation is currently running

    +
 
Returns true if the Operation has been started. Note that the Operation may have started AND completed, +see isRunning...

Returns true if the Operation has been started. Note that the Operation may have started AND completed, +see isRunning to test if the Operation is currently running.

+

Returns

  • Boolean   

    True if the Operation has started

    +
 

Marks the Operation as completed

+

Marks the Operation as completed

+

Returns

  • void    +
 

Marks the Operation as having experienced an exception. Can be supplied with an option error message/object.

+

Marks the Operation as having experienced an exception. Can be supplied with an option error message/object.

+

Parameters

  • error : Mixed

    Optional error string/object

    +

Returns

  • void    +
 

Marks the Operation as started

+

Marks the Operation as started

+

Returns

  • void    +
 

Marks the Operation as successful

+

Marks the Operation as successful

+

Returns

  • void    +
 

Returns true if the Operation has completed and was successful

+

Returns true if the Operation has completed and was successful

+

Returns

  • Boolean   

    True if successful

    +
\ No newline at end of file