<!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: OfxRequest 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 Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li id="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul></div>
<h1>OfxRequest Class Reference</h1><!-- doxytag: class="OfxRequest" --><!-- doxytag: inherits="OfxAggregate,OfxAggregate" --><p>Inheritance diagram for OfxRequest:
<p><center><img src="classOfxRequest.png" usemap="#OfxRequest_map" border="0" alt=""></center>
<map name="OfxRequest_map">
<area href="classOfxAggregate.html" alt="OfxAggregate" shape="rect" coords="308,0,452,24">
<area href="classOfxAggregate.html" alt="OfxAggregate" shape="rect" coords="462,0,606,24">
<area href="classOfxAccountInfoRequest.html" alt="OfxAccountInfoRequest" shape="rect" coords="0,112,144,136">
<area href="classOfxAccountInfoRequest.html" alt="OfxAccountInfoRequest" shape="rect" coords="154,112,298,136">
<area href="classOfxPaymentRequest.html" alt="OfxPaymentRequest" shape="rect" coords="308,112,452,136">
<area href="classOfxPaymentRequest.html" alt="OfxPaymentRequest" shape="rect" coords="462,112,606,136">
<area href="classOfxStatementRequest.html" alt="OfxStatementRequest" shape="rect" coords="616,112,760,136">
<area href="classOfxStatementRequest.html" alt="OfxStatementRequest" shape="rect" coords="770,112,914,136">
</map>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A generic 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 process a request. The details of the particular request are up to subclasses of this one.
<p>
<p>
Definition at line <a class="el" href="ofx__request_8hh-source.html#l00036">36</a> of file <a class="el" href="ofx__request_8hh-source.html">ofx_request.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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxRequest.html#edf28b52122ebc61fab21bda14e611ea">OfxRequest</a> (const <a class="el" href="structOfxFiLogin.html">OfxFiLogin</a> &fi)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classOfxAggregate.html">OfxAggregate</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxRequest.html#a72d77df77692683e34cb688fb076bc8">SignOnRequest</a> (void) const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classOfxAggregate.html">OfxAggregate</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxRequest.html#26455e9084a589df3a125ef0dc846971">RequestMessage</a> (const string &msgtype, const string &trntype, const <a class="el" href="classOfxAggregate.html">OfxAggregate</a> &aggregate) const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxRequest.html#edf28b52122ebc61fab21bda14e611ea">OfxRequest</a> (const <a class="el" href="structOfxFiLogin.html">OfxFiLogin</a> &fi)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classOfxAggregate.html">OfxAggregate</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxRequest.html#a72d77df77692683e34cb688fb076bc8">SignOnRequest</a> (void) const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classOfxAggregate.html">OfxAggregate</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxRequest.html#26455e9084a589df3a125ef0dc846971">RequestMessage</a> (const string &msgtype, const string &trntype, const <a class="el" href="classOfxAggregate.html">OfxAggregate</a> &aggregate) const</td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9c831dd85c20955e6d062e8b5f660e00"></a><!-- doxytag: member="OfxRequest::m_login" ref="9c831dd85c20955e6d062e8b5f660e00" args="" -->
<a class="el" href="structOfxFiLogin.html">OfxFiLogin</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxRequest.html#9c831dd85c20955e6d062e8b5f660e00">m_login</a></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="edf28b52122ebc61fab21bda14e611ea"></a><!-- doxytag: member="OfxRequest::OfxRequest" ref="edf28b52122ebc61fab21bda14e611ea" args="(const OfxFiLogin &fi)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OfxRequest::OfxRequest </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structOfxFiLogin.html">OfxFiLogin</a> & </td>
<td class="paramname"> <em>fi</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates the generic request aggregate.<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> </td><td>The information needed to log on user into one financial institution </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="ofx__request_8hh-source.html#l00045">45</a> of file <a class="el" href="ofx__request_8hh-source.html">ofx_request.hh</a>.
</div>
</div><p>
<a class="anchor" name="edf28b52122ebc61fab21bda14e611ea"></a><!-- doxytag: member="OfxRequest::OfxRequest" ref="edf28b52122ebc61fab21bda14e611ea" args="(const OfxFiLogin &fi)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OfxRequest::OfxRequest </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structOfxFiLogin.html">OfxFiLogin</a> & </td>
<td class="paramname"> <em>fi</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates the generic request aggregate.<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> </td><td>The information needed to log on user into one financial institution </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="fx-0_89_81_2lib_2ofx__request_8hh-source.html#l00045">45</a> of file <a class="el" href="fx-0_89_81_2lib_2ofx__request_8hh-source.html">fx-0.9.1/lib/ofx_request.hh</a>.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a72d77df77692683e34cb688fb076bc8"></a><!-- doxytag: member="OfxRequest::SignOnRequest" ref="a72d77df77692683e34cb688fb076bc8" args="(void) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOfxAggregate.html">OfxAggregate</a> OfxRequest::SignOnRequest </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates a signon request aggregate, <SIGNONMSGSRQV1> & <SONRQ>, sufficient to log this user into this financial institution.<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_8cpp-source.html#l00082">82</a> of file <a class="el" href="ofx__request_8cpp-source.html">ofx_request.cpp</a>.
<p>
Referenced by <a class="el" href="ofx__request__statement_8cpp-source.html#l00191">libofx_request_payment_status()</a>, <a class="el" href="ofx__request__accountinfo_8cpp-source.html#l00074">OfxAccountInfoRequest::OfxAccountInfoRequest()</a>, <a class="el" href="ofx__request__statement_8cpp-source.html#l00147">OfxPaymentRequest::OfxPaymentRequest()</a>, and <a class="el" href="ofx__request__statement_8cpp-source.html#l00044">OfxStatementRequest::OfxStatementRequest()</a>.
</div>
</div><p>
<a class="anchor" name="26455e9084a589df3a125ef0dc846971"></a><!-- doxytag: member="OfxRequest::RequestMessage" ref="26455e9084a589df3a125ef0dc846971" args="(const string &msgtype, const string &trntype, const OfxAggregate &aggregate) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOfxAggregate.html">OfxAggregate</a> OfxRequest::RequestMessage </td>
<td>(</td>
<td class="paramtype">const string & </td>
<td class="paramname"> <em>msgtype</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const string & </td>
<td class="paramname"> <em>trntype</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classOfxAggregate.html">OfxAggregate</a> & </td>
<td class="paramname"> <em>aggregate</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates a message aggregate<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>msgtype</em> </td><td>The type of message. This will be prepended to "MSGSRQV1" to become the tagname of the overall aggregate </td></tr>
<tr><td valign="top"></td><td valign="top"><em>trntype</em> </td><td>The type of transactions being requested. This will be prepended to "TRNRQ" to become the tagname of the subordinate aggregate. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aggregate</em> </td><td>The actual contents of the message, which will be a sub aggregate of the xxxTRNRQ aggregate. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The message aggregate created </dd></dl>
<p>
Definition at line <a class="el" href="ofx__request_8cpp-source.html#l00110">110</a> of file <a class="el" href="ofx__request_8cpp-source.html">ofx_request.cpp</a>.
<p>
Referenced by <a class="el" href="ofx__request__statement_8cpp-source.html#l00059">OfxStatementRequest::BankStatementRequest()</a>, <a class="el" href="ofx__request__statement_8cpp-source.html#l00086">OfxStatementRequest::CreditCardStatementRequest()</a>, <a class="el" href="ofx__request__statement_8cpp-source.html#l00109">OfxStatementRequest::InvestmentStatementRequest()</a>, <a class="el" href="ofx__request__statement_8cpp-source.html#l00191">libofx_request_payment_status()</a>, <a class="el" href="ofx__request__accountinfo_8cpp-source.html#l00074">OfxAccountInfoRequest::OfxAccountInfoRequest()</a>, and <a class="el" href="ofx__request__statement_8cpp-source.html#l00147">OfxPaymentRequest::OfxPaymentRequest()</a>.
</div>
</div><p>
<a class="anchor" name="a72d77df77692683e34cb688fb076bc8"></a><!-- doxytag: member="OfxRequest::SignOnRequest" ref="a72d77df77692683e34cb688fb076bc8" args="(void) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOfxAggregate.html">OfxAggregate</a> OfxRequest::SignOnRequest </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates a signon request aggregate, <SIGNONMSGSRQV1> & <SONRQ>, sufficient to log this user into this financial institution.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The request aggregate created </dd></dl>
</div>
</div><p>
<a class="anchor" name="26455e9084a589df3a125ef0dc846971"></a><!-- doxytag: member="OfxRequest::RequestMessage" ref="26455e9084a589df3a125ef0dc846971" args="(const string &msgtype, const string &trntype, const OfxAggregate &aggregate) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOfxAggregate.html">OfxAggregate</a> OfxRequest::RequestMessage </td>
<td>(</td>
<td class="paramtype">const string & </td>
<td class="paramname"> <em>msgtype</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const string & </td>
<td class="paramname"> <em>trntype</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classOfxAggregate.html">OfxAggregate</a> & </td>
<td class="paramname"> <em>aggregate</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates a message aggregate<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>msgtype</em> </td><td>The type of message. This will be prepended to "MSGSRQV1" to become the tagname of the overall aggregate </td></tr>
<tr><td valign="top"></td><td valign="top"><em>trntype</em> </td><td>The type of transactions being requested. This will be prepended to "TRNRQ" to become the tagname of the subordinate aggregate. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aggregate</em> </td><td>The actual contents of the message, which will be a sub aggregate of the xxxTRNRQ aggregate. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The message 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_8hh-source.html">ofx_request.hh</a><li><a class="el" href="fx-0_89_81_2lib_2ofx__request_8hh-source.html">fx-0.9.1/lib/ofx_request.hh</a><li><a class="el" href="ofx__request_8cpp-source.html">ofx_request.cpp</a><li><a class="el" href="fx-0_89_81_2lib_2ofx__request_8cpp-source.html">fx-0.9.1/lib/ofx_request.cpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Mon Feb 9 21:22:00 2009 for LibOFX by
<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>
