<!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: OfxRequest 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.4 -->
<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 Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data 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 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>
</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('classOfxRequest.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">OfxRequest Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="OfxRequest" --><!-- doxytag: inherits="OfxAggregate" -->
<p>A generic request.
<a href="classOfxRequest.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for OfxRequest:</div>
<div class="dyncontent">
<div class="center">
<img src="classOfxRequest.png" usemap="#OfxRequest_map" alt=""/>
<map id="OfxRequest_map" name="OfxRequest_map">
<area href="classOfxAggregate.html" title="A single aggregate as described in the OFX 1.02 specification." alt="OfxAggregate" shape="rect" coords="154,0,298,24"/>
<area href="classOfxAccountInfoRequest.html" title="An account information request." alt="OfxAccountInfoRequest" shape="rect" coords="0,112,144,136"/>
<area href="classOfxPaymentRequest.html" alt="OfxPaymentRequest" shape="rect" coords="154,112,298,136"/>
<area href="classOfxStatementRequest.html" title="A statement request." alt="OfxStatementRequest" shape="rect" coords="308,112,452,136"/>
</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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxRequest.html#aedf28b52122ebc61fab21bda14e611ea">OfxRequest</a> (const <a class="el" href="structOfxFiLogin.html">OfxFiLogin</a> &fi)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOfxAggregate.html">OfxAggregate</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxRequest.html#ab653f985a56f4cff3e87a82c700f4450">SignOnRequest</a> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOfxAggregate.html">OfxAggregate</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxRequest.html#ae56ceb8ef12b9431dcd4d63eec60a377">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"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9c831dd85c20955e6d062e8b5f660e00"></a><!-- doxytag: member="OfxRequest::m_login" ref="a9c831dd85c20955e6d062e8b5f660e00" args="" -->
<a class="el" href="structOfxFiLogin.html">OfxFiLogin</a> </td><td class="memItemRight" valign="bottom"><b>m_login</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A generic 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 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>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aedf28b52122ebc61fab21bda14e611ea"></a><!-- doxytag: member="OfxRequest::OfxRequest" ref="aedf28b52122ebc61fab21bda14e611ea" 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><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates the generic request aggregate.</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>
</table>
</dd>
</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>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae56ceb8ef12b9431dcd4d63eec60a377"></a><!-- doxytag: member="OfxRequest::RequestMessage" ref="ae56ceb8ef12b9431dcd4d63eec60a377" 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>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a message aggregate</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">msgtype</td><td>The type of message. This will be prepended to "MSGSRQV1" to become the tagname of the overall aggregate </td></tr>
<tr><td class="paramname">trntype</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 class="paramname">aggregate</td><td>The actual contents of the message, which will be a sub aggregate of the xxxTRNRQ aggregate. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><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#l00112">112</a> of file <a class="el" href="ofx__request_8cpp_source.html">ofx_request.cpp</a>.</p>
<p>Referenced by <a class="el" href="ofx__request__statement_8cpp_source.html#l00060">OfxStatementRequest::BankStatementRequest()</a>, <a class="el" href="ofx__request__statement_8cpp_source.html#l00087">OfxStatementRequest::CreditCardStatementRequest()</a>, <a class="el" href="ofx__request__statement_8cpp_source.html#l00111">OfxStatementRequest::InvestmentStatementRequest()</a>, <a class="el" href="ofx__request__accountinfo_8cpp_source.html#l00075">OfxAccountInfoRequest::OfxAccountInfoRequest()</a>, and <a class="el" href="ofx__request__statement_8cpp_source.html#l00149">OfxPaymentRequest::OfxPaymentRequest()</a>.</p>
</div>
</div>
<a class="anchor" id="ab653f985a56f4cff3e87a82c700f4450"></a><!-- doxytag: member="OfxRequest::SignOnRequest" ref="ab653f985a56f4cff3e87a82c700f4450" 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> 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"><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#l00084">84</a> of file <a class="el" href="ofx__request_8cpp_source.html">ofx_request.cpp</a>.</p>
<p>Referenced by <a class="el" href="ofx__request__accountinfo_8cpp_source.html#l00075">OfxAccountInfoRequest::OfxAccountInfoRequest()</a>, <a class="el" href="ofx__request__statement_8cpp_source.html#l00149">OfxPaymentRequest::OfxPaymentRequest()</a>, and <a class="el" href="ofx__request__statement_8cpp_source.html#l00045">OfxStatementRequest::OfxStatementRequest()</a>.</p>
</div>
</div>
<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>
<li><a class="el" href="ofx__request_8cpp_source.html">ofx_request.cpp</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="classOfxRequest.html">OfxRequest</a> </li>
<li class="footer">Generated on Wed Apr 17 2013 22:12:00 for LibOFX by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </li>
</ul>
</div>
</body>
</html>
