libofx-doc 1:0.9.4-2.1ubuntu1 / usr / share / doc / libofx-doc / html / classOfxStatementRequest.html

This file is indexed.

/usr/share/doc/libofx-doc/html/classOfxStatementRequest.html is in libofx-doc 1:0.9.4-2.1ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>LibOFX: OfxStatementRequest Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">LibOFX</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('classOfxStatementRequest.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a>  </div>
  <div class="headertitle">
<h1>OfxStatementRequest Class Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="OfxStatementRequest" --><!-- doxytag: inherits="OfxRequest,OfxRequest" -->
<p>A statement request.  
<a href="#_details">More...</a></p>
<div class="dynheader">
Inheritance diagram for OfxStatementRequest:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classOfxStatementRequest.png" usemap="#OfxStatementRequest_map" alt=""/>
  <map id="OfxStatementRequest_map" name="OfxStatementRequest_map">
<area href="classOfxRequest.html" alt="OfxRequest" shape="rect" coords="70,56,200,80"/>
<area href="classOfxRequest.html" alt="OfxRequest" shape="rect" coords="350,56,480,80"/>
<area href="classOfxAggregate.html" alt="OfxAggregate" shape="rect" coords="0,0,130,24"/>
<area href="classOfxAggregate.html" alt="OfxAggregate" shape="rect" coords="140,0,270,24"/>
<area href="classOfxAggregate.html" alt="OfxAggregate" shape="rect" coords="280,0,410,24"/>
<area href="classOfxAggregate.html" alt="OfxAggregate" shape="rect" coords="420,0,550,24"/>
</map>
 </div></div>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxStatementRequest.html#a26f2cb4111c3965436129c2bdfbf678b">OfxStatementRequest</a> (const <a class="el" href="structOfxFiLogin.html">OfxFiLogin</a> &amp;fi, const <a class="el" href="structOfxAccountData.html">OfxAccountData</a> &amp;account, time_t from)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxStatementRequest.html#a26f2cb4111c3965436129c2bdfbf678b">OfxStatementRequest</a> (const <a class="el" href="structOfxFiLogin.html">OfxFiLogin</a> &amp;fi, const <a class="el" href="structOfxAccountData.html">OfxAccountData</a> &amp;account, time_t from)</td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOfxAggregate.html">OfxAggregate</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxStatementRequest.html#a42f8752cca60b057325785563d67e92f">BankStatementRequest</a> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOfxAggregate.html">OfxAggregate</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxStatementRequest.html#a721c88927e57c1bc189b3e4b9410690d">CreditCardStatementRequest</a> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOfxAggregate.html">OfxAggregate</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxStatementRequest.html#ac3df87c5377e4d0d6f5944010527bea4">InvestmentStatementRequest</a> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOfxAggregate.html">OfxAggregate</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxStatementRequest.html#a42f8752cca60b057325785563d67e92f">BankStatementRequest</a> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOfxAggregate.html">OfxAggregate</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxStatementRequest.html#a721c88927e57c1bc189b3e4b9410690d">CreditCardStatementRequest</a> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOfxAggregate.html">OfxAggregate</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxStatementRequest.html#ac3df87c5377e4d0d6f5944010527bea4">InvestmentStatementRequest</a> (void) const </td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A statement request. </p>
<p>This is an entire OFX aggregate, with all subordinate aggregates needed to log onto the OFX server of a single financial institution and download a statement for a single account. </p>

