X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..3789b528d8dd8aad4558e38e22d775bcab1cbd36:/docs/output/Ext.data.Operation.js?ds=sidebyside diff --git a/docs/output/Ext.data.Operation.js b/docs/output/Ext.data.Operation.js new file mode 100644 index 00000000..45b93797 --- /dev/null +++ b/docs/output/Ext.data.Operation.js @@ -0,0 +1,437 @@ +Ext.data.JsonP.Ext_data_Operation({ + "tagname": "class", + "name": "Ext.data.Operation", + "doc": "

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

\n\n\n\n\n

Several Operations can be batched together in a batch.

\n\n", + "extends": "Object", + "mixins": [ + + ], + "alternateClassNames": [ + + ], + "xtype": null, + "author": "Ed Spencer", + "docauthor": null, + "singleton": false, + "private": false, + "cfg": [ + { + "tagname": "cfg", + "name": "action", + "member": "Ext.data.Operation", + "type": "String", + "doc": "

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

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js", + "linenr": 23, + "html_filename": "Operation.html", + "href": "Operation.html#Ext-data-Operation-cfg-action" + }, + { + "tagname": "cfg", + "name": "batch", + "member": "Ext.data.Operation", + "type": "Ext.data.Batch", + "doc": "

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

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js", + "linenr": 53, + "html_filename": "Operation.html", + "href": "Operation.html#Ext-data-Operation-cfg-batch" + }, + { + "tagname": "cfg", + "name": "filters", + "member": "Ext.data.Operation", + "type": "Array", + "doc": "

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

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js", + "linenr": 28, + "html_filename": "Operation.html", + "href": "Operation.html#Ext-data-Operation-cfg-filters" + }, + { + "tagname": "cfg", + "name": "group", + "member": "Ext.data.Operation", + "type": "Object", + "doc": "

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

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js", + "linenr": 38, + "html_filename": "Operation.html", + "href": "Operation.html#Ext-data-Operation-cfg-group" + }, + { + "tagname": "cfg", + "name": "limit", + "member": "Ext.data.Operation", + "type": "Number", + "doc": "

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

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js", + "linenr": 48, + "html_filename": "Operation.html", + "href": "Operation.html#Ext-data-Operation-cfg-limit" + }, + { + "tagname": "cfg", + "name": "sorters", + "member": "Ext.data.Operation", + "type": "Array", + "doc": "

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

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js", + "linenr": 33, + "html_filename": "Operation.html", + "href": "Operation.html#Ext-data-Operation-cfg-sorters" + }, + { + "tagname": "cfg", + "name": "start", + "member": "Ext.data.Operation", + "type": "Number", + "doc": "

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

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js", + "linenr": 43, + "html_filename": "Operation.html", + "href": "Operation.html#Ext-data-Operation-cfg-start" + }, + { + "tagname": "cfg", + "name": "synchronous", + "member": "Ext.data.Operation", + "type": "Boolean", + "doc": "

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

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js", + "linenr": 16, + "html_filename": "Operation.html", + "href": "Operation.html#Ext-data-Operation-cfg-synchronous", + "shortDoc": "True if this Operation is to be executed synchronously (defaults to true). This\nproperty is inspected by a Batch to s..." + } + ], + "method": [ + { + "tagname": "method", + "name": "Operation", + "member": "Ext.data.Operation", + "doc": "\n", + "params": [ + { + "type": "Object", + "name": "config", + "doc": "

Optional config object

\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js", + "linenr": 1, + "html_filename": "Operation.html", + "href": "Operation.html#Ext-data-Operation-method-constructor", + "shortDoc": "\n" + }, + { + "tagname": "method", + "name": "allowWrite", + "member": "Ext.data.Operation", + "doc": "

Checks whether this operation should cause writing to occur.

\n", + "params": [ + + ], + "return": { + "type": "Boolean", + "doc": "

Whether the operation should cause a write to occur.

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js", + "linenr": 223, + "html_filename": "Operation.html", + "href": "Operation.html#Ext-data-Operation-method-allowWrite", + "shortDoc": "

Checks whether this operation should cause writing to occur.

\n" + }, + { + "tagname": "method", + "name": "getError", + "member": "Ext.data.Operation", + "doc": "

Returns the error string or object that was set using setException

\n", + "params": [ + + ], + "return": { + "type": "Mixed", + "doc": "

The error object

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js", + "linenr": 154, + "html_filename": "Operation.html", + "href": "Operation.html#Ext-data-Operation-method-getError", + "shortDoc": "

Returns the error string or object that was set using setException

\n" + }, + { + "tagname": "method", + "name": "getRecords", + "member": "Ext.data.Operation", + "doc": "

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

\n", + "params": [ + + ], + "return": { + "type": "Array", + "doc": "

Any loaded Records

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js", + "linenr": 162, + "html_filename": "Operation.html", + "href": "Operation.html#Ext-data-Operation-method-getRecords", + "shortDoc": "

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

\n" + }, + { + "tagname": "method", + "name": "getResultSet", + "member": "Ext.data.Operation", + "doc": "

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

\n", + "params": [ + + ], + "return": { + "type": "Ext.data.ResultSet", + "doc": "

The ResultSet object

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js", + "linenr": 172, + "html_filename": "Operation.html", + "href": "Operation.html#Ext-data-Operation-method-getResultSet", + "shortDoc": "Returns the ResultSet object (if set by the Proxy). This object will contain the model instances\nas well as meta data..." + }, + { + "tagname": "method", + "name": "hasException", + "member": "Ext.data.Operation", + "doc": "

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

\n", + "params": [ + + ], + "return": { + "type": "Boolean", + "doc": "

True if there was an exception

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js", + "linenr": 146, + "html_filename": "Operation.html", + "href": "Operation.html#Ext-data-Operation-method-hasException", + "shortDoc": "

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

\n" + }, + { + "tagname": "method", + "name": "isComplete", + "member": "Ext.data.Operation", + "doc": "

Returns true if the Operation has been completed

\n", + "params": [ + + ], + "return": { + "type": "Boolean", + "doc": "

True if the Operation is complete

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js", + "linenr": 198, + "html_filename": "Operation.html", + "href": "Operation.html#Ext-data-Operation-method-isComplete", + "shortDoc": "

Returns true if the Operation has been completed

\n" + }, + { + "tagname": "method", + "name": "isRunning", + "member": "Ext.data.Operation", + "doc": "

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

\n", + "params": [ + + ], + "return": { + "type": "Boolean", + "doc": "

True if the Operation is currently running

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js", + "linenr": 190, + "html_filename": "Operation.html", + "href": "Operation.html#Ext-data-Operation-method-isRunning", + "shortDoc": "

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

\n" + }, + { + "tagname": "method", + "name": "isStarted", + "member": "Ext.data.Operation", + "doc": "

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

\n", + "params": [ + + ], + "return": { + "type": "Boolean", + "doc": "

True if the Operation has started

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js", + "linenr": 181, + "html_filename": "Operation.html", + "href": "Operation.html#Ext-data-Operation-method-isStarted", + "shortDoc": "Returns true if the Operation has been started. Note that the Operation may have started AND completed,\nsee isRunning..." + }, + { + "tagname": "method", + "name": "setCompleted", + "member": "Ext.data.Operation", + "doc": "

Marks the Operation as completed

\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js", + "linenr": 120, + "html_filename": "Operation.html", + "href": "Operation.html#Ext-data-Operation-method-setCompleted", + "shortDoc": "

Marks the Operation as completed

\n" + }, + { + "tagname": "method", + "name": "setException", + "member": "Ext.data.Operation", + "doc": "

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

\n", + "params": [ + { + "type": "Mixed", + "name": "error", + "doc": "

Optional error string/object

\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js", + "linenr": 135, + "html_filename": "Operation.html", + "href": "Operation.html#Ext-data-Operation-method-setException", + "shortDoc": "

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

\n" + }, + { + "tagname": "method", + "name": "setStarted", + "member": "Ext.data.Operation", + "doc": "

Marks the Operation as started

\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js", + "linenr": 112, + "html_filename": "Operation.html", + "href": "Operation.html#Ext-data-Operation-method-setStarted", + "shortDoc": "

Marks the Operation as started

\n" + }, + { + "tagname": "method", + "name": "setSuccessful", + "member": "Ext.data.Operation", + "doc": "

Marks the Operation as successful

\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js", + "linenr": 128, + "html_filename": "Operation.html", + "href": "Operation.html#Ext-data-Operation-method-setSuccessful", + "shortDoc": "

Marks the Operation as successful

\n" + }, + { + "tagname": "method", + "name": "wasSuccessful", + "member": "Ext.data.Operation", + "doc": "

Returns true if the Operation has completed and was successful

\n", + "params": [ + + ], + "return": { + "type": "Boolean", + "doc": "

True if successful

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js", + "linenr": 206, + "html_filename": "Operation.html", + "href": "Operation.html#Ext-data-Operation-method-wasSuccessful", + "shortDoc": "

Returns true if the Operation has completed and was successful

\n" + } + ], + "property": [ + + ], + "event": [ + + ], + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js", + "linenr": 1, + "html_filename": "Operation.html", + "href": "Operation.html#Ext-data-Operation", + "cssVar": [ + + ], + "cssMixin": [ + + ], + "component": false, + "superclasses": [ + + ], + "subclasses": [ + + ], + "mixedInto": [ + + ], + "allMixins": [ + + ] +}); \ No newline at end of file