LibOFX
OfxRequest Class Reference

A generic request. More...

Inheritance diagram for OfxRequest:
OfxAggregate OfxAccountInfoRequest OfxPaymentRequest OfxStatementRequest

Public Member Functions

 OfxRequest (const OfxFiLogin &fi)
 
OfxAggregate SignOnRequest (void) const
 
OfxAggregate RequestMessage (const std::string &msgtype, const std::string &trntype, const OfxAggregate &aggregate) const
 
- Public Member Functions inherited from OfxAggregate
 OfxAggregate (const std::string &tag)
 
void Add (const std::string &tag, const std::string &data)
 
void AddXml (const std::string &tag, const std::string &data)
 
void Add (const OfxAggregate &sub)
 
std::string Output (void) const
 

Protected Attributes

OfxFiLogin m_login
 

Detailed Description

A generic request.

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.

Definition at line 34 of file ofx_request.hh.

Constructor & Destructor Documentation

◆ OfxRequest()

OfxRequest::OfxRequest ( const OfxFiLogin fi)
inline

Creates the generic request aggregate.

Parameters
fiThe information needed to log on user into one financial institution

Definition at line 50 of file ofx_request.hh.

Member Function Documentation

◆ RequestMessage()

OfxAggregate OfxRequest::RequestMessage ( const std::string &  msgtype,
const std::string &  trntype,
const OfxAggregate aggregate 
) const

Creates a message aggregate

Parameters
msgtypeThe type of message. This will be prepended to "MSGSRQV1" to become the tagname of the overall aggregate
trntypeThe type of transactions being requested. This will be prepended to "TRNRQ" to become the tagname of the subordinate aggregate.
aggregateThe actual contents of the message, which will be a sub aggregate of the xxxTRNRQ aggregate.
Returns
The message aggregate created

Definition at line 113 of file ofx_request.cpp.

Referenced by OfxPaymentRequest::OfxPaymentRequest().

◆ SignOnRequest()

OfxAggregate OfxRequest::SignOnRequest ( void  ) const

Creates a signon request aggregate, <SIGNONMSGSRQV1> & <SONRQ>, sufficient to log this user into this financial institution.

Returns
The request aggregate created

Definition at line 82 of file ofx_request.cpp.

Referenced by OfxAccountInfoRequest::OfxAccountInfoRequest(), OfxPaymentRequest::OfxPaymentRequest(), and OfxStatementRequest::OfxStatementRequest().


The documentation for this class was generated from the following files: