dojox/data/AppStore.js

• Provides:

  • dojox.data.AppStore

• Requires:

  • dojo.data.util.simpleFetch in common
  • dojo.data.util.filter in common
  • dojox.atom.io.Connection in common

• dojox.data.AppStore

  • type

    Function

  • chains:
    • dojo.data.util.simpleFetch: (prototype)
  • parameters:
    • args: (typeof Object)

      An anonymous object to initialize properties.  It expects the following values:

  • summary

    The APP data store.

  • description

    The APP Store is instantiated either in markup or programmatically by supplying a
    url of the Collection to be used.

• dojox.data.AppStore.url

  • type

    The

  • summary

    string So the parser can instantiate the store via markup.

  • tags: public

• dojox.data.AppStore.urlPreventCache

  • type

    Whether

  • summary

    boolean Whether or not to pass the preventCache parameter to the connection

  • tags: public

• dojox.data.AppStore.xmethod

  • tags: public
  • type

    boolean

  • summary

    Whether to use X-Method-Override for PUT/DELETE.

• dojox.data.AppStore._atomIO

  • type

    Object

• dojox.data.AppStore._feed

  • type

    Object

• dojox.data.AppStore._requests

  • type

    Array

• dojox.data.AppStore._processing

  • type

    Object

• dojox.data.AppStore._updates

  • type

    Object

• dojox.data.AppStore._adds

  • type

    Object

• dojox.data.AppStore._deletes

  • type

    Object

• dojox.data.AppStore.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • args: (typeof Object)

      An anonymous object to initialize properties.  It expects the following values:

  • summary

    The APP data store.

  • description

    The APP Store is instantiated either in markup or programmatically by supplying a
    url of the Collection to be used.

• dojox.data.AppStore._setFeed

  • parameters:
    • feed: (typeof dojox.atom.io.model.Feed)

      object
      The Feed to use for this data store.

    • data: (typeof unused)

      Signature for this function is defined by AtomIO.getFeed, since this is a callback.

  • summary

    Sets the internal feed using a dojox.atom.io.model.Feed object.

  • description

    Sets the internal feed using a dojox.atom.io.model.Feed object.  Also adds
    a property to the entries to track that they belong to this store. It
    also parses stored requests (since we were waiting on a callback) and
    executes those as well.

  • type

    Function

• dojox.data.AppStore._getAllItems

  • returns

    array

  • summary

    Function to return all entries in the Feed as an array of items.

  • description

    Function to return all entries in the Feed as an array of items.

  • return_summary

    Array of all entries in the feed.

  • type

    Function

• dojox.data.AppStore._assertIsItem

  • parameters:
    • item: (typeof item)

      The item to test for being contained by the store.

  • summary

    This function tests whether the item is an item.

  • description

    This function tests whether the item passed in is indeed an item
    in the store.

  • type

    Function

• dojox.data.AppStore._assertIsAttribute

  • parameters:
    • attribute: (typeof String)

      The attribute to test for being contained by the store.

  • summary

    This function tests whether the item is an attribute.

  • description

    This function tests whether the item passed in is indeed a valid
    'attribute' like type for the store.

  • return_summary

    Returns a boolean indicating whether this is a valid attribute.

  • type

    Function

• dojox.data.AppStore._addUpdate

  • parameters:
    • update: (typeof Object)

      dojox.atom.io.model.Entry object
      The updated Entry we've changed.

  • summary

    Internal function to add an updated entry to our updates array

  • description

    Internal function to add an updated entry to our updates array

  • type

    Function

• dojox.data.AppStore.getValue

  • parameters:
    • item: (typeof item)
    • attribute: (typeof attribute-name-string)
    • defaultValue: (typeof value)
  • returns

    Object||int|Boolean

  • summary

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

  • type

    Function

• dojox.data.AppStore.getValues

  • parameters:
    • item: (typeof item)
    • attribute: (typeof attribute-name-string)
  • returns

    Array

  • summary

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

  • type

    Function

• dojox.data.AppStore.getAttributes

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

    Array

  • summary

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

  • type

    Function

• dojox.data.AppStore.hasAttribute

  • parameters:
    • item: (typeof item)
    • attribute: (typeof attribute-name-string)
  • summary

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

  • type

    Function

• dojox.data.AppStore.containsValue

  • parameters:
    • item: (typeof item)
    • attribute: (typeof attribute-name-string)
    • value: (typeof anything)
  • returns

    boolean.

  • summary

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

  • type

    Function

