docs/output/Ext.data.Operation.js

   1 Ext.data.JsonP.Ext_data_Operation({
   2   "tagname": "class",
   3   "name": "Ext.data.Operation",
   4   "doc": "<p>Represents a single read or write operation performed by a <a href=\"#/api/Ext.data.proxy.Proxy\" rel=\"Ext.data.proxy.Proxy\" class=\"docClass\">Proxy</a>.\nOperation objects are used to enable communication between Stores and Proxies. Application\ndevelopers should rarely need to interact with Operation objects directly.</p>\n\n\n\n\n<p>Several Operations can be batched together in a <a href=\"#/api/Ext.data.Batch\" rel=\"Ext.data.Batch\" class=\"docClass\">batch</a>.</p>\n\n",
   5   "extends": "Object",
   6   "mixins": [
   7
   8   ],
   9   "alternateClassNames": [
  10
  11   ],
  12   "xtype": null,
  13   "author": "Ed Spencer",
  14   "docauthor": null,
  15   "singleton": false,
  16   "private": false,
  17   "cfg": [
  18     {
  19       "tagname": "cfg",
  20       "name": "action",
  21       "member": "Ext.data.Operation",
  22       "type": "String",
  23       "doc": "<p>The action being performed by this Operation. Should be one of 'create', 'read', 'update' or 'destroy'</p>\n",
  24       "private": false,
  25       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js",
  26       "linenr": 23,
  27       "html_filename": "Operation.html",
  28       "href": "Operation.html#Ext-data-Operation-cfg-action"
  29     },
  30     {
  31       "tagname": "cfg",
  32       "name": "batch",
  33       "member": "Ext.data.Operation",
  34       "type": "Ext.data.Batch",
  35       "doc": "<p>The batch that this Operation is a part of (optional)</p>\n",
  36       "private": false,
  37       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js",
  38       "linenr": 53,
  39       "html_filename": "Operation.html",
  40       "href": "Operation.html#Ext-data-Operation-cfg-batch"
  41     },
  42     {
  43       "tagname": "cfg",
  44       "name": "filters",
  45       "member": "Ext.data.Operation",
  46       "type": "Array",
  47       "doc": "<p>Optional array of filter objects. Only applies to 'read' actions.</p>\n",
  48       "private": false,
  49       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js",
  50       "linenr": 28,
  51       "html_filename": "Operation.html",
  52       "href": "Operation.html#Ext-data-Operation-cfg-filters"
  53     },
  54     {
  55       "tagname": "cfg",
  56       "name": "group",
  57       "member": "Ext.data.Operation",
  58       "type": "Object",
  59       "doc": "<p>Optional grouping configuration. Only applies to 'read' actions where grouping is desired.</p>\n",
  60       "private": false,
  61       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js",
  62       "linenr": 38,
  63       "html_filename": "Operation.html",
  64       "href": "Operation.html#Ext-data-Operation-cfg-group"
  65     },
  66     {
  67       "tagname": "cfg",
  68       "name": "limit",
  69       "member": "Ext.data.Operation",
  70       "type": "Number",
  71       "doc": "<p>The number of records to load. Used on 'read' actions when paging is being used.</p>\n",
  72       "private": false,
  73       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js",
  74       "linenr": 48,
  75       "html_filename": "Operation.html",
  76       "href": "Operation.html#Ext-data-Operation-cfg-limit"
  77     },
  78     {
  79       "tagname": "cfg",
  80       "name": "sorters",
  81       "member": "Ext.data.Operation",
  82       "type": "Array",
  83       "doc": "<p>Optional array of sorter objects. Only applies to 'read' actions.</p>\n",
  84       "private": false,
  85       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js",
  86       "linenr": 33,
  87       "html_filename": "Operation.html",
  88       "href": "Operation.html#Ext-data-Operation-cfg-sorters"
  89     },
  90     {
  91       "tagname": "cfg",
  92       "name": "start",
  93       "member": "Ext.data.Operation",
  94       "type": "Number",
  95       "doc": "<p>The start index (offset), used in paging when running a 'read' action.</p>\n",
  96       "private": false,
  97       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js",
  98       "linenr": 43,
  99       "html_filename": "Operation.html",
 100       "href": "Operation.html#Ext-data-Operation-cfg-start"
 101     },
 102     {
 103       "tagname": "cfg",
 104       "name": "synchronous",
 105       "member": "Ext.data.Operation",
 106       "type": "Boolean",
 107       "doc": "<p>True if this Operation is to be executed synchronously (defaults to true). This\nproperty is inspected by a <a href=\"#/api/Ext.data.Batch\" rel=\"Ext.data.Batch\" class=\"docClass\">Batch</a> to see if a series of Operations can be executed in\nparallel or not.</p>\n",
 108       "private": false,
 109       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js",
 110       "linenr": 16,
 111       "html_filename": "Operation.html",
 112       "href": "Operation.html#Ext-data-Operation-cfg-synchronous",
 113       "shortDoc": "True if this Operation is to be executed synchronously (defaults to true). This\nproperty is inspected by a Batch to s..."
 114     }
 115   ],
 116   "method": [
 117     {
 118       "tagname": "method",
 119       "name": "Operation",
 120       "member": "Ext.data.Operation",
 121       "doc": "\n",
 122       "params": [
 123         {
 124           "type": "Object",
 125           "name": "config",
 126           "doc": "<p>Optional config object</p>\n",
 127           "optional": false
 128         }
 129       ],
 130       "return": {
 131         "type": "void",
 132         "doc": "\n"
 133       },
 134       "private": false,
 135       "static": false,
 136       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js",
 137       "linenr": 1,
 138       "html_filename": "Operation.html",
 139       "href": "Operation.html#Ext-data-Operation-method-constructor",
 140       "shortDoc": "\n"
 141     },
 142     {
 143       "tagname": "method",
 144       "name": "allowWrite",
 145       "member": "Ext.data.Operation",
 146       "doc": "<p>Checks whether this operation should cause writing to occur.</p>\n",
 147       "params": [
 148
 149       ],
 150       "return": {
 151         "type": "Boolean",
 152         "doc": "<p>Whether the operation should cause a write to occur.</p>\n"
 153       },
 154       "private": false,
 155       "static": false,
 156       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js",
 157       "linenr": 223,
 158       "html_filename": "Operation.html",
 159       "href": "Operation.html#Ext-data-Operation-method-allowWrite",
 160       "shortDoc": "<p>Checks whether this operation should cause writing to occur.</p>\n"
 161     },
 162     {
 163       "tagname": "method",
 164       "name": "getError",
 165       "member": "Ext.data.Operation",
 166       "doc": "<p>Returns the error string or object that was set using <a href=\"#/api/Ext.data.Operation-method-setException\" rel=\"Ext.data.Operation-method-setException\" class=\"docClass\">setException</a></p>\n",
 167       "params": [
 168
 169       ],
 170       "return": {
 171         "type": "Mixed",
 172         "doc": "<p>The error object</p>\n"
 173       },
 174       "private": false,
 175       "static": false,
 176       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js",
 177       "linenr": 154,
 178       "html_filename": "Operation.html",
 179       "href": "Operation.html#Ext-data-Operation-method-getError",
 180       "shortDoc": "<p>Returns the error string or object that was set using <a href=\"#/api/Ext.data.Operation-method-setException\" rel=\"Ext.data.Operation-method-setException\" class=\"docClass\">setException</a></p>\n"
 181     },
 182     {
 183       "tagname": "method",
 184       "name": "getRecords",
 185       "member": "Ext.data.Operation",
 186       "doc": "<p>Returns an array of <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Ext.data.Model</a> instances as set by the Proxy.</p>\n",
 187       "params": [
 188
 189       ],
 190       "return": {
 191         "type": "Array",
 192         "doc": "<p>Any loaded Records</p>\n"
 193       },
 194       "private": false,
 195       "static": false,
 196       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js",
 197       "linenr": 162,
 198       "html_filename": "Operation.html",
 199       "href": "Operation.html#Ext-data-Operation-method-getRecords",
 200       "shortDoc": "<p>Returns an array of <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Ext.data.Model</a> instances as set by the Proxy.</p>\n"
 201     },
 202     {
 203       "tagname": "method",
 204       "name": "getResultSet",
 205       "member": "Ext.data.Operation",
 206       "doc": "<p>Returns the ResultSet object (if set by the Proxy). This object will contain the <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">model</a> instances\nas well as meta data such as number of instances fetched, number available etc</p>\n",
 207       "params": [
 208
 209       ],
 210       "return": {
 211         "type": "Ext.data.ResultSet",
 212         "doc": "<p>The ResultSet object</p>\n"
 213       },
 214       "private": false,
 215       "static": false,
 216       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js",
 217       "linenr": 172,
 218       "html_filename": "Operation.html",
 219       "href": "Operation.html#Ext-data-Operation-method-getResultSet",
 220       "shortDoc": "Returns the ResultSet object (if set by the Proxy). This object will contain the model instances\nas well as meta data..."
 221     },
 222     {
 223       "tagname": "method",
 224       "name": "hasException",
 225       "member": "Ext.data.Operation",
 226       "doc": "<p>Returns true if this Operation encountered an exception (see also <a href=\"#/api/Ext.data.Operation-method-getError\" rel=\"Ext.data.Operation-method-getError\" class=\"docClass\">getError</a>)</p>\n",
 227       "params": [
 228
 229       ],
 230       "return": {
 231         "type": "Boolean",
 232         "doc": "<p>True if there was an exception</p>\n"
 233       },
 234       "private": false,
 235       "static": false,
 236       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js",
 237       "linenr": 146,
 238       "html_filename": "Operation.html",
 239       "href": "Operation.html#Ext-data-Operation-method-hasException",
 240       "shortDoc": "<p>Returns true if this Operation encountered an exception (see also <a href=\"#/api/Ext.data.Operation-method-getError\" rel=\"Ext.data.Operation-method-getError\" class=\"docClass\">getError</a>)</p>\n"
 241     },
 242     {
 243       "tagname": "method",
 244       "name": "isComplete",
 245       "member": "Ext.data.Operation",
 246       "doc": "<p>Returns true if the Operation has been completed</p>\n",
 247       "params": [
 248
 249       ],
 250       "return": {
 251         "type": "Boolean",
 252         "doc": "<p>True if the Operation is complete</p>\n"
 253       },
 254       "private": false,
 255       "static": false,
 256       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js",
 257       "linenr": 198,
 258       "html_filename": "Operation.html",
 259       "href": "Operation.html#Ext-data-Operation-method-isComplete",
 260       "shortDoc": "<p>Returns true if the Operation has been completed</p>\n"
 261     },
 262     {
 263       "tagname": "method",
 264       "name": "isRunning",
 265       "member": "Ext.data.Operation",
 266       "doc": "<p>Returns true if the Operation has been started but has not yet completed.</p>\n",
 267       "params": [
 268
 269       ],
 270       "return": {
 271         "type": "Boolean",
 272         "doc": "<p>True if the Operation is currently running</p>\n"
 273       },
 274       "private": false,
 275       "static": false,
 276       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js",
 277       "linenr": 190,
 278       "html_filename": "Operation.html",
 279       "href": "Operation.html#Ext-data-Operation-method-isRunning",
 280       "shortDoc": "<p>Returns true if the Operation has been started but has not yet completed.</p>\n"
 281     },
 282     {
 283       "tagname": "method",
 284       "name": "isStarted",
 285       "member": "Ext.data.Operation",
 286       "doc": "<p>Returns true if the Operation has been started. Note that the Operation may have started AND completed,\nsee <a href=\"#/api/Ext.data.Operation-method-isRunning\" rel=\"Ext.data.Operation-method-isRunning\" class=\"docClass\">isRunning</a> to test if the Operation is currently running.</p>\n",
 287       "params": [
 288
 289       ],
 290       "return": {
 291         "type": "Boolean",
 292         "doc": "<p>True if the Operation has started</p>\n"
 293       },
 294       "private": false,
 295       "static": false,
 296       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js",
 297       "linenr": 181,
 298       "html_filename": "Operation.html",
 299       "href": "Operation.html#Ext-data-Operation-method-isStarted",
 300       "shortDoc": "Returns true if the Operation has been started. Note that the Operation may have started AND completed,\nsee isRunning..."
 301     },
 302     {
 303       "tagname": "method",
 304       "name": "setCompleted",
 305       "member": "Ext.data.Operation",
 306       "doc": "<p>Marks the Operation as completed</p>\n",
 307       "params": [
 308
 309       ],
 310       "return": {
 311         "type": "void",
 312         "doc": "\n"
 313       },
 314       "private": false,
 315       "static": false,
 316       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js",
 317       "linenr": 120,
 318       "html_filename": "Operation.html",
 319       "href": "Operation.html#Ext-data-Operation-method-setCompleted",
 320       "shortDoc": "<p>Marks the Operation as completed</p>\n"
 321     },
 322     {
 323       "tagname": "method",
 324       "name": "setException",
 325       "member": "Ext.data.Operation",
 326       "doc": "<p>Marks the Operation as having experienced an exception. Can be supplied with an option error message/object.</p>\n",
 327       "params": [
 328         {
 329           "type": "Mixed",
 330           "name": "error",
 331           "doc": "<p>Optional error string/object</p>\n",
 332           "optional": false
 333         }
 334       ],
 335       "return": {
 336         "type": "void",
 337         "doc": "\n"
 338       },
 339       "private": false,
 340       "static": false,
 341       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js",
 342       "linenr": 135,
 343       "html_filename": "Operation.html",
 344       "href": "Operation.html#Ext-data-Operation-method-setException",
 345       "shortDoc": "<p>Marks the Operation as having experienced an exception. Can be supplied with an option error message/object.</p>\n"
 346     },
 347     {
 348       "tagname": "method",
 349       "name": "setStarted",
 350       "member": "Ext.data.Operation",
 351       "doc": "<p>Marks the Operation as started</p>\n",
 352       "params": [
 353
 354       ],
 355       "return": {
 356         "type": "void",
 357         "doc": "\n"
 358       },
 359       "private": false,
 360       "static": false,
 361       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js",
 362       "linenr": 112,
 363       "html_filename": "Operation.html",
 364       "href": "Operation.html#Ext-data-Operation-method-setStarted",
 365       "shortDoc": "<p>Marks the Operation as started</p>\n"
 366     },
 367     {
 368       "tagname": "method",
 369       "name": "setSuccessful",
 370       "member": "Ext.data.Operation",
 371       "doc": "<p>Marks the Operation as successful</p>\n",
 372       "params": [
 373
 374       ],
 375       "return": {
 376         "type": "void",
 377         "doc": "\n"
 378       },
 379       "private": false,
 380       "static": false,
 381       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js",
 382       "linenr": 128,
 383       "html_filename": "Operation.html",
 384       "href": "Operation.html#Ext-data-Operation-method-setSuccessful",
 385       "shortDoc": "<p>Marks the Operation as successful</p>\n"
 386     },
 387     {
 388       "tagname": "method",
 389       "name": "wasSuccessful",
 390       "member": "Ext.data.Operation",
 391       "doc": "<p>Returns true if the Operation has completed and was successful</p>\n",
 392       "params": [
 393
 394       ],
 395       "return": {
 396         "type": "Boolean",
 397         "doc": "<p>True if successful</p>\n"
 398       },
 399       "private": false,
 400       "static": false,
 401       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js",
 402       "linenr": 206,
 403       "html_filename": "Operation.html",
 404       "href": "Operation.html#Ext-data-Operation-method-wasSuccessful",
 405       "shortDoc": "<p>Returns true if the Operation has completed and was successful</p>\n"
 406     }
 407   ],
 408   "property": [
 409
 410   ],
 411   "event": [
 412
 413   ],
 414   "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Operation.js",
 415   "linenr": 1,
 416   "html_filename": "Operation.html",
 417   "href": "Operation.html#Ext-data-Operation",
 418   "cssVar": [
 419
 420   ],
 421   "cssMixin": [
 422
 423   ],
 424   "component": false,
 425   "superclasses": [
 426
 427   ],
 428   "subclasses": [
 429
 430   ],
 431   "mixedInto": [
 432
 433   ],
 434   "allMixins": [
 435
 436   ]
 437 });