]>
Commit | Line | Data |
---|---|---|
f0cfe83e AD |
1 | define("dojo/data/api/Request", ["../../_base/declare"], function(declare){ |
2 | ||
3 | // module: | |
4 | // dojo/data/api/Request | |
5 | ||
6 | return declare("dojo.data.api.Request", null, { | |
7 | // summary: | |
8 | // This class defines out the semantics of what a 'Request' object looks like | |
9 | // when returned from a fetch() method. In general, a request object is | |
10 | // nothing more than the original keywordArgs from fetch with an abort function | |
11 | // attached to it to allow users to abort a particular request if they so choose. | |
12 | // No other functions are required on a general Request object return. That does not | |
13 | // inhibit other store implementations from adding extensions to it, of course. | |
14 | // | |
15 | // This is an abstract API that data provider implementations conform to. | |
16 | // This file defines methods signatures and intentionally leaves all the | |
17 | // methods unimplemented. | |
18 | // | |
19 | // For more details on fetch, see dojo/data/api/Read.fetch(). | |
20 | ||
21 | abort: function(){ | |
22 | // summary: | |
23 | // This function is a hook point for stores to provide as a way for | |
24 | // a fetch to be halted mid-processing. | |
25 | // description: | |
26 | // This function is a hook point for stores to provide as a way for | |
27 | // a fetch to be halted mid-processing. For more details on the fetch() api, | |
28 | // please see dojo/data/api/Read.fetch(). | |
29 | throw new Error('Unimplemented API: dojo.data.api.Request.abort'); | |
30 | } | |
31 | }); | |
32 | ||
33 | }); |