segmentStore

Implements the Dojo Object Store interface for uniform access to Segment objects.

Example
define([
  "dojo/_base/lang",
  "blueconic/api/data/store/segmentStore"
], function(lang, segmentStore) {
  var id = '4e4fc9d9-b92f-4c9e-b11c-1c1314f02964'; // An example ID used in BlueConic

  // Retrieve object by id
  segmentStore.get(id).then(lang.hitch(this, function(object) {
    // Successfully retrieved the object
  }), lang.hitch(this, function() {
    // Failed to retrieve the object
  }));
});

Functions

get(id)dojo/Deferred

Returns one segment specified by the given id.

Name Type Description
id String

the id of the segment to retrieve.
Returns:
Type Description
dojo/Deferred blueconic.api.data.domain.Segment wrapped in a Deferred.

query()dojo/Deferred

Query the store for segments based on the provided parameters.

Returns:
Type Description
dojo/Deferred deferred containing the result set of type blueconic.api.data.domain.Segment wrapped in a dojo/store/util/QueryResults.