LibOFX
OfxStatementRequest Class Reference

A statement request. More...

Inheritance diagram for OfxStatementRequest:
OfxRequest OfxRequest OfxAggregate OfxAggregate OfxAggregate OfxAggregate

Public Member Functions

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

Protected Member Functions

OfxAggregate BankStatementRequest (void) const
 
OfxAggregate CreditCardStatementRequest (void) const
 
OfxAggregate InvestmentStatementRequest (void) const
 
OfxAggregate BankStatementRequest (void) const
 
OfxAggregate CreditCardStatementRequest (void) const
 
OfxAggregate InvestmentStatementRequest (void) const
 

Additional Inherited Members

- Protected Attributes inherited from OfxRequest
OfxFiLogin m_login
 

Detailed Description

A statement request.

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.

Definition at line 37 of file build/libofx-0.10.0/lib/ofx_request_statement.hh.

Constructor & Destructor Documentation

◆ OfxStatementRequest() [1/2]

OfxStatementRequest::OfxStatementRequest ( const OfxFiLogin fi,
const OfxAccountData account,
time_t  from 
)

Creates the request aggregate to obtain a statement from this fi for this account, starting on this start date, ending today.

Parameters
fiThe information needed to log on user into one financial institution
accountThe account for which a statement is desired
startThe beginning time of the statement period desired

Definition at line 45 of file build/libofx-0.10.0/lib/ofx_request_statement.cpp.

◆ OfxStatementRequest() [2/2]

OfxStatementRequest::OfxStatementRequest ( const OfxFiLogin fi,
const OfxAccountData account,
time_t  from 
)

Creates the request aggregate to obtain a statement from this fi for this account, starting on this start date, ending today.

Parameters
fiThe information needed to log on user into one financial institution
accountThe account for which a statement is desired
startThe beginning time of the statement period desired

Member Function Documentation

◆ BankStatementRequest() [1/2]

OfxAggregate OfxStatementRequest::BankStatementRequest ( void  ) const
protected

Creates a bank statement request aggregate, <BANKMSGSRQV1>, <STMTTRNRQ> & <STMTRQ> for this account. Should only be used if this account is a BANK account.

Returns
The request aggregate created

Definition at line 60 of file build/libofx-0.10.0/lib/ofx_request_statement.cpp.

Referenced by OfxStatementRequest().

◆ BankStatementRequest() [2/2]

OfxAggregate OfxStatementRequest::BankStatementRequest ( void  ) const
protected

Creates a bank statement request aggregate, <BANKMSGSRQV1>, <STMTTRNRQ> & <STMTRQ> for this account. Should only be used if this account is a BANK account.

Returns
The request aggregate created

◆ CreditCardStatementRequest() [1/2]

OfxAggregate OfxStatementRequest::CreditCardStatementRequest ( void  ) const
protected

Creates a credit card statement request aggregate, <CREDITCARDMSGSRQV1>, <CCSTMTTRNRQ> & <CCSTMTRQ> for this account. Should only be used if this account is a CREDIT CARD account.

Returns
The request aggregate created

◆ CreditCardStatementRequest() [2/2]

OfxAggregate OfxStatementRequest::CreditCardStatementRequest ( void  ) const
protected

Creates a credit card statement request aggregate, <CREDITCARDMSGSRQV1>, <CCSTMTTRNRQ> & <CCSTMTRQ> for this account. Should only be used if this account is a CREDIT CARD account.

Returns
The request aggregate created

Definition at line 87 of file build/libofx-0.10.0/lib/ofx_request_statement.cpp.

Referenced by OfxStatementRequest().

◆ InvestmentStatementRequest() [1/2]

OfxAggregate OfxStatementRequest::InvestmentStatementRequest ( void  ) const
protected

Creates an investment statement request aggregate, <INSTMTMSGSRQV1>, <INVSTMTTRNRQ> & <INVSTMTRQ> for this account. Should only be used if this account is an INVESTMENT account.

Returns
The request aggregate created

Definition at line 111 of file build/libofx-0.10.0/lib/ofx_request_statement.cpp.

Referenced by OfxStatementRequest().

◆ InvestmentStatementRequest() [2/2]

OfxAggregate OfxStatementRequest::InvestmentStatementRequest ( void  ) const
protected

Creates an investment statement request aggregate, <INSTMTMSGSRQV1>, <INVSTMTTRNRQ> & <INVSTMTRQ> for this account. Should only be used if this account is an INVESTMENT account.

Returns
The request aggregate created

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