<p>Definition at line <a class="el" href="ofx__request__statement_8hh_source.html#l00037">37</a> of file <a class="el" href="ofx__request__statement_8hh_source.html">ofx_request_statement.hh</a>.</p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a26f2cb4111c3965436129c2bdfbf678b"></a><!-- doxytag: member="OfxStatementRequest::OfxStatementRequest" ref="a26f2cb4111c3965436129c2bdfbf678b" args="(const OfxFiLogin &amp;fi, const OfxAccountData &amp;account, time_t from)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OfxStatementRequest::OfxStatementRequest </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structOfxFiLogin.html">OfxFiLogin</a> &amp;&#160;</td>
          <td class="paramname"><em>fi</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structOfxAccountData.html">OfxAccountData</a> &amp;&#160;</td>
          <td class="paramname"><em>account</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">time_t&#160;</td>
          <td class="paramname"><em>from</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Creates the request aggregate to obtain a statement from this <code>fi</code> for this <code>account</code>, starting on this <code>start</code> date, ending today.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">fi</td><td>The information needed to log on user into one financial institution </td></tr>
    <tr><td class="paramname">account</td><td>The account for which a statement is desired </td></tr>
    <tr><td class="paramname">start</td><td>The beginning time of the statement period desired </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="ofx__request__statement_8cpp_source.html#l00045">45</a> of file <a class="el" href="ofx__request__statement_8cpp_source.html">ofx_request_statement.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a26f2cb4111c3965436129c2bdfbf678b"></a><!-- doxytag: member="OfxStatementRequest::OfxStatementRequest" ref="a26f2cb4111c3965436129c2bdfbf678b" args="(const OfxFiLogin &amp;fi, const OfxAccountData &amp;account, time_t from)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OfxStatementRequest::OfxStatementRequest </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structOfxFiLogin.html">OfxFiLogin</a> &amp;&#160;</td>
          <td class="paramname"><em>fi</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structOfxAccountData.html">OfxAccountData</a> &amp;&#160;</td>
          <td class="paramname"><em>account</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">time_t&#160;</td>
          <td class="paramname"><em>from</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Creates the request aggregate to obtain a statement from this <code>fi</code> for this <code>account</code>, starting on this <code>start</code> date, ending today.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">fi</td><td>The information needed to log on user into one financial institution </td></tr>
    <tr><td class="paramname">account</td><td>The account for which a statement is desired </td></tr>
    <tr><td class="paramname">start</td><td>The beginning time of the statement period desired </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a42f8752cca60b057325785563d67e92f"></a><!-- doxytag: member="OfxStatementRequest::BankStatementRequest" ref="a42f8752cca60b057325785563d67e92f" args="(void) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classOfxAggregate.html">OfxAggregate</a> OfxStatementRequest::BankStatementRequest </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Creates a bank statement request aggregate, &lt;BANKMSGSRQV1&gt;, &lt;STMTTRNRQ&gt; &amp; &lt;STMTRQ&gt; for this account. Should only be used if this account is a BANK account.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The request aggregate created </dd></dl>

<p>Definition at line <a class="el" href="ofx__request__statement_8cpp_source.html#l00060">60</a> of file <a class="el" href="ofx__request__statement_8cpp_source.html">ofx_request_statement.cpp</a>.</p>

<p>Referenced by <a class="el" href="ofx__request__statement_8cpp_source.html#l00045">OfxStatementRequest()</a>.</p>

</div>
</div>
<a class="anchor" id="a42f8752cca60b057325785563d67e92f"></a><!-- doxytag: member="OfxStatementRequest::BankStatementRequest" ref="a42f8752cca60b057325785563d67e92f" args="(void) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classOfxAggregate.html">OfxAggregate</a> OfxStatementRequest::BankStatementRequest </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Creates a bank statement request aggregate, &lt;BANKMSGSRQV1&gt;, &lt;STMTTRNRQ&gt; &amp; &lt;STMTRQ&gt; for this account. Should only be used if this account is a BANK account.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The request aggregate created </dd></dl>

</div>
</div>
<a class="anchor" id="a721c88927e57c1bc189b3e4b9410690d"></a><!-- doxytag: member="OfxStatementRequest::CreditCardStatementRequest" ref="a721c88927e57c1bc189b3e4b9410690d" args="(void) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classOfxAggregate.html">OfxAggregate</a> OfxStatementRequest::CreditCardStatementRequest </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Creates a credit card statement request aggregate, &lt;CREDITCARDMSGSRQV1&gt;, &lt;CCSTMTTRNRQ&gt; &amp; &lt;CCSTMTRQ&gt; for this account. Should only be used if this account is a CREDIT CARD account.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The request aggregate created </dd></dl>

