Ext.data.JsonP.Ext_data_Operation({"mixins":[],"code_type":"ext_define","inheritable":false,"component":false,"meta":{"author":["Ed Spencer"]},"mixedInto":[],"uses":[],"aliases":{},"parentMixins":[],"superclasses":["Ext.Base"],"members":{"event":[],"property":[{"meta":{"private":true},"owner":"Ext.Base","tagname":"property","name":"$className","id":"property-S-className"},{"meta":{},"owner":"Ext.data.Operation","tagname":"property","name":"actionCommitRecordsRe","id":"property-actionCommitRecordsRe"},{"meta":{},"owner":"Ext.data.Operation","tagname":"property","name":"actionSkipSyncRe","id":"property-actionSkipSyncRe"},{"meta":{"readonly":true,"private":true},"owner":"Ext.data.Operation","tagname":"property","name":"complete","id":"property-complete"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"property","name":"configMap","id":"property-configMap"},{"meta":{"private":true},"owner":"Ext.data.Operation","tagname":"property","name":"error","id":"property-error"},{"meta":{"readonly":true,"private":true},"owner":"Ext.data.Operation","tagname":"property","name":"exception","id":"property-exception"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"property","name":"initConfigList","id":"property-initConfigList"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"property","name":"initConfigMap","id":"property-initConfigMap"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"property","name":"isInstance","id":"property-isInstance"},{"meta":{"readonly":true,"private":true},"owner":"Ext.data.Operation","tagname":"property","name":"running","id":"property-running"},{"meta":{"protected":true},"owner":"Ext.Base","tagname":"property","name":"self","id":"property-self"},{"meta":{"readonly":true,"private":true},"owner":"Ext.data.Operation","tagname":"property","name":"started","id":"property-started"},{"meta":{"readonly":true,"private":true},"owner":"Ext.data.Operation","tagname":"property","name":"success","id":"property-success"}],"css_var":[],"method":[{"meta":{},"owner":"Ext.data.Operation","tagname":"method","name":"constructor","id":"method-constructor"},{"meta":{},"owner":"Ext.data.Operation","tagname":"method","name":"allowWrite","id":"method-allowWrite"},{"meta":{"deprecated":{"text":"as of 4.1. Use {@link #callParent} instead."},"protected":true},"owner":"Ext.Base","tagname":"method","name":"callOverridden","id":"method-callOverridden"},{"meta":{"protected":true},"owner":"Ext.Base","tagname":"method","name":"callParent","id":"method-callParent"},{"meta":{"markdown":true},"owner":"Ext.data.Operation","tagname":"method","name":"commitRecords","id":"method-commitRecords"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"method","name":"configClass","id":"method-configClass"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"method","name":"destroy","id":"method-destroy"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"method","name":"getConfig","id":"method-getConfig"},{"meta":{},"owner":"Ext.data.Operation","tagname":"method","name":"getError","id":"method-getError"},{"meta":{},"owner":"Ext.Base","tagname":"method","name":"getInitialConfig","id":"method-getInitialConfig"},{"meta":{},"owner":"Ext.data.Operation","tagname":"method","name":"getRecords","id":"method-getRecords"},{"meta":{},"owner":"Ext.data.Operation","tagname":"method","name":"getResultSet","id":"method-getResultSet"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"method","name":"hasConfig","id":"method-hasConfig"},{"meta":{},"owner":"Ext.data.Operation","tagname":"method","name":"hasException","id":"method-hasException"},{"meta":{"protected":true},"owner":"Ext.Base","tagname":"method","name":"initConfig","id":"method-initConfig"},{"meta":{},"owner":"Ext.data.Operation","tagname":"method","name":"isComplete","id":"method-isComplete"},{"meta":{},"owner":"Ext.data.Operation","tagname":"method","name":"isRunning","id":"method-isRunning"},{"meta":{},"owner":"Ext.data.Operation","tagname":"method","name":"isStarted","id":"method-isStarted"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"method","name":"onConfigUpdate","id":"method-onConfigUpdate"},{"meta":{"private":true},"owner":"Ext.data.Operation","tagname":"method","name":"setBatch","id":"method-setBatch"},{"meta":{},"owner":"Ext.data.Operation","tagname":"method","name":"setCompleted","id":"method-setCompleted"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"method","name":"setConfig","id":"method-setConfig"},{"meta":{},"owner":"Ext.data.Operation","tagname":"method","name":"setException","id":"method-setException"},{"meta":{},"owner":"Ext.data.Operation","tagname":"method","name":"setStarted","id":"method-setStarted"},{"meta":{},"owner":"Ext.data.Operation","tagname":"method","name":"setSuccessful","id":"method-setSuccessful"},{"meta":{"protected":true},"owner":"Ext.Base","tagname":"method","name":"statics","id":"method-statics"},{"meta":{},"owner":"Ext.data.Operation","tagname":"method","name":"wasSuccessful","id":"method-wasSuccessful"}],"css_mixin":[],"cfg":[{"meta":{},"owner":"Ext.data.Operation","tagname":"cfg","name":"action","id":"cfg-action"},{"meta":{},"owner":"Ext.data.Operation","tagname":"cfg","name":"batch","id":"cfg-batch"},{"meta":{},"owner":"Ext.data.Operation","tagname":"cfg","name":"callback","id":"cfg-callback"},{"meta":{},"owner":"Ext.data.Operation","tagname":"cfg","name":"filters","id":"cfg-filters"},{"meta":{},"owner":"Ext.data.Operation","tagname":"cfg","name":"groupers","id":"cfg-groupers"},{"meta":{},"owner":"Ext.data.Operation","tagname":"cfg","name":"limit","id":"cfg-limit"},{"meta":{},"owner":"Ext.data.Operation","tagname":"cfg","name":"params","id":"cfg-params"},{"meta":{},"owner":"Ext.data.Operation","tagname":"cfg","name":"scope","id":"cfg-scope"},{"meta":{},"owner":"Ext.data.Operation","tagname":"cfg","name":"sorters","id":"cfg-sorters"},{"meta":{},"owner":"Ext.data.Operation","tagname":"cfg","name":"start","id":"cfg-start"},{"meta":{},"owner":"Ext.data.Operation","tagname":"cfg","name":"synchronous","id":"cfg-synchronous"}]},"tagname":"class","extends":"Ext.Base","html":"
Hierarchy
Ext.BaseExt.data.OperationFiles
Represents a single read or write operation performed by a Proxy. Operation objects are\nused to enable communication between Stores and Proxies. Application developers should rarely need to interact with\nOperation objects directly.
\n\nSeveral Operations can be batched together in a batch.
\nThe action being performed by this Operation. Should be one of 'create', 'read', 'update' or 'destroy'.
\nFunction to execute when operation completed.
\nArray of records.
\nThe Operation itself.
\nTrue when operation completed successfully.
\nOptional array of filter objects. Only applies to 'read' actions.
\nOptional grouping configuration. Only applies to 'read' actions where grouping is desired.
\nThe number of records to load. Used on 'read' actions when paging is being used.
\nParameters to pass along with the request when performing the operation.
\nParameters to pass along with the request when performing the operation.
\nOptional array of sorter objects. Only applies to 'read' actions.
\nThe start index (offset), used in paging when running a 'read' action.
\nTrue if this Operation is to be executed synchronously. This property is inspected by a\nBatch to see if a series of Operations can be executed in parallel or not.
\nDefaults to: true
The RegExp used to categorize actions that require record commits.
\nDefaults to: /^(?:create|update)$/i
The RegExp used to categorize actions that skip local record synchronization. This defaults\nto match 'destroy'.
\nDefaults to: /^destroy$/i
The completion status of this Operation. Use isComplete.
\nDefaults to: false
The error object passed when setException was called. This could be any object or primitive.
\nThe exception status of this Operation. Use hasException and see getError.
\nDefaults to: false
The run status of this Operation. Use isRunning.
\nDefaults to: false
Get the reference to the current class from which this object was instantiated. Unlike statics,\nthis.self
is scope-dependent and it's meant to be used for dynamic inheritance. See statics\nfor a detailed comparison
Ext.define('My.Cat', {\n statics: {\n speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n },\n\n constructor: function() {\n alert(this.self.speciesName); // dependent on 'this'\n },\n\n clone: function() {\n return new this.self();\n }\n});\n\n\nExt.define('My.SnowLeopard', {\n extend: 'My.Cat',\n statics: {\n speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'\n }\n});\n\nvar cat = new My.Cat(); // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'\n
\nThe start status of this Operation. Use isStarted.
\nDefaults to: false
Whether the Operation was successful or not. This starts as undefined and is set to true\nor false by the Proxy that is executing the Operation. It is also set to false by setException. Use\nwasSuccessful to query success status.
\nChecks whether this operation should cause writing to occur.
\nWhether the operation should cause a write to occur.
\nCall the original method that was previously overridden with override
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\n
\n This method has been deprecated
\nas of 4.1. Use callParent instead.
\n\nThe arguments, either an array or the arguments
object\nfrom the current method, for example: this.callOverridden(arguments)
Returns the result of calling the overridden method
\nCall the \"parent\" method of the current method. That is the method previously\noverridden by derivation or by an override (see Ext.define).
\n\n Ext.define('My.Base', {\n constructor: function (x) {\n this.x = x;\n },\n\n statics: {\n method: function (x) {\n return x;\n }\n }\n });\n\n Ext.define('My.Derived', {\n extend: 'My.Base',\n\n constructor: function () {\n this.callParent([21]);\n }\n });\n\n var obj = new My.Derived();\n\n alert(obj.x); // alerts 21\n
\n\nThis can be used with an override as follows:
\n\n Ext.define('My.DerivedOverride', {\n override: 'My.Derived',\n\n constructor: function (x) {\n this.callParent([x*2]); // calls original My.Derived constructor\n }\n });\n\n var obj = new My.Derived();\n\n alert(obj.x); // now alerts 42\n
\n\nThis also works with static methods.
\n\n Ext.define('My.Derived2', {\n extend: 'My.Base',\n\n statics: {\n method: function (x) {\n return this.callParent([x*2]); // calls My.Base.method\n }\n }\n });\n\n alert(My.Base.method(10); // alerts 10\n alert(My.Derived2.method(10); // alerts 20\n
\n\nLastly, it also works with overridden static methods.
\n\n Ext.define('My.Derived2Override', {\n override: 'My.Derived2',\n\n statics: {\n method: function (x) {\n return this.callParent([x*2]); // calls My.Derived2.method\n }\n }\n });\n\n alert(My.Derived2.method(10); // now alerts 40\n
\nThe arguments, either an array or the arguments
object\nfrom the current method, for example: this.callParent(arguments)
Returns the result of calling the parent method
\nThis method is called to commit data to this instance's records given the records in\nthe server response. This is followed by calling Ext.data.Model.commit on all\nthose records (for 'create' and 'update' actions).
\n\nIf this action is 'destroy', any server records are ignored and the\nExt.data.Model.commit method is not called.
\nAn array of Ext.data.Model objects returned by\nthe server.
\nReturns the error string or object that was set using setException
\nReturns the records associated with this operation. For read operations the records as set by the Proxy will be returned (returns null
if the proxy has not yet set the records).\nFor create, update, and destroy operations the operation's initially configured records will be returned, although the proxy may modify these records' data at some point after the operation is initialized.
Returns the ResultSet object (if set by the Proxy). This object will contain the model\ninstances as well as meta data such as number of instances fetched, number available etc
\nThe ResultSet object
\nInitialize configuration for this class. a typical example:
\n\nExt.define('My.awesome.Class', {\n // The default config\n config: {\n name: 'Awesome',\n isAwesome: true\n },\n\n constructor: function(config) {\n this.initConfig(config);\n }\n});\n\nvar awesome = new My.awesome.Class({\n name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n
\nthis
\nReturns true if the Operation has been started but has not yet completed.
\nTrue if the Operation is currently running
\nGet the reference to the class from which this object was instantiated. Note that unlike self,\nthis.statics()
is scope-independent and it always returns the class from which it was called, regardless of what\nthis
points to during run-time
Ext.define('My.Cat', {\n statics: {\n totalCreated: 0,\n speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n },\n\n constructor: function() {\n var statics = this.statics();\n\n alert(statics.speciesName); // always equals to 'Cat' no matter what 'this' refers to\n // equivalent to: My.Cat.speciesName\n\n alert(this.self.speciesName); // dependent on 'this'\n\n statics.totalCreated++;\n },\n\n clone: function() {\n var cloned = new this.self; // dependent on 'this'\n\n cloned.groupName = this.statics().speciesName; // equivalent to: My.Cat.speciesName\n\n return cloned;\n }\n});\n\n\nExt.define('My.SnowLeopard', {\n extend: 'My.Cat',\n\n statics: {\n speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'\n },\n\n constructor: function() {\n this.callParent();\n }\n});\n\nvar cat = new My.Cat(); // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'\nalert(clone.groupName); // alerts 'Cat'\n\nalert(My.Cat.totalCreated); // alerts 3\n
\nAdd methods / properties to the prototype of this class.
\n\nExt.define('My.awesome.Cat', {\n constructor: function() {\n ...\n }\n});\n\n My.awesome.Cat.addMembers({\n meow: function() {\n alert('Meowww...');\n }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n
\nAdd / override static properties of this class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.addStatics({\n someProperty: 'someValue', // My.cool.Class.someProperty = 'someValue'\n method1: function() { ... }, // My.cool.Class.method1 = function() { ... };\n method2: function() { ... } // My.cool.Class.method2 = function() { ... };\n});\n
\nthis
\nBorrow another class' members to the prototype of this class.
\n\nExt.define('Bank', {\n money: '$$$',\n printMoney: function() {\n alert('$$$$$$$');\n }\n});\n\nExt.define('Thief', {\n ...\n});\n\nThief.borrow(Bank, ['money', 'printMoney']);\n\nvar steve = new Thief();\n\nalert(steve.money); // alerts '$$$'\nsteve.printMoney(); // alerts '$$$$$$$'\n
\nThe class to borrow members from
\nThe names of the members to borrow
\nthis
\nCreate a new instance of this Class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.create({\n someConfig: true\n});\n
\n\nAll parameters are passed to the constructor of the class.
\nthe created instance.
\nCreate aliases for existing prototype methods. Example:
\n\nExt.define('My.cool.Class', {\n method1: function() { ... },\n method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n method3: 'method1',\n method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -> test.method1()\n
\nThe new method name, or an object to set multiple aliases. See\nflexSetter
\nThe original method name
\nGet the current class' name in string format.
\n\nExt.define('My.cool.Class', {\n constructor: function() {\n alert(this.self.getName()); // alerts 'My.cool.Class'\n }\n});\n\nMy.cool.Class.getName(); // 'My.cool.Class'\n
\nclassName
\nAdds members to class.
\nThis method has been deprecated since 4.1
\nUse addMembers instead.
\n\nOverride members of this class. Overridden methods can be invoked via\ncallParent.
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n this.callParent(arguments);\n\n alert(\"Meeeeoooowwww\");\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\n
\n\nAs of 4.1, direct use of this method is deprecated. Use Ext.define\ninstead:
\n\nExt.define('My.CatOverride', {\n override: 'My.Cat',\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n this.callParent(arguments);\n\n alert(\"Meeeeoooowwww\");\n }\n});\n
\n\nThe above accomplishes the same result but can be managed by the Ext.Loader\nwhich can properly order the override and its target class and the build process\ncan determine whether the override is needed based on the required state of the\ntarget class (My.Cat).
\nThis method has been deprecated since 4.1.0
\nUse Ext.define instead
\n\nThe properties to add to this class. This should be\nspecified as an object literal containing one or more properties.
\nthis class
\n