lib/dojo/data/api/Request.js

   1 /*
   2         Copyright (c) 2004-2011, The Dojo Foundation All Rights Reserved.
   3         Available via Academic Free License >= 2.1 OR the modified BSD license.
   4         see: http://dojotoolkit.org/license for details
   5 */
   6
   7
   8 if(!dojo._hasResource["dojo.data.api.Request"]){ //_hasResource checks added by build. Do not use _hasResource directly in your code.
   9 dojo._hasResource["dojo.data.api.Request"] = true;
  10 dojo.provide("dojo.data.api.Request");
  11
  12
  13 dojo.declare("dojo.data.api.Request", null, {
  14         //      summary:
  15         //              This class defines out the semantics of what a 'Request' object looks like
  16         //              when returned from a fetch() method.  In general, a request object is
  17         //              nothing more than the original keywordArgs from fetch with an abort function
  18         //              attached to it to allow users to abort a particular request if they so choose.
  19         //              No other functions are required on a general Request object return.  That does not
  20         //              inhibit other store implementations from adding extentions to it, of course.
  21         //
  22         //              This is an abstract API that data provider implementations conform to.
  23         //              This file defines methods signatures and intentionally leaves all the
  24         //              methods unimplemented.
  25         //
  26         //              For more details on fetch, see dojo.data.api.Read.fetch().
  27
  28         abort: function(){
  29                 //      summary:
  30                 //              This function is a hook point for stores to provide as a way for
  31                 //              a fetch to be halted mid-processing.
  32                 //      description:
  33                 //              This function is a hook point for stores to provide as a way for
  34                 //              a fetch to be halted mid-processing.  For more details on the fetch() api,
  35                 //              please see dojo.data.api.Read.fetch().
  36                 throw new Error('Unimplemented API: dojo.data.api.Request.abort');
  37         }
  38 });
  39
  40 }