Sophie

Sophie

distrib > Mageia > 1 > i586 > media > core-release > by-pkgid > 0c518cc2e176451ea9eb99bff1e3388d > files > 42

libofx-devel-0.9.1-3.mga1.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>LibOFX: OfxStatementRequest Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.0 -->
<div class="tabs">
  <ul>
    <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li id="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul></div>
<div class="tabs">
  <ul>
    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
  </ul></div>
<h1>OfxStatementRequest Class Reference</h1><!-- doxytag: class="OfxStatementRequest" --><!-- doxytag: inherits="OfxRequest,OfxRequest" --><p>Inheritance diagram for OfxStatementRequest:
<p><center><img src="classOfxStatementRequest.png" usemap="#OfxStatementRequest_map" border="0" alt=""></center>
<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>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A statement request. 
<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>.<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxStatementRequest.html#26f2cb4111c3965436129c2bdfbf678b">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" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxStatementRequest.html#26f2cb4111c3965436129c2bdfbf678b">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"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classOfxAggregate.html">OfxAggregate</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxStatementRequest.html#d2db93d6d0ebb4837036128ceeaeb9a0">BankStatementRequest</a> (void) const</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classOfxAggregate.html">OfxAggregate</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxStatementRequest.html#321c4d59a5c97ca33a9401d134b6a7e0">CreditCardStatementRequest</a> (void) const</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classOfxAggregate.html">OfxAggregate</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxStatementRequest.html#439b0cff11e3b1f6f2c7b85366f0ae60">InvestmentStatementRequest</a> (void) const</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classOfxAggregate.html">OfxAggregate</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxStatementRequest.html#d2db93d6d0ebb4837036128ceeaeb9a0">BankStatementRequest</a> (void) const</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classOfxAggregate.html">OfxAggregate</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxStatementRequest.html#321c4d59a5c97ca33a9401d134b6a7e0">CreditCardStatementRequest</a> (void) const</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classOfxAggregate.html">OfxAggregate</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxStatementRequest.html#439b0cff11e3b1f6f2c7b85366f0ae60">InvestmentStatementRequest</a> (void) const</td></tr>

</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="26f2cb4111c3965436129c2bdfbf678b"></a><!-- doxytag: member="OfxStatementRequest::OfxStatementRequest" ref="26f2cb4111c3965436129c2bdfbf678b" 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;&nbsp;</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;&nbsp;</td>
          <td class="paramname"> <em>account</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">time_t&nbsp;</td>
          <td class="paramname"> <em>from</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></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 compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>fi</em>&nbsp;</td><td>The information needed to log on user into one financial institution </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>account</em>&nbsp;</td><td>The account for which a statement is desired </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>start</em>&nbsp;</td><td>The beginning time of the statement period desired </td></tr>
  </table>
</dl>

<p>
Definition at line <a class="el" href="ofx__request__statement_8cpp-source.html#l00044">44</a> of file <a class="el" href="ofx__request__statement_8cpp-source.html">ofx_request_statement.cpp</a>.
</div>
</div><p>
<a class="anchor" name="26f2cb4111c3965436129c2bdfbf678b"></a><!-- doxytag: member="OfxStatementRequest::OfxStatementRequest" ref="26f2cb4111c3965436129c2bdfbf678b" 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;&nbsp;</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;&nbsp;</td>
          <td class="paramname"> <em>account</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">time_t&nbsp;</td>
          <td class="paramname"> <em>from</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></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 compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>fi</em>&nbsp;</td><td>The information needed to log on user into one financial institution </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>account</em>&nbsp;</td><td>The account for which a statement is desired </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>start</em>&nbsp;</td><td>The beginning time of the statement period desired </td></tr>
  </table>
</dl>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="d2db93d6d0ebb4837036128ceeaeb9a0"></a><!-- doxytag: member="OfxStatementRequest::BankStatementRequest" ref="d2db93d6d0ebb4837036128ceeaeb9a0" 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&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> 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" compact><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#l00059">59</a> of file <a class="el" href="ofx__request__statement_8cpp-source.html">ofx_request_statement.cpp</a>.
<p>
Referenced by <a class="el" href="ofx__request__statement_8cpp-source.html#l00044">OfxStatementRequest()</a>.
</div>
</div><p>
<a class="anchor" name="321c4d59a5c97ca33a9401d134b6a7e0"></a><!-- doxytag: member="OfxStatementRequest::CreditCardStatementRequest" ref="321c4d59a5c97ca33a9401d134b6a7e0" 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&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> 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" compact><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#l00086">86</a> of file <a class="el" href="ofx__request__statement_8cpp-source.html">ofx_request_statement.cpp</a>.
<p>
Referenced by <a class="el" href="ofx__request__statement_8cpp-source.html#l00044">OfxStatementRequest()</a>.
</div>
</div><p>
<a class="anchor" name="439b0cff11e3b1f6f2c7b85366f0ae60"></a><!-- doxytag: member="OfxStatementRequest::InvestmentStatementRequest" ref="439b0cff11e3b1f6f2c7b85366f0ae60" 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&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> 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" compact><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#l00109">109</a> of file <a class="el" href="ofx__request__statement_8cpp-source.html">ofx_request_statement.cpp</a>.
<p>
Referenced by <a class="el" href="ofx__request__statement_8cpp-source.html#l00044">OfxStatementRequest()</a>.
</div>
</div><p>
<a class="anchor" name="d2db93d6d0ebb4837036128ceeaeb9a0"></a><!-- doxytag: member="OfxStatementRequest::BankStatementRequest" ref="d2db93d6d0ebb4837036128ceeaeb9a0" 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&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> 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" compact><dt><b>Returns:</b></dt><dd>The request aggregate created </dd></dl>

</div>
</div><p>
<a class="anchor" name="321c4d59a5c97ca33a9401d134b6a7e0"></a><!-- doxytag: member="OfxStatementRequest::CreditCardStatementRequest" ref="321c4d59a5c97ca33a9401d134b6a7e0" 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&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> 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" compact><dt><b>Returns:</b></dt><dd>The request aggregate created </dd></dl>

</div>
</div><p>
<a class="anchor" name="439b0cff11e3b1f6f2c7b85366f0ae60"></a><!-- doxytag: member="OfxStatementRequest::InvestmentStatementRequest" ref="439b0cff11e3b1f6f2c7b85366f0ae60" 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&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> 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" compact><dt><b>Returns:</b></dt><dd>The request aggregate created </dd></dl>

</div>
</div><p>
<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><a class="el" href="fx-0_89_81_2lib_2ofx__request__statement_8hh-source.html">fx-0.9.1/lib/ofx_request_statement.hh</a><li><a class="el" href="ofx__request__statement_8cpp-source.html">ofx_request_statement.cpp</a><li><a class="el" href="fx-0_89_81_2lib_2ofx__request__statement_8cpp-source.html">fx-0.9.1/lib/ofx_request_statement.cpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Mon Feb 9 21:22:00 2009 for LibOFX by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.0 </small></address>
</body>
</html>