dojox/data/SnapLogicStore.js

• Provides:

  • dojox.data.SnapLogicStore

• Requires:

  • dojo.io.script in common
  • dojo.data.util.sorter in common

• dojox.data.SnapLogicStore

  • type

    Function

  • parameters:
    • args: (typeof Object)

      An object that contains properties for initializing the new data store object. The
      following properties are understood:

  • summary

    Initialize a SnapLogicStore object.

• dojox.data.SnapLogicStore.Parts

  • type

    Object

• dojox.data.SnapLogicStore.Parts.DATA

  • type

    String

• dojox.data.SnapLogicStore.Parts.COUNT

  • type

    String

• dojox.data.SnapLogicStore.url

  • type

    A

  • summary

    URL to the SnapLogic pipeline's output routed through PipeToHttp. Typically, this
    will look like "http://<server-host>:<port>/pipe/<pipeline-url>/<pipeline-output-view>".
    parameters:
    An object whose properties define parameters to the pipeline. The values of these
    properties will be sent to the pipeline as parameters when it run.

• dojox.data.SnapLogicStore.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • args: (typeof Object)

      An object that contains properties for initializing the new data store object. The
      following properties are understood:

  • summary

    Initialize a SnapLogicStore object.

• dojox.data.SnapLogicStore._assertIsItem

  • parameters:
    • item: (typeof item)

      The item to test for being contained by the store.

  • summary

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

  • type

    Function

• dojox.data.SnapLogicStore._assertIsAttribute

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

      The attribute to test for being contained by the store.

  • summary

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

  • type

    Function

• dojox.data.SnapLogicStore.getFeatures

  • summary

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

  • type

    Function

• dojox.data.SnapLogicStore.getValue

  • parameters:
    • item
    • attribute
    • defaultValue
  • summary

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

  • type

    Function

• dojox.data.SnapLogicStore.getAttributes

  • parameters:
    • item
  • summary

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

  • type

    Function

• dojox.data.SnapLogicStore.hasAttribute

  • parameters:
    • item
    • attribute
  • summary

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

  • type

    Function

• dojox.data.SnapLogicStore.isItemLoaded

  • parameters:
    • item
  • returns

    Boolean

  • summary

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

  • type

    Function

• dojox.data.SnapLogicStore.loadItem

  • parameters:
    • keywordArgs
  • summary

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

  • type

    Function

• dojox.data.SnapLogicStore.getLabel

  • parameters:
    • item
  • summary

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

  • type

    Function

• dojox.data.SnapLogicStore.getLabelAttributes

  • parameters:
    • item
  • summary

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

  • type

    Function

• dojox.data.SnapLogicStore.containsValue

  • parameters:
    • item
    • attribute
    • value
  • returns

    Boolean

  • summary

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

  • type

    Function

• dojox.data.SnapLogicStore.getValues

  • parameters:
    • item
    • attribute
  • returns

    Array

  • summary

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

  • type

    Function

• dojox.data.SnapLogicStore.isItem

  • parameters:
    • item
  • summary

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

  • type

    Function

• dojox.data.SnapLogicStore.close

  • parameters:
    • request
  • summary

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

  • type

    Function

• dojox.data.SnapLogicStore._fetchHandler

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

    Process data retrieved via fetch and send it back to requester.
    response:
    The data returend from the I/O transport. In the normal case, it will be an array of result rows
    from the pipeline. In the special case for record count optimization, response will be an array
    with a single element containing the total pipeline result row count. See fetch() for details
    on this optimization.

  • type

    Function

• dojox.data.SnapLogicStore._partHandler

  • parameters:
    • request: (typeof Object)

      The request/handle object used with the original fetch() call.

    • part: (typeof String)

      A value indicating which request this handler call is for (this.Parts).

    • response: (typeof Object)

      Response received from the underlying IO transport.

  • summary

    Handle the individual replies for both data and length requests.

  • type

    Function

• dojox.data.SnapLogicStore.fetch

  • parameters:
    • request: (typeof Object)

      See dojo.data.api.Read.close() for generic interface.
      
      In addition to the standard Read API fetch support, this store supports an optimization for
      for retrieving the total count of records in the Pipeline without retrieving the data. To
      use this optimization, simply provide an onBegin handler without an onItem or onComplete handler.

  • returns

    Object

  • summary

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

  • type

    Function

• dojox.data.SnapLogicStore._parameters

• dojox.data

  • type

    Object

• dojox

  • type

    Object