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