dojo/data/ObjectStore.js

• Provides:

  • dojo.data.ObjectStore

• Requires:

  • dojo.regexp in common

• dojo.data.ObjectStore

  • type

    Function

  • parameters:
    • options: (typeof The)

      configuration information to pass into the data store.
      options.objectStore:
      The object store to use as the source provider for this data store

  • summary

    A Dojo Data implementation that wraps Dojo object stores for backwards
    compatibility.

• dojo.data.ObjectStore.objectStore

  • type

    Object

• dojo.data.ObjectStore.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • options: (typeof The)

      configuration information to pass into the data store.
      options.objectStore:
      The object store to use as the source provider for this data store

  • summary

    A Dojo Data implementation that wraps Dojo object stores for backwards
    compatibility.

• dojo.data.ObjectStore.labelProperty

  • type

    String

• dojo.data.ObjectStore.getValue

  • parameters:
    • item: (typeof Object)

      The item to get the value from

    • property: (typeof String)

      property to look up value for

    • defaultValue: (typeof value)

      the default value

  • summary

    Gets the value of an item's 'property'

  • type

    Function

• dojo.data.ObjectStore.getValues

  • parameters:
    • item: (typeof object)
    • property: (typeof string)

      property to look up value for

  • summary

    Gets the value of an item's 'property' and returns
    it.	If this value is an array it is just returned,
    if not, the value is added to an array and that is returned.

  • type

    Function

• dojo.data.ObjectStore.getAttributes

  • parameters:
    • item: (typeof object)
  • summary

    Gets the available attributes of an item's 'property' and returns
    it as an array.

  • type

    Function

• dojo.data.ObjectStore.hasAttribute

  • parameters:
    • item: (typeof object)
    • attribute: (typeof string)
  • summary

    Checks to see if item has attribute

  • type

    Function

• dojo.data.ObjectStore.containsValue

  • parameters:
    • item: (typeof object)
    • attribute: (typeof string)
    • value: (typeof anything)
  • summary

    Checks to see if 'item' has 'value' at 'attribute'

  • type

    Function

• dojo.data.ObjectStore.isItem

  • parameters:
    • item: (typeof object)

      attribute: /* string

  • summary

    Checks to see if the argument is an item

  • type

    Function

• dojo.data.ObjectStore.isItemLoaded

  • parameters:
    • item: (typeof object)
  • summary

    Checks to see if the item is loaded.

  • type

    Function

• dojo.data.ObjectStore.loadItem

  • parameters:
    • args
  • summary

    Loads an item and calls the callback handler. Note, that this will call the callback
    handler even if the item is loaded. Consequently, you can use loadItem to ensure
    that an item is loaded is situations when the item may or may not be loaded yet.
    If you access a value directly through property access, you can use this to load
    a lazy value as well (doesn't need to be an item).

  • example

    store.loadItem({
    item: item, // this item may or may not be loaded
    onItem: function(item){
    // do something with the item
    }
    });

  • type

    Function

• dojo.data.ObjectStore.close

  • parameters:
    • request
  • type

    Function

• dojo.data.ObjectStore.fetch

  • parameters:
    • args
  • summary

    See dojo.data.api.Read.fetch

  • type

    Function

• dojo.data.ObjectStore.getFeatures

  • summary

    return the store feature set

  • type

    Function

• dojo.data.ObjectStore.getLabel

  • parameters:
    • item: (typeof item)
  • returns

    String|undefined

  • summary

    See dojo.data.api.Read.getLabel()

  • type

    Function

• dojo.data.ObjectStore.getLabelAttributes

  • parameters:
    • item: (typeof item)
  • returns

    array

  • summary

    See dojo.data.api.Read.getLabelAttributes()

  • type

    Function

• dojo.data.ObjectStore.getIdentity

  • parameters:
    • item
  • type

    Function

• dojo.data.ObjectStore.getIdentityAttributes

  • parameters:
    • item
  • summary

    returns the attributes which are used to make up the
    identity of an item.	Basically returns this.objectStore.idProperty

  • type

    Function

• dojo.data.ObjectStore.fetchItemByIdentity

  • parameters:
    • args
  • summary

    fetch an item by its identity, by looking in our index of what we have loaded

  • type

    Function

• dojo.data.ObjectStore.newItem

  • parameters:
    • data: (typeof object)

      The data to be added in as an item.

    • parentInfo
  • summary

    adds a new item to the store at the specified point.
    Takes two parameters, data, and options.

  • type

    Function

• dojo.data.ObjectStore.deleteItem

  • parameters:
    • item: (typeof item)

      to delete

  • summary

    deletes item and any references to that item from the store.

  • type

    Function

• dojo.data.ObjectStore.setValue

  • parameters:
    • item
    • attribute
    • value
  • summary

    sets 'attribute' on 'item' to 'value'

  • type

    Function

• dojo.data.ObjectStore.setValues

  • parameters:
    • item
    • attribute
    • values
  • summary

    sets 'attribute' on 'item' to 'value' value
    must be an array.

  • type

    Function

• dojo.data.ObjectStore.unsetAttribute

  • parameters:
    • item
    • attribute
  • summary

    unsets 'attribute' on 'item'

  • type

    Function

• dojo.data.ObjectStore._dirtyObjects

  • type

    Array

• dojo.data.ObjectStore.changing

  • parameters:
    • object
    • _deleting
  • summary

    adds an object to the list of dirty objects.  This object
    contains a reference to the object itself as well as a
    cloned and trimmed version of old object for use with
    revert.

  • type

    Function

• dojo.data.ObjectStore.save

  • parameters:
    • kwArgs
  • summary

    Saves the dirty data using object store provider. See dojo.data.api.Write for API.
    
    kwArgs.global:
    This will cause the save to commit the dirty data for all
    ObjectStores as a single transaction.
    
    kwArgs.revertOnError
    This will cause the changes to be reverted if there is an
    error on the save. By default a revert is executed unless
    a value of false is provide for this parameter.

  • type

    Function

• dojo.data.ObjectStore.revert

  • parameters:
    • kwArgs
  • type

    Function

• dojo.data.ObjectStore._dirtyObjects.length

• dojo.data.ObjectStore.isDirty

  • parameters:
    • item
  • type

    Function

• dojo.data.ObjectStore.onSet

  • type

    Function

• dojo.data.ObjectStore.onNew

  • type

    Function

• dojo.data.ObjectStore.onDelete

  • type

    Function

• dojo.data

  • type

    Object

• dojo

  • type

    Object