</div>
</div>
<a class="anchor" id="a721c88927e57c1bc189b3e4b9410690d"></a><!-- doxytag: member="OfxStatementRequest::CreditCardStatementRequest" ref="a721c88927e57c1bc189b3e4b9410690d" args="(void) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classOfxAggregate.html">OfxAggregate</a> OfxStatementRequest::CreditCardStatementRequest </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Creates a credit card statement request aggregate, &lt;CREDITCARDMSGSRQV1&gt;, &lt;CCSTMTTRNRQ&gt; &amp; &lt;CCSTMTRQ&gt; for this account. Should only be used if this account is a CREDIT CARD account.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The request aggregate created </dd></dl>

<p>Definition at line <a class="el" href="ofx__request__statement_8cpp_source.html#l00087">87</a> of file <a class="el" href="ofx__request__statement_8cpp_source.html">ofx_request_statement.cpp</a>.</p>

<p>Referenced by <a class="el" href="ofx__request__statement_8cpp_source.html#l00045">OfxStatementRequest()</a>.</p>

</div>
</div>
<a class="anchor" id="ac3df87c5377e4d0d6f5944010527bea4"></a><!-- doxytag: member="OfxStatementRequest::InvestmentStatementRequest" ref="ac3df87c5377e4d0d6f5944010527bea4" args="(void) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classOfxAggregate.html">OfxAggregate</a> OfxStatementRequest::InvestmentStatementRequest </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Creates an investment statement request aggregate, &lt;INSTMTMSGSRQV1&gt;, &lt;INVSTMTTRNRQ&gt; &amp; &lt;INVSTMTRQ&gt; for this account. Should only be used if this account is an INVESTMENT account.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The request aggregate created </dd></dl>

<p>Definition at line <a class="el" href="ofx__request__statement_8cpp_source.html#l00111">111</a> of file <a class="el" href="ofx__request__statement_8cpp_source.html">ofx_request_statement.cpp</a>.</p>

<p>Referenced by <a class="el" href="ofx__request__statement_8cpp_source.html#l00045">OfxStatementRequest()</a>.</p>

</div>
</div>
<a class="anchor" id="ac3df87c5377e4d0d6f5944010527bea4"></a><!-- doxytag: member="OfxStatementRequest::InvestmentStatementRequest" ref="ac3df87c5377e4d0d6f5944010527bea4" args="(void) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classOfxAggregate.html">OfxAggregate</a> OfxStatementRequest::InvestmentStatementRequest </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Creates an investment statement request aggregate, &lt;INSTMTMSGSRQV1&gt;, &lt;INVSTMTTRNRQ&gt; &amp; &lt;INVSTMTRQ&gt; for this account. Should only be used if this account is an INVESTMENT account.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The request aggregate created </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="ofx__request__statement_8hh_source.html">ofx_request_statement.hh</a></li>
<li><a class="el" href="fx-0_89_84_2lib_2ofx__request__statement_8hh_source.html">fx-0.9.4/lib/ofx_request_statement.hh</a></li>
<li><a class="el" href="ofx__request__statement_8cpp_source.html">ofx_request_statement.cpp</a></li>
<li><a class="el" href="fx-0_89_84_2lib_2ofx__request__statement_8cpp_source.html">fx-0.9.4/lib/ofx_request_statement.cpp</a></li>
</ul>
</div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="classOfxStatementRequest.html">OfxStatementRequest</a>      </li>
      <li class="footer">Generated on Mon Apr 18 2011 18:09:44 for LibOFX by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
    </ul>
  </div>

</body>
</html>

APT Browse - Built by Thomas Orozco.