1
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3
3
<title>LibOFX: OfxRequest Class Reference</title>
4
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
5
5
<link href="tabs.css" rel="stylesheet" type="text/css">
7
<!-- Generated by Doxygen 1.4.6 -->
7
<!-- Generated by Doxygen 1.5.3 -->
10
10
<li><a href="main.html"><span>Main Page</span></a></li>
11
11
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
12
<li id="current"><a href="annotated.html"><span>Data Structures</span></a></li>
12
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
13
13
<li><a href="files.html"><span>Files</span></a></li>
17
18
<li><a href="annotated.html"><span>Data Structures</span></a></li>
18
19
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
19
20
<li><a href="functions.html"><span>Data Fields</span></a></li>
21
<h1>OfxRequest Class Reference</h1><!-- doxytag: class="OfxRequest" --><!-- doxytag: inherits="OfxAggregate,OfxAggregate" --><p>Inheritance diagram for OfxRequest:
23
<h1>OfxRequest Class Reference</h1><!-- doxytag: class="OfxRequest" --><!-- doxytag: inherits="OfxAggregate,OfxAggregate,OfxAggregate" --><div class="dynheader">
24
Inheritance diagram for OfxRequest:</div>
25
<div class="dynsection">
22
27
<p><center><img src="classOfxRequest.png" usemap="#OfxRequest_map" border="0" alt=""></center>
23
28
<map name="OfxRequest_map">
29
<area href="classOfxAggregate.html" alt="OfxAggregate" shape="rect" coords="0,0,144,24">
30
<area href="classOfxAggregate.html" alt="OfxAggregate" shape="rect" coords="154,0,298,24">
24
31
<area href="classOfxAggregate.html" alt="OfxAggregate" shape="rect" coords="308,0,452,24">
25
<area href="classOfxAggregate.html" alt="OfxAggregate" shape="rect" coords="462,0,606,24">
26
<area href="classOfxAccountInfoRequest.html" alt="OfxAccountInfoRequest" shape="rect" coords="0,112,144,136">
27
<area href="classOfxAccountInfoRequest.html" alt="OfxAccountInfoRequest" shape="rect" coords="154,112,298,136">
28
<area href="classOfxPaymentRequest.html" alt="OfxPaymentRequest" shape="rect" coords="308,112,452,136">
29
<area href="classOfxPaymentRequest.html" alt="OfxPaymentRequest" shape="rect" coords="462,112,606,136">
30
<area href="classOfxStatementRequest.html" alt="OfxStatementRequest" shape="rect" coords="616,112,760,136">
31
<area href="classOfxStatementRequest.html" alt="OfxStatementRequest" shape="rect" coords="770,112,914,136">
32
<area href="classOfxAccountInfoRequest.html" alt="OfxAccountInfoRequest" shape="rect" coords="308,112,452,136">
33
<area href="classOfxAccountInfoRequest.html" alt="OfxAccountInfoRequest" shape="rect" coords="308,168,452,192">
34
<area href="classOfxAccountInfoRequest.html" alt="OfxAccountInfoRequest" shape="rect" coords="308,224,452,248">
35
<area href="classOfxPaymentRequest.html" alt="OfxPaymentRequest" shape="rect" coords="308,280,452,304">
36
<area href="classOfxPaymentRequest.html" alt="OfxPaymentRequest" shape="rect" coords="308,336,452,360">
37
<area href="classOfxPaymentRequest.html" alt="OfxPaymentRequest" shape="rect" coords="308,392,452,416">
38
<area href="classOfxStatementRequest.html" alt="OfxStatementRequest" shape="rect" coords="308,448,452,472">
39
<area href="classOfxStatementRequest.html" alt="OfxStatementRequest" shape="rect" coords="308,504,452,528">
40
<area href="classOfxStatementRequest.html" alt="OfxStatementRequest" shape="rect" coords="308,560,452,584">
33
43
<hr><a name="_details"></a><h2>Detailed Description</h2>
36
46
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.
40
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">
47
<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>
48
<table border="0" cellpadding="0" cellspacing="0">
42
50
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
43
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxRequest.html#1e44a0bea2084ac4805e478f43e42837">OfxRequest</a> (const <a class="el" href="structOfxFiLogin.html">OfxFiLogin</a> &fi)</td></tr>
45
<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#af46e4046c4baddbb096b1eb1b4c46a8">SignOnRequest</a> (void) const </td></tr>
47
<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#a544b825f95778918ab737d985466eb2">RequestMessage</a> (const string &msgtype, const string &trntype, const <a class="el" href="classOfxAggregate.html">OfxAggregate</a> &aggregate) const </td></tr>
49
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxRequest.html#1e44a0bea2084ac4805e478f43e42837">OfxRequest</a> (const <a class="el" href="structOfxFiLogin.html">OfxFiLogin</a> &fi)</td></tr>
51
<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#af46e4046c4baddbb096b1eb1b4c46a8">SignOnRequest</a> (void) const </td></tr>
53
<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#a544b825f95778918ab737d985466eb2">RequestMessage</a> (const string &msgtype, const string &trntype, const <a class="el" href="classOfxAggregate.html">OfxAggregate</a> &aggregate) const </td></tr>
51
<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>
53
<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#b653f985a56f4cff3e87a82c700f4450">SignOnRequest</a> (void) const </td></tr>
55
<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#e56ceb8ef12b9431dcd4d63eec60a377">RequestMessage</a> (const string &msgtype, const string &trntype, const <a class="el" href="classOfxAggregate.html">OfxAggregate</a> &aggregate) const </td></tr>
57
<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>
59
<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#b653f985a56f4cff3e87a82c700f4450">SignOnRequest</a> (void) const </td></tr>
61
<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#e56ceb8ef12b9431dcd4d63eec60a377">RequestMessage</a> (const string &msgtype, const string &trntype, const <a class="el" href="classOfxAggregate.html">OfxAggregate</a> &aggregate) const </td></tr>
63
<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>
65
<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#b653f985a56f4cff3e87a82c700f4450">SignOnRequest</a> (void) const </td></tr>
67
<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#e56ceb8ef12b9431dcd4d63eec60a377">RequestMessage</a> (const string &msgtype, const string &trntype, const <a class="el" href="classOfxAggregate.html">OfxAggregate</a> &aggregate) const </td></tr>
55
69
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
56
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="656e286ea5ffc6918a71cd521c5b95d3"></a><!-- doxytag: member="OfxRequest::m_login" ref="656e286ea5ffc6918a71cd521c5b95d3" args="" -->
57
<a class="el" href="structOfxFiLogin.html">OfxFiLogin</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxRequest.html#656e286ea5ffc6918a71cd521c5b95d3">m_login</a></td></tr>
70
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9c831dd85c20955e6d062e8b5f660e00"></a><!-- doxytag: member="OfxRequest::m_login" ref="9c831dd85c20955e6d062e8b5f660e00" args="" -->
71
<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>
60
74
<hr><h2>Constructor & Destructor Documentation</h2>
61
<a class="anchor" name="1e44a0bea2084ac4805e478f43e42837"></a><!-- doxytag: member="OfxRequest::OfxRequest" ref="1e44a0bea2084ac4805e478f43e42837" args="(const OfxFiLogin &fi)" --><p>
62
<table class="mdTable" cellpadding="2" cellspacing="0">
65
<table cellpadding="0" cellspacing="0" border="0">
67
<td class="md" nowrap valign="top">OfxRequest::OfxRequest </td>
68
<td class="md" valign="top">( </td>
69
<td class="md" nowrap valign="top">const <a class="el" href="structOfxFiLogin.html">OfxFiLogin</a> & </td>
70
<td class="mdname1" valign="top" nowrap> <em>fi</em> </td>
71
<td class="md" valign="top"> ) </td>
72
<td class="md" nowrap><code> [inline]</code></td>
78
<table cellspacing="5" cellpadding="0" border="0">
86
Creates the generic request aggregate.<p>
87
<dl compact><dt><b>Parameters:</b></dt><dd>
88
<table border="0" cellspacing="2" cellpadding="0">
89
<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>
94
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>. </td>
97
<a class="anchor" name="1e44a0bea2084ac4805e478f43e42837"></a><!-- doxytag: member="OfxRequest::OfxRequest" ref="1e44a0bea2084ac4805e478f43e42837" args="(const OfxFiLogin &fi)" --><p>
98
<table class="mdTable" cellpadding="2" cellspacing="0">
101
<table cellpadding="0" cellspacing="0" border="0">
103
<td class="md" nowrap valign="top">OfxRequest::OfxRequest </td>
104
<td class="md" valign="top">( </td>
105
<td class="md" nowrap valign="top">const <a class="el" href="structOfxFiLogin.html">OfxFiLogin</a> & </td>
106
<td class="mdname1" valign="top" nowrap> <em>fi</em> </td>
107
<td class="md" valign="top"> ) </td>
108
<td class="md" nowrap><code> [inline]</code></td>
114
<table cellspacing="5" cellpadding="0" border="0">
122
Creates the generic request aggregate.<p>
123
<dl compact><dt><b>Parameters:</b></dt><dd>
124
<table border="0" cellspacing="2" cellpadding="0">
125
<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>
130
Definition at line <a class="el" href="fx-0_88_82_2lib_2ofx__request_8hh-source.html#l00045">45</a> of file <a class="el" href="fx-0_88_82_2lib_2ofx__request_8hh-source.html">fx-0.8.2/lib/ofx_request.hh</a>. </td>
75
<a class="anchor" name="edf28b52122ebc61fab21bda14e611ea"></a><!-- doxytag: member="OfxRequest::OfxRequest" ref="edf28b52122ebc61fab21bda14e611ea" args="(const OfxFiLogin &fi)" -->
77
<div class="memproto">
78
<table class="memname">
80
<td class="memname">OfxRequest::OfxRequest </td>
82
<td class="paramtype">const <a class="el" href="structOfxFiLogin.html">OfxFiLogin</a> & </td>
83
<td class="paramname"> <em>fi</em> </td>
84
<td> ) </td>
85
<td width="100%"><code> [inline]</code></td>
92
Creates the generic request aggregate.<p>
93
<dl compact><dt><b>Parameters:</b></dt><dd>
94
<table border="0" cellspacing="2" cellpadding="0">
95
<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>
99
<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>
103
<a class="anchor" name="edf28b52122ebc61fab21bda14e611ea"></a><!-- doxytag: member="OfxRequest::OfxRequest" ref="edf28b52122ebc61fab21bda14e611ea" args="(const OfxFiLogin &fi)" -->
104
<div class="memitem">
105
<div class="memproto">
106
<table class="memname">
108
<td class="memname">OfxRequest::OfxRequest </td>
110
<td class="paramtype">const <a class="el" href="structOfxFiLogin.html">OfxFiLogin</a> & </td>
111
<td class="paramname"> <em>fi</em> </td>
112
<td> ) </td>
113
<td width="100%"><code> [inline]</code></td>
120
Creates the generic request aggregate.<p>
121
<dl compact><dt><b>Parameters:</b></dt><dd>
122
<table border="0" cellspacing="2" cellpadding="0">
123
<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>
127
<p>Definition at line <a class="el" href="fx-0_88_82_2lib_2ofx__request_8hh-source.html#l00045">45</a> of file <a class="el" href="fx-0_88_82_2lib_2ofx__request_8hh-source.html">fx-0.8.2/lib/ofx_request.hh</a>.</p>
131
<a class="anchor" name="edf28b52122ebc61fab21bda14e611ea"></a><!-- doxytag: member="OfxRequest::OfxRequest" ref="edf28b52122ebc61fab21bda14e611ea" args="(const OfxFiLogin &fi)" -->
132
<div class="memitem">
133
<div class="memproto">
134
<table class="memname">
136
<td class="memname">OfxRequest::OfxRequest </td>
138
<td class="paramtype">const <a class="el" href="structOfxFiLogin.html">OfxFiLogin</a> & </td>
139
<td class="paramname"> <em>fi</em> </td>
140
<td> ) </td>
141
<td width="100%"><code> [inline]</code></td>
148
Creates the generic request aggregate.<p>
149
<dl compact><dt><b>Parameters:</b></dt><dd>
150
<table border="0" cellspacing="2" cellpadding="0">
151
<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>
155
<p>Definition at line <a class="el" href="fx-0_89_80_2lib_2ofx__request_8hh-source.html#l00045">45</a> of file <a class="el" href="fx-0_89_80_2lib_2ofx__request_8hh-source.html">fx-0.9.0/lib/ofx_request.hh</a>.</p>
133
159
<hr><h2>Member Function Documentation</h2>
134
<a class="anchor" name="a544b825f95778918ab737d985466eb2"></a><!-- doxytag: member="OfxRequest::RequestMessage" ref="a544b825f95778918ab737d985466eb2" args="(const string &msgtype, const string &trntype, const OfxAggregate &aggregate) const " --><p>
135
<table class="mdTable" cellpadding="2" cellspacing="0">
138
<table cellpadding="0" cellspacing="0" border="0">
140
<td class="md" nowrap valign="top"><a class="el" href="classOfxAggregate.html">OfxAggregate</a> OfxRequest::RequestMessage </td>
141
<td class="md" valign="top">( </td>
142
<td class="md" nowrap valign="top">const string & </td>
143
<td class="mdname" nowrap> <em>msgtype</em>, </td>
146
<td class="md" nowrap align="right"></td>
148
<td class="md" nowrap>const string & </td>
149
<td class="mdname" nowrap> <em>trntype</em>, </td>
152
<td class="md" nowrap align="right"></td>
154
<td class="md" nowrap>const <a class="el" href="classOfxAggregate.html">OfxAggregate</a> & </td>
155
<td class="mdname" nowrap> <em>aggregate</em></td>
159
<td class="md">) </td>
160
<td class="md" colspan="2"> const</td>
166
<table cellspacing="5" cellpadding="0" border="0">
174
Creates a message aggregate<p>
175
<dl compact><dt><b>Parameters:</b></dt><dd>
176
<table border="0" cellspacing="2" cellpadding="0">
177
<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>
178
<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>
179
<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>
182
<dl compact><dt><b>Returns:</b></dt><dd>The message aggregate created </dd></dl>
186
<a class="anchor" name="a544b825f95778918ab737d985466eb2"></a><!-- doxytag: member="OfxRequest::RequestMessage" ref="a544b825f95778918ab737d985466eb2" args="(const string &msgtype, const string &trntype, const OfxAggregate &aggregate) const " --><p>
187
<table class="mdTable" cellpadding="2" cellspacing="0">
190
<table cellpadding="0" cellspacing="0" border="0">
192
<td class="md" nowrap valign="top"><a class="el" href="classOfxAggregate.html">OfxAggregate</a> OfxRequest::RequestMessage </td>
193
<td class="md" valign="top">( </td>
194
<td class="md" nowrap valign="top">const string & </td>
195
<td class="mdname" nowrap> <em>msgtype</em>, </td>
198
<td class="md" nowrap align="right"></td>
200
<td class="md" nowrap>const string & </td>
201
<td class="mdname" nowrap> <em>trntype</em>, </td>
204
<td class="md" nowrap align="right"></td>
206
<td class="md" nowrap>const <a class="el" href="classOfxAggregate.html">OfxAggregate</a> & </td>
207
<td class="mdname" nowrap> <em>aggregate</em></td>
211
<td class="md">) </td>
212
<td class="md" colspan="2"> const</td>
218
<table cellspacing="5" cellpadding="0" border="0">
226
Creates a message aggregate<p>
227
<dl compact><dt><b>Parameters:</b></dt><dd>
228
<table border="0" cellspacing="2" cellpadding="0">
229
<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>
230
<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>
231
<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>
234
<dl compact><dt><b>Returns:</b></dt><dd>The message aggregate created </dd></dl>
237
Definition at line <a class="el" href="ofx__request_8cpp-source.html#l00088">88</a> of file <a class="el" href="ofx__request_8cpp-source.html">ofx_request.cpp</a>.
239
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#l00078">OfxStatementRequest::CreditCardStatementRequest()</a>, <a class="el" href="ofx__request__statement_8cpp-source.html#l00101">OfxStatementRequest::InvestmentStatementRequest()</a>, <a class="el" href="ofx__request__statement_8cpp-source.html#l00175">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#l00139">OfxPaymentRequest::OfxPaymentRequest()</a>. </td>
242
<a class="anchor" name="af46e4046c4baddbb096b1eb1b4c46a8"></a><!-- doxytag: member="OfxRequest::SignOnRequest" ref="af46e4046c4baddbb096b1eb1b4c46a8" args="(void) const " --><p>
243
<table class="mdTable" cellpadding="2" cellspacing="0">
246
<table cellpadding="0" cellspacing="0" border="0">
248
<td class="md" nowrap valign="top"><a class="el" href="classOfxAggregate.html">OfxAggregate</a> OfxRequest::SignOnRequest </td>
249
<td class="md" valign="top">( </td>
250
<td class="md" nowrap valign="top">void </td>
251
<td class="mdname1" valign="top" nowrap> </td>
252
<td class="md" valign="top"> ) </td>
253
<td class="md" nowrap> const</td>
259
<table cellspacing="5" cellpadding="0" border="0">
267
Creates a signon request aggregate, <SIGNONMSGSRQV1> & <SONRQ>, sufficient to log this user into this financial institution.<p>
268
<dl compact><dt><b>Returns:</b></dt><dd>The request aggregate created </dd></dl>
272
<a class="anchor" name="af46e4046c4baddbb096b1eb1b4c46a8"></a><!-- doxytag: member="OfxRequest::SignOnRequest" ref="af46e4046c4baddbb096b1eb1b4c46a8" args="(void) const " --><p>
273
<table class="mdTable" cellpadding="2" cellspacing="0">
276
<table cellpadding="0" cellspacing="0" border="0">
278
<td class="md" nowrap valign="top"><a class="el" href="classOfxAggregate.html">OfxAggregate</a> OfxRequest::SignOnRequest </td>
279
<td class="md" valign="top">( </td>
280
<td class="md" nowrap valign="top">void </td>
281
<td class="mdname1" valign="top" nowrap> </td>
282
<td class="md" valign="top"> ) </td>
283
<td class="md" nowrap> const</td>
289
<table cellspacing="5" cellpadding="0" border="0">
297
Creates a signon request aggregate, <SIGNONMSGSRQV1> & <SONRQ>, sufficient to log this user into this financial institution.<p>
298
<dl compact><dt><b>Returns:</b></dt><dd>The request aggregate created </dd></dl>
301
Definition at line <a class="el" href="ofx__request_8cpp-source.html#l00066">66</a> of file <a class="el" href="ofx__request_8cpp-source.html">ofx_request.cpp</a>.
303
Referenced by <a class="el" href="ofx__request__statement_8cpp-source.html#l00175">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#l00139">OfxPaymentRequest::OfxPaymentRequest()</a>, and <a class="el" href="ofx__request__statement_8cpp-source.html#l00044">OfxStatementRequest::OfxStatementRequest()</a>. </td>
160
<a class="anchor" name="b653f985a56f4cff3e87a82c700f4450"></a><!-- doxytag: member="OfxRequest::SignOnRequest" ref="b653f985a56f4cff3e87a82c700f4450" args="(void) const " -->
161
<div class="memitem">
162
<div class="memproto">
163
<table class="memname">
165
<td class="memname"><a class="el" href="classOfxAggregate.html">OfxAggregate</a> OfxRequest::SignOnRequest </td>
167
<td class="paramtype">void </td>
168
<td class="paramname"> </td>
169
<td> ) </td>
170
<td width="100%"> const</td>
177
Creates a signon request aggregate, <SIGNONMSGSRQV1> & <SONRQ>, sufficient to log this user into this financial institution.<p>
178
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The request aggregate created </dd></dl>
180
<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>
182
<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>.</p>
186
<a class="anchor" name="e56ceb8ef12b9431dcd4d63eec60a377"></a><!-- doxytag: member="OfxRequest::RequestMessage" ref="e56ceb8ef12b9431dcd4d63eec60a377" args="(const string &msgtype, const string &trntype, const OfxAggregate &aggregate) const " -->
187
<div class="memitem">
188
<div class="memproto">
189
<table class="memname">
191
<td class="memname"><a class="el" href="classOfxAggregate.html">OfxAggregate</a> OfxRequest::RequestMessage </td>
193
<td class="paramtype">const string & </td>
194
<td class="paramname"> <em>msgtype</em>, </td>
197
<td class="paramkey"></td>
199
<td class="paramtype">const string & </td>
200
<td class="paramname"> <em>trntype</em>, </td>
203
<td class="paramkey"></td>
205
<td class="paramtype">const <a class="el" href="classOfxAggregate.html">OfxAggregate</a> & </td>
206
<td class="paramname"> <em>aggregate</em></td><td> </td>
211
<td></td><td></td><td width="100%"> const</td>
218
Creates a message aggregate<p>
219
<dl compact><dt><b>Parameters:</b></dt><dd>
220
<table border="0" cellspacing="2" cellpadding="0">
221
<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>
222
<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>
223
<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>
226
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The message aggregate created </dd></dl>
228
<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>
230
<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>.</p>
234
<a class="anchor" name="b653f985a56f4cff3e87a82c700f4450"></a><!-- doxytag: member="OfxRequest::SignOnRequest" ref="b653f985a56f4cff3e87a82c700f4450" args="(void) const " -->
235
<div class="memitem">
236
<div class="memproto">
237
<table class="memname">
239
<td class="memname"><a class="el" href="classOfxAggregate.html">OfxAggregate</a> OfxRequest::SignOnRequest </td>
241
<td class="paramtype">void </td>
242
<td class="paramname"> </td>
243
<td> ) </td>
244
<td width="100%"> const</td>
251
Creates a signon request aggregate, <SIGNONMSGSRQV1> & <SONRQ>, sufficient to log this user into this financial institution.<p>
252
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The request aggregate created </dd></dl>
256
<a class="anchor" name="e56ceb8ef12b9431dcd4d63eec60a377"></a><!-- doxytag: member="OfxRequest::RequestMessage" ref="e56ceb8ef12b9431dcd4d63eec60a377" args="(const string &msgtype, const string &trntype, const OfxAggregate &aggregate) const " -->
257
<div class="memitem">
258
<div class="memproto">
259
<table class="memname">
261
<td class="memname"><a class="el" href="classOfxAggregate.html">OfxAggregate</a> OfxRequest::RequestMessage </td>
263
<td class="paramtype">const string & </td>
264
<td class="paramname"> <em>msgtype</em>, </td>
267
<td class="paramkey"></td>
269
<td class="paramtype">const string & </td>
270
<td class="paramname"> <em>trntype</em>, </td>
273
<td class="paramkey"></td>
275
<td class="paramtype">const <a class="el" href="classOfxAggregate.html">OfxAggregate</a> & </td>
276
<td class="paramname"> <em>aggregate</em></td><td> </td>
281
<td></td><td></td><td width="100%"> const</td>
288
Creates a message aggregate<p>
289
<dl compact><dt><b>Parameters:</b></dt><dd>
290
<table border="0" cellspacing="2" cellpadding="0">
291
<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>
292
<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>
293
<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>
296
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The message aggregate created </dd></dl>
300
<a class="anchor" name="b653f985a56f4cff3e87a82c700f4450"></a><!-- doxytag: member="OfxRequest::SignOnRequest" ref="b653f985a56f4cff3e87a82c700f4450" args="(void) const " -->
301
<div class="memitem">
302
<div class="memproto">
303
<table class="memname">
305
<td class="memname"><a class="el" href="classOfxAggregate.html">OfxAggregate</a> OfxRequest::SignOnRequest </td>
307
<td class="paramtype">void </td>
308
<td class="paramname"> </td>
309
<td> ) </td>
310
<td width="100%"> const</td>
317
Creates a signon request aggregate, <SIGNONMSGSRQV1> & <SONRQ>, sufficient to log this user into this financial institution.<p>
318
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The request aggregate created </dd></dl>
322
<a class="anchor" name="e56ceb8ef12b9431dcd4d63eec60a377"></a><!-- doxytag: member="OfxRequest::RequestMessage" ref="e56ceb8ef12b9431dcd4d63eec60a377" args="(const string &msgtype, const string &trntype, const OfxAggregate &aggregate) const " -->
323
<div class="memitem">
324
<div class="memproto">
325
<table class="memname">
327
<td class="memname"><a class="el" href="classOfxAggregate.html">OfxAggregate</a> OfxRequest::RequestMessage </td>
329
<td class="paramtype">const string & </td>
330
<td class="paramname"> <em>msgtype</em>, </td>
333
<td class="paramkey"></td>
335
<td class="paramtype">const string & </td>
336
<td class="paramname"> <em>trntype</em>, </td>
339
<td class="paramkey"></td>
341
<td class="paramtype">const <a class="el" href="classOfxAggregate.html">OfxAggregate</a> & </td>
342
<td class="paramname"> <em>aggregate</em></td><td> </td>
347
<td></td><td></td><td width="100%"> const</td>
354
Creates a message aggregate<p>
355
<dl compact><dt><b>Parameters:</b></dt><dd>
356
<table border="0" cellspacing="2" cellpadding="0">
357
<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>
358
<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>
359
<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>
362
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The message aggregate created </dd></dl>
306
366
<hr>The documentation for this class was generated from the following files:<ul>
307
<li><a class="el" href="ofx__request_8hh-source.html">ofx_request.hh</a><li><a class="el" href="fx-0_88_82_2lib_2ofx__request_8hh-source.html">fx-0.8.2/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_88_82_2lib_2ofx__request_8cpp-source.html">fx-0.8.2/lib/ofx_request.cpp</a></ul>
308
<hr size="1"><address style="align: right;"><small>Generated on Fri Aug 25 13:25:23 2006 for LibOFX by
367
<li><a class="el" href="ofx__request_8hh-source.html">ofx_request.hh</a><li><a class="el" href="fx-0_88_82_2lib_2ofx__request_8hh-source.html">fx-0.8.2/lib/ofx_request.hh</a><li><a class="el" href="fx-0_89_80_2lib_2ofx__request_8hh-source.html">fx-0.9.0/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_88_82_2lib_2ofx__request_8cpp-source.html">fx-0.8.2/lib/ofx_request.cpp</a><li><a class="el" href="fx-0_89_80_2lib_2ofx__request_8cpp-source.html">fx-0.9.0/lib/ofx_request.cpp</a></ul>
368
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Nov 19 20:28:00 2007 for LibOFX by
309
369
<a href="http://www.doxygen.org/index.html">
310
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
370
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>