X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..6746dc89c47ed01b165cc1152533605f97eb8e8d:/docs/source/Operation.html diff --git a/docs/source/Operation.html b/docs/source/Operation.html index d2492cfc..9f02fea0 100644 --- a/docs/source/Operation.html +++ b/docs/source/Operation.html @@ -1,5 +1,22 @@ -
+ +/** - * @author Ed Spencer + + + + +\ No newline at end of file +});The source code + + + + + + +/** + * @author Ed Spencer * @class Ext.data.Operation * @extends Object * @@ -9,53 +26,51 @@ * * <p>Several Operations can be batched together in a {@link Ext.data.Batch batch}.</p> * - * @constructor - * @param {Object} config Optional config object */ Ext.define('Ext.data.Operation', { - /** + /** * @cfg {Boolean} synchronous True if this Operation is to be executed synchronously (defaults to true). This * property is inspected by a {@link Ext.data.Batch Batch} to see if a series of Operations can be executed in * parallel or not. */ synchronous: true, - /** + /** * @cfg {String} action The action being performed by this Operation. Should be one of 'create', 'read', 'update' or 'destroy' */ action: undefined, - /** + /** * @cfg {Array} filters Optional array of filter objects. Only applies to 'read' actions. */ filters: undefined, - /** + /** * @cfg {Array} sorters Optional array of sorter objects. Only applies to 'read' actions. */ sorters: undefined, - /** + /** * @cfg {Object} group Optional grouping configuration. Only applies to 'read' actions where grouping is desired. */ group: undefined, - /** + /** * @cfg {Number} start The start index (offset), used in paging when running a 'read' action. */ start: undefined, - /** + /** * @cfg {Number} limit The number of records to load. Used on 'read' actions when paging is being used. */ limit: undefined, - /** + /** * @cfg {Ext.data.Batch} batch The batch that this Operation is a part of (optional) */ batch: undefined, - /** + /** * Read-only property tracking the start status of this Operation. Use {@link #isStarted}. * @property started * @type Boolean @@ -63,7 +78,7 @@ Ext.define('Ext.data.Operation', { */ started: false, - /** + /** * Read-only property tracking the run status of this Operation. Use {@link #isRunning}. * @property running * @type Boolean @@ -71,7 +86,7 @@ Ext.define('Ext.data.Operation', { */ running: false, - /** + /** * Read-only property tracking the completion status of this Operation. Use {@link #isComplete}. * @property complete * @type Boolean @@ -79,7 +94,7 @@ Ext.define('Ext.data.Operation', { */ complete: false, - /** + /** * Read-only property tracking whether the Operation was successful or not. This starts as undefined and is set to true * or false by the Proxy that is executing the Operation. It is also set to false by {@link #setException}. Use * {@link #wasSuccessful} to query success status. @@ -89,7 +104,7 @@ Ext.define('Ext.data.Operation', { */ success: undefined, - /** + /** * Read-only property tracking the exception status of this Operation. Use {@link #hasException} and see {@link #getError}. * @property exception * @type Boolean @@ -97,19 +112,23 @@ Ext.define('Ext.data.Operation', { */ exception: false, - /** + /** * The error object passed when {@link #setException} was called. This could be any object or primitive. * @property error * @type Mixed * @private */ error: undefined, - + + /** + * Creates new Operation object. + * @param {Object} config (optional) Config object. + */ constructor: function(config) { Ext.apply(this, config || {}); }, - /** + /** * Marks the Operation as started */ setStarted: function() { @@ -117,7 +136,7 @@ Ext.define('Ext.data.Operation', { this.running = true; }, - /** + /** * Marks the Operation as completed */ setCompleted: function() { @@ -125,14 +144,14 @@ Ext.define('Ext.data.Operation', { this.running = false; }, - /** + /** * Marks the Operation as successful */ setSuccessful: function() { this.success = true; }, - /** + /** * Marks the Operation as having experienced an exception. Can be supplied with an option error message/object. * @param {Mixed} error Optional error string/object */ @@ -143,7 +162,7 @@ Ext.define('Ext.data.Operation', { this.error = error; }, - /** + /** * Returns true if this Operation encountered an exception (see also {@link #getError}) * @return {Boolean} True if there was an exception */ @@ -151,7 +170,7 @@ Ext.define('Ext.data.Operation', { return this.exception === true; }, - /** + /** * Returns the error string or object that was set using {@link #setException} * @return {Mixed} The error object */ @@ -159,7 +178,7 @@ Ext.define('Ext.data.Operation', { return this.error; }, - /** + /** * Returns an array of Ext.data.Model instances as set by the Proxy. * @return {Array} Any loaded Records */ @@ -169,7 +188,7 @@ Ext.define('Ext.data.Operation', { return (resultSet === undefined ? this.records : resultSet.records); }, - /** + /** * Returns the ResultSet object (if set by the Proxy). This object will contain the {@link Ext.data.Model model} instances * as well as meta data such as number of instances fetched, number available etc * @return {Ext.data.ResultSet} The ResultSet object @@ -178,7 +197,7 @@ Ext.define('Ext.data.Operation', { return this.resultSet; }, - /** + /** * Returns true if the Operation has been started. Note that the Operation may have started AND completed, * see {@link #isRunning} to test if the Operation is currently running. * @return {Boolean} True if the Operation has started @@ -187,7 +206,7 @@ Ext.define('Ext.data.Operation', { return this.started === true; }, - /** + /** * Returns true if the Operation has been started but has not yet completed. * @return {Boolean} True if the Operation is currently running */ @@ -195,7 +214,7 @@ Ext.define('Ext.data.Operation', { return this.running === true; }, - /** + /** * Returns true if the Operation has been completed * @return {Boolean} True if the Operation is complete */ @@ -203,7 +222,7 @@ Ext.define('Ext.data.Operation', { return this.complete === true; }, - /** + /** * Returns true if the Operation has completed and was successful * @return {Boolean} True if successful */ @@ -211,7 +230,7 @@ Ext.define('Ext.data.Operation', { return this.isComplete() && this.success === true; }, - /** + /** * @private * Associates this Operation with a Batch * @param {Ext.data.Batch} batch The batch @@ -220,11 +239,13 @@ Ext.define('Ext.data.Operation', { this.batch = batch; }, - /** + /** * Checks whether this operation should cause writing to occur. * @return {Boolean} Whether the operation should cause a write to occur. */ allowWrite: function() { return this.action != 'read'; } -});