sproutcore 1.6.0.beta.3-java → 1.6.0-java

data/lib/frameworks/sproutcore/frameworks/datastore/models/child_record.js

@@ -9,13 +9,13 @@ sc_require('models/record');
 
 /**
   @class
-  @deprecated
+  @deprecated SC.ChildRecord is deprecated. Please extend SC.Record instead.
 */
 SC.ChildRecord = SC.Record.extend({});
 
 SC.ChildRecord.extend = function() {
-  //@ if (debug)
+  // @if (debug)
   console.log("SC.ChildRecord is deprecated. Please extend SC.Record instead.");
-  //@ endif
+  // @endif
   return SC.Record.extend.apply(this, arguments);
 };

data/lib/frameworks/sproutcore/frameworks/datastore/models/record.js

@@ -10,27 +10,27 @@ sc_require('system/query');
 /**
   @class
 
-  A Record is the core model class in SproutCore. It is analogous to 
+  A Record is the core model class in SproutCore. It is analogous to
   NSManagedObject in Core Data and EOEnterpriseObject in the Enterprise
   Objects Framework (aka WebObjects), or ActiveRecord::Base in Rails.
-  
+
   To create a new model class, in your SproutCore workspace, do:
-  
+
       $ sc-gen model MyApp.MyModel
-  
+
   This will create MyApp.MyModel in clients/my_app/models/my_model.js.
-  
-  The core attributes hash is used to store the values of a record in a 
-  format that can be easily passed to/from the server.  The values should 
-  generally be stored in their raw string form.  References to external 
+
+  The core attributes hash is used to store the values of a record in a
+  format that can be easily passed to/from the server.  The values should
+  generally be stored in their raw string form.  References to external
   records should be stored as primary keys.
-  
-  Normally you do not need to work with the attributes hash directly.  
-  Instead you should use get/set on normal record properties.  If the 
-  property is not defined on the object, then the record will check the 
+
+  Normally you do not need to work with the attributes hash directly.
+  Instead you should use get/set on normal record properties.  If the
+  property is not defined on the object, then the record will check the
   attributes hash instead.
-  
-  You can bulk update attributes from the server using the 
+
+  You can bulk update attributes from the server using the
   `updateAttributes()` method.
 
   @extends SC.Object
@@ -39,42 +39,42 @@ sc_require('system/query');
 */
 SC.Record = SC.Object.extend(
 /** @scope SC.Record.prototype */ {
-  
-  /**  
+
+  /**
     Walk like a duck
-  
+
     @type Boolean
     @default YES
   */
   isRecord: YES,
-  
+
   /**
     If you have nested records
-    
+
     @type Boolean
     @default NO
   */
   isParentRecord: NO,
-  
+
   // ...............................
   // PROPERTIES
   //
-  
+
   /**
     This is the primary key used to distinguish records.  If the keys
     match, the records are assumed to be identical.
-    
+
     @type String
     @default 'guid'
   */
   primaryKey: 'guid',
-  
+
   /**
-    Returns the id for the record instance.  The id is used to uniquely 
-    identify this record instance from all others of the same type.  If you 
+    Returns the id for the record instance.  The id is used to uniquely
+    identify this record instance from all others of the same type.  If you
     have a `primaryKey set on this class, then the id will be the value of the
     `primaryKey` property on the underlying JSON hash.
-    
+
     @type String
     @property
     @dependsOn storeKey
@@ -87,21 +87,21 @@ SC.Record = SC.Object.extend(
       return SC.Store.idFor(this.storeKey);
     }
   }.property('storeKey').cacheable(),
-  
+
   /**
-    All records generally have a life cycle as they are created or loaded into 
-    memory, modified, committed and finally destroyed.  This life cycle is 
-    managed by the status property on your record. 
+    All records generally have a life cycle as they are created or loaded into
+    memory, modified, committed and finally destroyed.  This life cycle is
+    managed by the status property on your record.
 
-    The status of a record is modelled as a finite state machine.  Based on the 
-    current state of the record, you can determine which operations are 
+    The status of a record is modelled as a finite state machine.  Based on the
+    current state of the record, you can determine which operations are
     currently allowed on the record and which are not.
-    
+
     In general, a record can be in one of five primary states:
     `SC.Record.EMPTY`, `SC.Record.BUSY`, `SC.Record.READY`,
     `SC.Record.DESTROYED`, `SC.Record.ERROR`.  These are all described in
     more detail in the class mixin (below) where they are defined.
-    
+
     @type Number
     @property
     @dependsOn storeKey
@@ -113,47 +113,47 @@ SC.Record = SC.Object.extend(
   /**
     The store that owns this record.  All changes will be buffered into this
     store and committed to the rest of the store chain through here.
-    
+
     This property is set when the record instance is created and should not be
     changed or else it will break the record behavior.
-    
+
     @type SC.Store
     @default null
   */
   store: null,
 
   /**
-    This is the store key for the record, it is used to link it back to the 
+    This is the store key for the record, it is used to link it back to the
     dataHash. If a record is reused, this value will be replaced.
-    
+
     You should not edit this store key but you may sometimes need to refer to
     this store key when implementing a Server object.
-    
+
     @type Number
     @default null
   */
   storeKey: null,
 
-  /** 
+  /**
     YES when the record has been destroyed
-    
+
     @type Boolean
     @property
     @dependsOn status
   */
   isDestroyed: function() {
-    return !!(this.get('status') & SC.Record.DESTROYED);  
+    return !!(this.get('status') & SC.Record.DESTROYED);
   }.property('status').cacheable(),
-  
+
   /**
     `YES` when the record is in an editable state.  You can use this property to
-    quickly determine whether attempting to modify the record would raise an 
+    quickly determine whether attempting to modify the record would raise an
     exception or not.
-    
-    This property is both readable and writable.  Note however that if you 
+
+    This property is both readable and writable.  Note however that if you
     set this property to `YES` but the status of the record is anything but
     `SC.Record.READY`, the return value of this property may remain `NO`.
-    
+
     @type Boolean
     @property
     @dependsOn status
@@ -166,49 +166,49 @@ SC.Record = SC.Object.extend(
 
   /**
     @private
-    
+
     Backing value for isEditable
   */
   _screc_isEditable: YES, // default
 
   /**
-    `YES` when the record's contents have been loaded for the first time.  You 
+    `YES` when the record's contents have been loaded for the first time.  You
     can use this to quickly determine if the record is ready to display.
-    
+
     @type Boolean
     @property
     @dependsOn status
   */
   isLoaded: function() {
-    var K = SC.Record, 
+    var K = SC.Record,
         status = this.get('status');
     return !((status===K.EMPTY) || (status===K.BUSY_LOADING) || (status===K.ERROR));
   }.property('status').cacheable(),
-  
+
   /**
     If set, this should be an array of active relationship objects that need
-    to be notified whenever the underlying record properties change.  
-    Currently this is only used by toMany relationships, but you could 
-    possibly patch into this yourself also if you are building your own 
+    to be notified whenever the underlying record properties change.
+    Currently this is only used by toMany relationships, but you could
+    possibly patch into this yourself also if you are building your own
     relationships.
-    
+
     Note this must be a regular Array - NOT any object implementing SC.Array.
-    
+
     @type Array
     @default null
   */
   relationships: null,
 
   /**
-    This will return the raw attributes that you can edit directly.  If you 
+    This will return the raw attributes that you can edit directly.  If you
     make changes to this hash, be sure to call `beginEditing()` before you get
     the attributes and `endEditing()` afterwards.
-  
+
     @type Hash
     @property
   **/
   attributes: function() {
-    var store    = this.get('store'), 
+    var store    = this.get('store'),
         storeKey = this.storeKey;
     return store.readEditableDataHash(storeKey);
   }.property(),
@@ -218,31 +218,31 @@ SC.Record = SC.Object.extend(
     useful if you want to efficiently look at multiple attributes in bulk.  If
     you would like to edit the attributes, see the `attributes` property
     instead.
-  
+
     @type Hash
     @property
   **/
   readOnlyAttributes: function() {
-    var store    = this.get('store'), 
+    var store    = this.get('store'),
         storeKey = this.storeKey,
         ret      = store.readDataHash(storeKey);
-    
+
     if (ret) ret = SC.clone(ret, YES);
 
     return ret;
   }.property(),
-  
+
   /**
     The namespace which to retrieve the childRecord Types from
-    
+
     @type String
     @default null
   */
   nestedRecordNamespace: null,
-  
+
   /**
     Whether or not this is a nested Record.
-    
+
     @type Boolean
     @property
   */
@@ -250,14 +250,14 @@ SC.Record = SC.Object.extend(
     var store = this.get('store'), ret,
         sk = this.get('storeKey'),
         prKey = store.parentStoreKeyExists(sk);
-    
+
     ret = prKey ? YES : NO;
     return ret;
   }.property().cacheable(),
-  
+
   /**
     The parent record if this is a nested record.
-    
+
     @type Boolean
     @property
   */
@@ -265,24 +265,24 @@ SC.Record = SC.Object.extend(
     var sk = this.storeKey, store = this.get('store');
     return store.materializeParentRecord(sk);
   }.property(),
-    
+
   // ...............................
   // CRUD OPERATIONS
   //
 
   /**
-    Refresh the record from the persistent store.  If the record was loaded 
-    from a persistent store, then the store will be asked to reload the 
-    record data from the server.  If the record is new and exists only in 
+    Refresh the record from the persistent store.  If the record was loaded
+    from a persistent store, then the store will be asked to reload the
+    record data from the server.  If the record is new and exists only in
     memory then this call will have no effect.
-    
+
     @param {boolean} recordOnly optional param if you want to only THIS record
       even if it is a child record.
     @param {Function} callback optional callback that will fire when request finishes
-    
+
     @returns {SC.Record} receiver
   */
-  refresh: function(recordOnly, callback) { 
+  refresh: function(recordOnly, callback) {
     var store = this.get('store'), rec, ro,
         sk = this.get('storeKey'),
         prKey = store.parentStoreKeyExists();
@@ -299,19 +299,19 @@ SC.Record = SC.Object.extend(
 
     return this ;
   },
-  
+
   /**
-    Deletes the record along with any dependent records.  This will mark the 
-    records destroyed in the store as well as changing the isDestroyed 
-    property on the record to YES.  If this is a new record, this will avoid 
+    Deletes the record along with any dependent records.  This will mark the
+    records destroyed in the store as well as changing the isDestroyed
+    property on the record to YES.  If this is a new record, this will avoid
     creating the record in the first place.
 
     @param {boolean} recordOnly optional param if you want to only THIS record
-      even if it is a child record. 
-    
+      even if it is a child record.
+
     @returns {SC.Record} receiver
   */
-  destroy: function(recordOnly) { 
+  destroy: function(recordOnly) {
     var store = this.get('store'), rec, ro,
         sk = this.get('storeKey'),
         prKey = store.parentStoreKeyExists();
@@ -325,12 +325,12 @@ SC.Record = SC.Object.extend(
       // If there are any aggregate records, we might need to propagate our new
       // status to them.
       this.propagateToAggregates();
-      
+
     } else if (prKey){
       rec = store.materializeRecord(prKey);
       rec.destroy(recordOnly);
     }
-    
+
     return this ;
   },
 
@@ -338,22 +338,22 @@ SC.Record = SC.Object.extend(
     You can invoke this method anytime you need to make the record as dirty.
     This will cause the record to be commited when you `commitChanges()`
     on the underlying store.
-    
-    If you use the `writeAttribute()` primitive, this method will be called 
+
+    If you use the `writeAttribute()` primitive, this method will be called
     for you.
-    
+
     If you pass the key that changed it will ensure that observers are fired
     only once for the changed property instead of `allPropertiesDidChange()`
-    
+
     @param {String} key key that changed (optional)
     @returns {SC.Record} receiver
   */
   recordDidChange: function(key) {
-    
+
     // If we have a parent, they changed too!
     var p = this.get('parentRecord');
     if (p) p.recordDidChange();
-    
+
     this.get('store').recordDidChange(null, null, this.get('storeKey'), key);
     this.notifyPropertyChange('status');
 
@@ -363,23 +363,27 @@ SC.Record = SC.Object.extend(
 
     return this ;
   },
-  
+
+  toJSON: function(){
+    return this.get('attributes');
+  },
+
   // ...............................
   // ATTRIBUTES
   //
 
   /** @private
-    Current edit level.  Used to defer editing changes. 
+    Current edit level.  Used to defer editing changes.
   */
   _editLevel: 0 ,
-  
+
   /**
-    Defers notification of record changes until you call a matching 
+    Defers notification of record changes until you call a matching
     `endEditing()` method.  This method is called automatically whenever you
     set an attribute, but you can call it yourself to group multiple changes.
-    
+
     Calls to `beginEditing()` and `endEditing()` can be nested.
-    
+
     @returns {SC.Record} receiver
   */
   beginEditing: function() {
@@ -391,50 +395,50 @@ SC.Record = SC.Object.extend(
     Notifies the store of record changes if this matches a top level call to
     `beginEditing()`.  This method is called automatically whenever you set an
     attribute, but you can call it yourself to group multiple changes.
-    
+
     Calls to `beginEditing()` and `endEditing()` can be nested.
-    
+
     @param {String} key key that changed (optional)
     @returns {SC.Record} receiver
   */
   endEditing: function(key) {
     if(--this._editLevel <= 0) {
-      this._editLevel = 0; 
+      this._editLevel = 0;
       this.recordDidChange(key);
     }
     return this ;
   },
-  
+
   /**
     Reads the raw attribute from the underlying data hash.  This method does
     not transform the underlying attribute at all.
-  
+
     @param {String} key the attribute you want to read
     @returns {Object} the value of the key, or undefined if it doesn't exist
   */
   readAttribute: function(key) {
     var store = this.get('store'), storeKey = this.storeKey;
     var attrs = store.readDataHash(storeKey);
-    return attrs ? attrs[key] : undefined ; 
+    return attrs ? attrs[key] : undefined ;
   },
 
   /**
-    Updates the passed attribute with the new value.  This method does not 
-    transform the value at all.  If instead you want to modify an array or 
-    hash already defined on the underlying json, you should instead get 
+    Updates the passed attribute with the new value.  This method does not
+    transform the value at all.  If instead you want to modify an array or
+    hash already defined on the underlying json, you should instead get
     an editable version of the attribute using `editableAttribute()`.
-  
+
     @param {String} key the attribute you want to read
     @param {Object} value the value you want to write
-    @param {Boolean} ignoreDidChange only set if you do NOT want to flag 
+    @param {Boolean} ignoreDidChange only set if you do NOT want to flag
       record as dirty
     @returns {SC.Record} receiver
   */
   writeAttribute: function(key, value, ignoreDidChange) {
-    var store    = this.get('store'), 
+    var store    = this.get('store'),
         storeKey = this.storeKey,
         attrs;
-    
+
     attrs = store.readEditableDataHash(storeKey);
     if (!attrs) throw SC.Record.BAD_STATE_ERROR;
 
@@ -442,33 +446,33 @@ SC.Record = SC.Object.extend(
     if (value !== attrs[key]) {
       if(!ignoreDidChange) this.beginEditing();
       attrs[key] = value;
-      
+
       // If the key is the primaryKey of the record, we need to tell the store
       // about the change.
       if (key===this.get('primaryKey')) {
         SC.Store.replaceIdFor(storeKey, value) ;
         this.propertyDidChange('id'); // Reset computed value
       }
-      
+
       if(!ignoreDidChange) this.endEditing(key);
     }
     return this ;
   },
-  
+
   /**
     This will also ensure that any aggregate records are also marked dirty
     if this record changes.
-    
+
     Should not have to be called manually.
   */
   propagateToAggregates: function() {
     var storeKey = this.get('storeKey'),
-        recordType = SC.Store.recordTypeFor(storeKey), 
+        recordType = SC.Store.recordTypeFor(storeKey),
         idx, len, key, val, recs;
-    
+
     var aggregates = recordType.aggregates;
-    
-    // if recordType aggregates are not set up yet, make sure to 
+
+    // if recordType aggregates are not set up yet, make sure to
     // create the cache first
     if (!aggregates) {
       var dataHash = this.get('store').readDataHash(storeKey);
@@ -480,7 +484,7 @@ SC.Record = SC.Object.extend(
       }
       recordType.aggregates = aggregates;
     }
-    
+
     // now loop through all aggregate properties and mark their related
     // record objects as dirty
     var K          = SC.Record,
@@ -489,23 +493,23 @@ SC.Record = SC.Object.extend(
         destroyed  = K.DESTROYED,
         readyClean = K.READY_CLEAN,
         iter;
-    
+
     /**
       @private
-      
+
       If the child is dirty, then make sure the parent gets a dirty
       status.  (If the child is created or destroyed, there's no need,
       because the parent will dirty itself when it modifies that
       relationship.)
-      
+
       @param {SC.Record} record to propagate to
     */
     iter =  function(rec) {
       var childStatus, parentStatus;
-      
-      if (rec) { 
+
+      if (rec) {
         childStatus = this.get('status');
-        if ((childStatus & dirty)  ||  
+        if ((childStatus & dirty)  ||
             (childStatus & readyNew)  ||  (childStatus & destroyed)) {
           parentStatus = rec.get('status');
           if (parentStatus === readyClean) {
@@ -516,7 +520,7 @@ SC.Record = SC.Object.extend(
         }
       }
     };
-        
+
     for(idx=0,len=aggregates.length;idx<len;++idx) {
       key = aggregates[idx];
       val = this.get(key);
@@ -524,12 +528,12 @@ SC.Record = SC.Object.extend(
       recs.forEach(iter, this);
     }
   },
-  
+
   /**
     Called by the store whenever the underlying data hash has changed.  This
     will notify any observers interested in data hash properties that they
     have changed.
-    
+
     @param {Boolean} statusOnly changed
     @param {String} key that changed (optional)
     @returns {SC.Record} receiver
@@ -538,54 +542,54 @@ SC.Record = SC.Object.extend(
     // TODO:  Should this function call propagateToAggregates() at the
     //        appropriate times?
     if (statusOnly) this.notifyPropertyChange('status');
-    else {      
+    else {
       if (keys) {
         this.beginPropertyChanges();
         keys.forEach(function(k) { this.notifyPropertyChange(k); }, this);
-        this.notifyPropertyChange('status'); 
+        this.notifyPropertyChange('status');
         this.endPropertyChanges();
 
-      } else this.allPropertiesDidChange(); 
-    
+      } else this.allPropertiesDidChange();
+
       // also notify manyArrays
       var manyArrays = this.relationships,
           loc        = manyArrays ? manyArrays.length : 0 ;
-      while(--loc>=0) manyArrays[loc].recordPropertyDidChange(keys);      
+      while(--loc>=0) manyArrays[loc].recordPropertyDidChange(keys);
     }
   },
-  
+
   /**
     Normalizing a record will ensure that the underlying hash conforms
-    to the record attributes such as their types (transforms) and default 
-    values. 
-    
+    to the record attributes such as their types (transforms) and default
+    values.
+
     This method will write the conforming hash to the store and return
     the materialized record.
-    
+
     By normalizing the record, you can use `.attributes()` and be
     assured that it will conform to the defined model. For example, this
     can be useful in the case where you need to send a JSON representation
     to some server after you have used `.createRecord()`, since this method
     will enforce the 'rules' in the model such as their types and default
-    values. You can also include null values in the hash with the 
+    values. You can also include null values in the hash with the
     includeNull argument.
-    
+
     @param {Boolean} includeNull will write empty (null) attributes
     @returns {SC.Record} the normalized record
   */
-  
-  normalize: function(includeNull) {    
-    var primaryKey = this.primaryKey, 
-        recordId   = this.get('id'), 
-        store      = this.get('store'), 
-        storeKey   = this.get('storeKey'), 
+
+  normalize: function(includeNull) {
+    var primaryKey = this.primaryKey,
+        recordId   = this.get('id'),
+        store      = this.get('store'),
+        storeKey   = this.get('storeKey'),
         key, valueForKey, typeClass, recHash, attrValue, normChild,  isRecord,
         isChild, defaultVal, keyForDataHash, attr;
-      
+
     var dataHash = store.readEditableDataHash(storeKey) || {};
     dataHash[primaryKey] = recordId;
     recHash = store.readDataHash(storeKey);
-    
+
     for (key in this) {
       // make sure property is a record attribute.
       valueForKey = this[key];
@@ -605,7 +609,7 @@ SC.Record = SC.Object.extend(
               }
               dataHash[keyForDataHash] = attrValue;
             }
-          
+
           } else if (isChild) {
             attrValue = this.get(key);
 
@@ -627,7 +631,7 @@ SC.Record = SC.Object.extend(
               if (SC.typeOf(defaultVal)===SC.T_FUNCTION) {
                 dataHash[keyForDataHash] = defaultVal(this, key, defaultVal);
               } else {
-                // plain value                
+                // plain value
                 dataHash[keyForDataHash] = defaultVal;
               }
             }
@@ -639,37 +643,37 @@ SC.Record = SC.Object.extend(
     return this;
   },
 
-  
-  
+
+
   /**
-    If you try to get/set a property not defined by the record, then this 
-    method will be called. It will try to get the value from the set of 
+    If you try to get/set a property not defined by the record, then this
+    method will be called. It will try to get the value from the set of
     attributes.
-    
+
     This will also check is `ignoreUnknownProperties` is set on the recordType
     so that they will not be written to `dataHash` unless explicitly defined
     in the model schema.
-  
+
     @param {String} key the attribute being get/set
     @param {Object} value the value to set the key to, if present
     @returns {Object} the value
   */
   unknownProperty: function(key, value) {
-    
+
     if (value !== undefined) {
-      
-      // first check if we should ignore unknown properties for this 
+
+      // first check if we should ignore unknown properties for this
       // recordType
       var storeKey = this.get('storeKey'),
         recordType = SC.Store.recordTypeFor(storeKey);
-      
+
       if(recordType.ignoreUnknownProperties===YES) {
         this[key] = value;
         return value;
       }
-      
-      // if we're modifying the PKEY, then `SC.Store` needs to relocate where 
-      // this record is cached. store the old key, update the value, then let 
+
+      // if we're modifying the PKEY, then `SC.Store` needs to relocate where
+      // this record is cached. store the old key, update the value, then let
       // the store do the housekeeping...
       var primaryKey = this.get('primaryKey');
       this.writeAttribute(key,value);
@@ -678,28 +682,28 @@ SC.Record = SC.Object.extend(
       if (key === primaryKey) {
         SC.Store.replaceIdFor(storeKey, value);
       }
-      
+
     }
     return this.readAttribute(key);
   },
-  
+
   /**
     Lets you commit this specific record to the store which will trigger
     the appropriate methods in the data source for you.
-    
+
     @param {Hash} params optional additonal params that will passed down
       to the data source
     @param {boolean} recordOnly optional param if you want to only commit a single
       record if it has a parent.
-    @param {Function} callback optional callback that the store will fire once the 
+    @param {Function} callback optional callback that the store will fire once the
     datasource finished committing
     @returns {SC.Record} receiver
   */
-  commitRecord: function(params, recordOnly, callback) {    
+  commitRecord: function(params, recordOnly, callback) {
     var store = this.get('store'), rec, ro,
         sk = this.get('storeKey'),
         prKey = store.parentStoreKeyExists();
-    
+
     // If we only want to commit this record or it doesn't have a parent record
     // we will commit this record
     ro = recordOnly || (SC.none(recordOnly) && SC.none(prKey));
@@ -711,15 +715,15 @@ SC.Record = SC.Object.extend(
     }
     return this ;
   },
-  
+
   // ..........................................................
   // EMULATE SC.ERROR API
-  // 
-  
+  //
+
   /**
     Returns `YES` whenever the status is SC.Record.ERROR.  This will allow you
     to put the UI into an error state.
-    
+
     @type Boolean
     @property
     @dependsOn status
@@ -731,7 +735,7 @@ SC.Record = SC.Object.extend(
   /**
     Returns the receiver if the record is in an error state.  Returns null
     otherwise.
-    
+
     @type SC.Record
     @property
     @dependsOn isError
@@ -739,11 +743,11 @@ SC.Record = SC.Object.extend(
   errorValue: function() {
     return this.get('isError') ? SC.val(this.get('errorObject')) : null ;
   }.property('isError').cacheable(),
-  
+
   /**
     Returns the current error object only if the record is in an error state.
     If no explicit error object has been set, returns SC.Record.GENERIC_ERROR.
-    
+
     @type SC.Error
     @property
     @dependsOn isError
@@ -754,11 +758,11 @@ SC.Record = SC.Object.extend(
       return store.readError(this.get('storeKey')) || SC.Record.GENERIC_ERROR;
     } else return null ;
   }.property('isError').cacheable(),
-  
+
   // ...............................
   // PRIVATE
   //
-  
+
   /** @private
     Sets the key equal to value.
 
@@ -781,35 +785,35 @@ SC.Record = SC.Object.extend(
 
   /** @private
     Creates string representation of record, with status.
-    
+
     @returns {String}
   */
-  
+
   toString: function() {
     // We won't use 'readOnlyAttributes' here because accessing them directly
     // avoids a SC.clone() -- we'll be careful not to edit anything.
     var attrs = this.get('store').readDataHash(this.get('storeKey'));
     return "%@(%@) %@".fmt(this.constructor.toString(), SC.inspect(attrs), this.statusString());
   },
-  
+
   /** @private
     Creates string representation of record, with status.
-    
+
     @returns {String}
   */
-  
+
   statusString: function() {
     var ret = [], status = this.get('status');
-    
+
     for(var prop in SC.Record) {
       if(prop.match(/[A-Z_]$/) && SC.Record[prop]===status) {
         ret.push(prop);
       }
     }
-    
+
     return ret.join(" ");
   },
-  
+
   /**
     Registers a child record with this parent record.
 
@@ -824,15 +828,15 @@ SC.Record = SC.Object.extend(
    */
   registerNestedRecord: function(value, key, path) {
     var store, psk, csk, childRecord, recordType;
-    
+
     // if no path is entered it must be the key
     if (SC.none(path)) path = key;
-    // if a record instance is passed, simply use the storeKey.  This allows 
+    // if a record instance is passed, simply use the storeKey.  This allows
     // you to pass a record from a chained store to get the same record in the
     // current store.
     if (value && value.get && value.get('isRecord')) {
       childRecord = value;
-    } 
+    }
     else {
       recordType = this._materializeNestedRecordType(value, key);
       childRecord = this.createNestedRecord(recordType, value);
@@ -844,19 +848,19 @@ SC.Record = SC.Object.extend(
       csk = childRecord.get('storeKey');
       store.registerChildToParent(psk, csk, path);
     }
-      
+
     return childRecord;
   },
-  
+
   /**
     @private
-    
+
      private method that retrieves the `recordType` from the hash that is
      provided.
 
      Important for use in polymorphism but you must have the following items
      in the parent record:
-     
+
      `nestedRecordNamespace` <= this is the object that has the `SC.Records`
      defined
 
@@ -888,7 +892,7 @@ SC.Record = SC.Object.extend(
 
     return recordType;
   },
-  
+
   /**
     Creates a new nested record instance.
 
@@ -901,12 +905,12 @@ SC.Record = SC.Object.extend(
     var store, id, sk, pk, cr = null, existingId = null;
     SC.run(function() {
       hash = hash || {}; // init if needed
-      
+
       existingId = hash[recordType.prototype.primaryKey];
-      
+
       store = this.get('store');
       if (SC.none(store)) throw 'Error: during the creation of a child record: NO STORE ON PARENT!';
-      
+
       if (!id && (pk = recordType.prototype.primaryKey)) {
         id = hash[pk];
         // In case there isnt a primary key supplied then we create on
@@ -925,9 +929,9 @@ SC.Record = SC.Object.extend(
             hash[pk] = id;
           }
         }
-        
+
       }
-      
+
       // ID processing if necessary
       if (SC.none(existingId) && this.generateIdForChild) this.generateIdForChild(cr);
 
@@ -935,28 +939,28 @@ SC.Record = SC.Object.extend(
 
     return cr;
   },
-  
+
   _nestedRecordKey: 0,
-    
+
   /**
-    Override this function if you want to have a special way of creating 
+    Override this function if you want to have a special way of creating
     ids for your child records
-    
+
     @param {SC.Record} childRecord
     @returns {String} the id generated
    */
   generateIdForChild: function(childRecord){}
-     
+
 }) ;
 
 // Class Methods
-SC.Record.mixin( /** @scope SC.Record.prototype */ {
+SC.Record.mixin( /** @scope SC.Record */ {
 
   /**
     Whether to ignore unknown properties when they are being set on the record
     object. This is useful if you want to strictly enforce the model schema
     and not allow dynamically expanding it by setting new unknown properties
-    
+
     @static
     @type Boolean
     @default NO
@@ -965,13 +969,13 @@ SC.Record.mixin( /** @scope SC.Record.prototype */ {
 
   // ..........................................................
   // CONSTANTS
-  // 
+  //
 
-  /** 
+  /**
     Generic state for records with no local changes.
-    
+
     Use a logical AND (single `&`) to test record status
-  
+
     @static
     @constant
     @type Number
@@ -979,25 +983,25 @@ SC.Record.mixin( /** @scope SC.Record.prototype */ {
   */
   CLEAN:            0x0001, // 1
 
-  /** 
+  /**
     Generic state for records with local changes.
-    
+
     Use a logical AND (single `&`) to test record status
-  
+
     @static
     @constant
     @type Number
     @default 0x0002
   */
   DIRTY:            0x0002, // 2
-  
-  /** 
-    State for records that are still loaded.  
-    
-    A record instance should never be in this state.  You will only run into 
-    it when working with the low-level data hash API on `SC.Store`. Use a 
+
+  /**
+    State for records that are still loaded.
+
+    A record instance should never be in this state.  You will only run into
+    it when working with the low-level data hash API on `SC.Store`. Use a
     logical AND (single `&`) to test record status
-  
+
     @static
     @constant
     @type Number
@@ -1005,23 +1009,23 @@ SC.Record.mixin( /** @scope SC.Record.prototype */ {
   */
   EMPTY:            0x0100, // 256
 
-  /** 
+  /**
     State for records in an error state.
-    
+
     Use a logical AND (single `&`) to test record status
-  
+
     @static
     @constant
     @type Number
     @default 0x1000
   */
   ERROR:            0x1000, // 4096
-  
-  /** 
+
+  /**
     Generic state for records that are loaded and ready for use
-    
+
     Use a logical AND (single `&`) to test record status
-  
+
     @static
     @constant
     @type Number
@@ -1029,11 +1033,11 @@ SC.Record.mixin( /** @scope SC.Record.prototype */ {
   */
   READY:            0x0200, // 512
 
-  /** 
+  /**
     State for records that are loaded and ready for use with no local changes
-    
+
     Use a logical AND (single `&`) to test record status
-  
+
     @static
     @constant
     @type Number
@@ -1042,11 +1046,11 @@ SC.Record.mixin( /** @scope SC.Record.prototype */ {
   READY_CLEAN:      0x0201, // 513
 
 
-  /** 
+  /**
     State for records that are loaded and ready for use with local changes
-    
+
     Use a logical AND (single `&`) to test record status
-  
+
     @static
     @constant
     @type Number
@@ -1055,24 +1059,24 @@ SC.Record.mixin( /** @scope SC.Record.prototype */ {
   READY_DIRTY:      0x0202, // 514
 
 
-  /** 
+  /**
     State for records that are new - not yet committed to server
-    
+
     Use a logical AND (single `&`) to test record status
-  
+
     @static
     @constant
     @type Number
     @default 0x0203
   */
   READY_NEW:        0x0203, // 515
-  
 
-  /** 
+
+  /**
     Generic state for records that have been destroyed
-    
+
     Use a logical AND (single `&`) to test record status
-  
+
     @static
     @constant
     @type Number
@@ -1081,11 +1085,11 @@ SC.Record.mixin( /** @scope SC.Record.prototype */ {
   DESTROYED:        0x0400, // 1024
 
 
-  /** 
+  /**
     State for records that have been destroyed and committed to server
-    
+
     Use a logical AND (single `&`) to test record status
-  
+
     @static
     @constant
     @type Number
@@ -1094,24 +1098,24 @@ SC.Record.mixin( /** @scope SC.Record.prototype */ {
   DESTROYED_CLEAN:  0x0401, // 1025
 
 
-  /** 
+  /**
     State for records that have been destroyed but not yet committed to server
-    
+
     Use a logical AND (single `&`) to test record status
-  
+
     @static
     @constant
     @type Number
     @default 0x0402
   */
   DESTROYED_DIRTY:  0x0402, // 1026
-  
 
-  /** 
+
+  /**
     Generic state for records that have been submitted to data source
-    
+
     Use a logical AND (single `&`) to test record status
-  
+
     @static
     @constant
     @type Number
@@ -1120,11 +1124,11 @@ SC.Record.mixin( /** @scope SC.Record.prototype */ {
   BUSY:             0x0800, // 2048
 
 
-  /** 
+  /**
     State for records that are still loading data from the server
-    
+
     Use a logical AND (single `&`) to test record status
-  
+
     @static
     @constant
     @type Number
@@ -1133,12 +1137,12 @@ SC.Record.mixin( /** @scope SC.Record.prototype */ {
   BUSY_LOADING:     0x0804, // 2052
 
 
-  /** 
-    State for new records that were created and submitted to the server; 
+  /**
+    State for new records that were created and submitted to the server;
     waiting on response from server
-    
+
     Use a logical AND (single `&`) to test record status
-  
+
     @static
     @constant
     @type Number
@@ -1147,11 +1151,11 @@ SC.Record.mixin( /** @scope SC.Record.prototype */ {
   BUSY_CREATING:    0x0808, // 2056
 
 
-  /** 
+  /**
     State for records that have been modified and submitted to server
-    
+
     Use a logical AND (single `&`) to test record status
-  
+
     @static
     @constant
     @type Number
@@ -1160,11 +1164,11 @@ SC.Record.mixin( /** @scope SC.Record.prototype */ {
   BUSY_COMMITTING:  0x0810, // 2064
 
 
-  /** 
+  /**
     State for records that have requested a refresh from the server.
-    
+
     Use a logical AND (single `&`) to test record status.
-  
+
     @static
     @constant
     @type Number
@@ -1173,11 +1177,11 @@ SC.Record.mixin( /** @scope SC.Record.prototype */ {
   BUSY_REFRESH:     0x0820, // 2080
 
 
-  /** 
+  /**
     State for records that have requested a refresh from the server.
-    
+
     Use a logical AND (single `&`) to test record status
-  
+
     @static
     @constant
     @type Number
@@ -1185,11 +1189,11 @@ SC.Record.mixin( /** @scope SC.Record.prototype */ {
   */
   BUSY_REFRESH_CLEAN:  0x0821, // 2081
 
-  /** 
+  /**
     State for records that have requested a refresh from the server.
-    
+
     Use a logical AND (single `&`) to test record status
-  
+
     @static
     @constant
     @type Number
@@ -1197,11 +1201,11 @@ SC.Record.mixin( /** @scope SC.Record.prototype */ {
   */
   BUSY_REFRESH_DIRTY:  0x0822, // 2082
 
-  /** 
+  /**
     State for records that have been destroyed and submitted to server
-    
+
     Use a logical AND (single `&`) to test record status
-  
+
     @static
     @constant
     @type Number
@@ -1212,12 +1216,12 @@ SC.Record.mixin( /** @scope SC.Record.prototype */ {
 
   // ..........................................................
   // ERRORS
-  // 
-  
+  //
+
   /**
-    Error for when you try to modify a record while it is in a bad 
+    Error for when you try to modify a record while it is in a bad
     state.
-    
+
     @static
     @constant
     @type SC.Error
@@ -1226,7 +1230,7 @@ SC.Record.mixin( /** @scope SC.Record.prototype */ {
 
   /**
     Error for when you try to create a new record that already exists.
-    
+
     @static
     @constant
     @type SC.Error
@@ -1235,7 +1239,7 @@ SC.Record.mixin( /** @scope SC.Record.prototype */ {
 
   /**
     Error for when you attempt to locate a record that is not found
-    
+
     @static
     @constant
     @type SC.Error
@@ -1244,7 +1248,7 @@ SC.Record.mixin( /** @scope SC.Record.prototype */ {
 
   /**
     Error for when you try to modify a record that is currently busy
-    
+
     @static
     @constant
     @type SC.Error
@@ -1253,54 +1257,54 @@ SC.Record.mixin( /** @scope SC.Record.prototype */ {
 
   /**
     Generic unknown record error
-    
+
     @static
     @constant
     @type SC.Error
   */
   GENERIC_ERROR:       SC.$error("Generic Error"),
-  
+
   /**
     @private
     The next child key to allocate.  A nextChildKey must always be greater than 0.
   */
   _nextChildKey: 0,
-  
+
   // ..........................................................
   // CLASS METHODS
-  // 
-  
+  //
+
   /**
     Helper method returns a new `SC.RecordAttribute` instance to map a simple
-    value or to-one relationship.  At the very least, you should pass the 
+    value or to-one relationship.  At the very least, you should pass the
     type class you expect the attribute to have.  You may pass any additional
     options as well.
-    
-    Use this helper when you define SC.Record subclasses. 
-    
+
+    Use this helper when you define SC.Record subclasses.
+
         MyApp.Contact = SC.Record.extend({
           firstName: SC.Record.attr(String, { isRequired: YES })
         });
-    
+
     @param {Class} type the attribute type
     @param {Hash} opts the options for the attribute
     @returns {SC.RecordAttribute} created instance
   */
-  attr: function(type, opts) { 
-    return SC.RecordAttribute.attr(type, opts); 
+  attr: function(type, opts) {
+    return SC.RecordAttribute.attr(type, opts);
   },
-  
+
   /**
-    Returns an `SC.RecordAttribute` that describes a fetched attribute.  When 
+    Returns an `SC.RecordAttribute` that describes a fetched attribute.  When
     you reference this attribute, it will return an `SC.RecordArray` that uses
     the type as the fetch key and passes the attribute value as a param.
-    
-    Use this helper when you define SC.Record subclasses. 
-    
+
+    Use this helper when you define SC.Record subclasses.
+
         MyApp.Group = SC.Record.extend({
           contacts: SC.Record.fetch('MyApp.Contact')
         });
-    
+
     @param {SC.Record|String} recordType The type of records to load
     @param {Hash} opts the options for the attribute
     @returns {SC.RecordAttribute} created instance
@@ -1308,22 +1312,22 @@ SC.Record.mixin( /** @scope SC.Record.prototype */ {
   fetch: function(recordType, opts) {
     return SC.FetchedAttribute.attr(recordType, opts) ;
   },
-  
+
   /**
     Will return one of the following:
-    
-     1. `SC.ManyAttribute` that describes a record array backed by an 
-        array of guids stored in the underlying JSON.  
+
+     1. `SC.ManyAttribute` that describes a record array backed by an
+        array of guids stored in the underlying JSON.
      2. `SC.ChildrenAttribute` that describes a record array backed by a
         array of hashes.
-    
+
     You can edit the contents of this relationship.
-    
-    For `SC.ManyAttribute`, If you set the inverse and `isMaster: NO` key, 
-    then editing this array will modify the underlying data, but the 
-    inverse key on the matching record will also be edited and that 
+
+    For `SC.ManyAttribute`, If you set the inverse and `isMaster: NO` key,
+    then editing this array will modify the underlying data, but the
+    inverse key on the matching record will also be edited and that
     record will be marked as needing a change.
-    
+
     @param {SC.Record|String} recordType The type of record to create
     @param {Hash} opts the options for the attribute
     @returns {SC.ManyAttribute|SC.ChildrenAttribute} created instance
@@ -1340,16 +1344,16 @@ SC.Record.mixin( /** @scope SC.Record.prototype */ {
     }
     return attr;
   },
-  
+
   /**
     Will return one of the following:
-    
+
      1. `SC.SingleAttribute` that converts the underlying ID to a single
         record.  If you modify this property, it will rewrite the underyling
         ID. It will also modify the inverse of the relationship, if you set it.
      2. `SC.ChildAttribute` that you can edit the contents
         of this relationship.
-    
+
     @param {SC.Record|String} recordType the type of the record to create
     @param {Hash} opts additional options
     @returns {SC.SingleAttribute|SC.ChildAttribute} created instance
@@ -1366,12 +1370,12 @@ SC.Record.mixin( /** @scope SC.Record.prototype */ {
     }
     return attr;
   },
-  
+
   /**
     Returns all storeKeys mapped by Id for this record type.  This method is
     used mostly by the `SC.Store` and the Record to coordinate.  You will rarely
     need to call this method yourself.
-    
+
     @returns {Hash}
   */
   storeKeysById: function() {
@@ -1380,50 +1384,50 @@ SC.Record.mixin( /** @scope SC.Record.prototype */ {
     if (!ret) ret = this[key] = {};
     return ret;
   },
-  
+
   /**
     Given a primaryKey value for the record, returns the associated
-    storeKey.  If the primaryKey has not been assigned a storeKey yet, it 
+    storeKey.  If the primaryKey has not been assigned a storeKey yet, it
     will be added.
-    
-    For the inverse of this method see `SC.Store.idFor()` and 
+
+    For the inverse of this method see `SC.Store.idFor()` and
     `SC.Store.recordTypeFor()`.
-    
+
     @param {String} id a record id
     @returns {Number} a storeKey.
   */
   storeKeyFor: function(id) {
     var storeKeys = this.storeKeysById(),
         ret       = storeKeys[id];
-    
+
     if (!ret) {
       ret = SC.Store.generateStoreKey();
       SC.Store.idsByStoreKey[ret] = id ;
       SC.Store.recordTypesByStoreKey[ret] = this ;
       storeKeys[id] = ret ;
     }
-    
+
     return ret ;
   },
-  
+
   /**
     Given a primaryKey value for the record, returns the associated
     storeKey.  As opposed to `storeKeyFor()` however, this method
     will NOT generate a new storeKey but returned undefined.
-    
+
     @param {String} id a record id
     @returns {Number} a storeKey.
   */
   storeKeyExists: function(id) {
     var storeKeys = this.storeKeysById(),
         ret       = storeKeys[id];
-    
+
     return ret ;
   },
 
-  /** 
+  /**
     Returns a record with the named ID in store.
-    
+
     @param {SC.Store} store the store
     @param {String} id the record id or a query
     @returns {SC.Record} record instance
@@ -1431,7 +1435,7 @@ SC.Record.mixin( /** @scope SC.Record.prototype */ {
   find: function(store, id) {
     return store.find(this, id);
   },
-  
+
   /** @private - enhance extend to notify SC.Query as well. */
   extend: function() {
     var ret = SC.Object.extend.apply(this, arguments);