• dojox.data.AppStore._containsValue

  • parameters:
    • item: (typeof item)

      The data item to examine for attribute values.

    • attribute: (typeof attribute-name-string)

      The attribute to inspect.

    • value: (typeof anything)

      The value to match.

    • regexp: (typeof RegExp)

      Optional regular expression generated off value if value was of string type to handle wildcarding.
      If present and attribute values are string, then it can be used for comparison instead of 'value'

    • trim: (typeof Boolean)
  • returns

    Boolean

  • summary

    Internal function for looking at the values contained by the item.

  • description

    Internal function for looking at the values contained by the item.  This
    function allows for denoting if the comparison should be case sensitive for
    strings or not (for handling filtering cases where string case should not matter)

  • type

    Function

• dojox.data.AppStore.isItem

  • parameters:
    • something: (typeof anything)
  • returns

    boolean

  • summary

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

  • type

    Function

• dojox.data.AppStore.isItemLoaded

  • parameters:
    • something: (typeof anything)
  • summary

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

  • type

    Function

• dojox.data.AppStore.loadItem

  • parameters:
    • keywordArgs: (typeof Object)
  • summary

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

  • type

    Function

• dojox.data.AppStore._fetchItems

  • parameters:
    • request: (typeof A)

      request object

    • fetchHandler: (typeof A)

      function to call for fetched items

    • errorHandler: (typeof A)

      function to call on error

  • summary

    Fetch items (Atom entries) that match to a query

  • description

    Fetch items (Atom entries) that match to a query

  • type

    Function

• dojox.data.AppStore._finishFetchItems

  • parameters:
    • request: (typeof A)

      request object

    • fetchHandler: (typeof A)

      function to call for fetched items

    • errorHandler: (typeof A)

      function to call on error

  • summary

    Internal function for finishing a fetch request.

  • description

    Internal function for finishing a fetch request.  Needed since the feed
    might not have been loaded, so we finish the fetch in a callback.

  • type

    Function

• dojox.data.AppStore.getFeatures

  • summary

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

  • type

    Function

• dojox.data.AppStore.close

  • parameters:
    • request: (typeof dojo.data.api.Request)

      || keywordArgs || null

  • summary

    See dojo.data.api.Read.close()
    nothing to do here!

  • type

    Function

• dojox.data.AppStore.getLabel

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

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

  • type

    Function

• dojox.data.AppStore.getLabelAttributes

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

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

  • type

    Function

• dojox.data.AppStore.getIdentity

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

    See dojo.data.api.Identity.getIdentity()

  • type

    Function

• dojox.data.AppStore.getIdentityAttributes

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

    See dojo.data.api.Identity.getIdentityAttributes()

  • type

    Function

• dojox.data.AppStore.fetchItemByIdentity

  • parameters:
    • keywordArgs
  • summary

    See dojo.data.api.Identity.fetchItemByIdentity()

  • type

    Function

• dojox.data.AppStore.newItem

  • parameters:
    • keywordArgs: (typeof Object)
  • summary

    See dojo.data.api.Write.newItem()

  • type

    Function

• dojox.data.AppStore.deleteItem

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

    See dojo.data.api.Write.deleteItem()

  • type

    Function

• dojox.data.AppStore.setValue

  • parameters:
    • item: (typeof item)
    • attribute: (typeof string)
    • value: (typeof almost)

      anything

  • summary

    See dojo.data.api.Write.setValue()

  • type

    Function

• dojox.data.AppStore.setValues

  • parameters:
    • item: (typeof item)
    • attribute: (typeof string)
    • values: (typeof array)
  • summary

    See dojo.data.api.Write.setValues()

  • type

    Function

• dojox.data.AppStore.unsetAttribute

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

    boolean

  • summary

    See dojo.data.api.Write.unsetAttribute()

  • type

    Function

• dojox.data.AppStore.save

  • parameters:
    • keywordArgs: (typeof object)

      { onComplete: function
      onError: function
      scope: object
      }

  • summary

    See dojo.data.api.Write.save()

  • type

    Function

• dojox.data.AppStore.revert

  • summary

    See dojo.data.api.Write.revert()

  • type

    Function

• dojox.data.AppStore.isDirty

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

    boolean

  • summary

    See dojo.data.api.Write.isDirty()

  • type

    Function

• dojox.data

  • type

    Object

• dojox

  • type

    Object