]> git.pond.sub.org Git - eow/blob - static/dojo-release-1.1.1/dojo/data/api/Request.js
add Dojo 1.1.1
[eow] / static / dojo-release-1.1.1 / dojo / data / api / Request.js
1 if(!dojo._hasResource["dojo.data.api.Request"]){ //_hasResource checks added by build. Do not use _hasResource directly in your code.
2 dojo._hasResource["dojo.data.api.Request"] = true;
3 dojo.provide("dojo.data.api.Request");
4
5 dojo.declare("dojo.data.api.Request", null, {
6         //      summary:
7         //              This class defines out the semantics of what a 'Request' object looks like
8         //              when returned from a fetch() method.  In general, a request object is
9         //              nothing more than the original keywordArgs from fetch with an abort function 
10         //              attached to it to allow users to abort a particular request if they so choose. 
11         //              No other functions are required on a general Request object return.  That does not
12         //              inhibit other store implementations from adding extentions to it, of course.
13         //
14         //              This is an abstract API that data provider implementations conform to.  
15         //              This file defines methods signatures and intentionally leaves all the
16         //              methods unimplemented.
17         //
18         //              For more details on fetch, see dojo.data.api.Read.fetch().
19
20         abort: function(){
21                 //      summary:
22                 //              This function is a hook point for stores to provide as a way for 
23                 //              a fetch to be halted mid-processing.
24                 //      description:
25                 //              This function is a hook point for stores to provide as a way for 
26                 //              a fetch to be halted mid-processing.  For more details on the fetch() api,
27                 //              please see dojo.data.api.Read.fetch().
28                 throw new Error('Unimplemented API: dojo.data.api.Request.abort');
29         }
30 });
31
32 }