docs/output/Ext.data.Operation.js

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