OFXAggregate Class

Properties   Methods   Events   Config Settings   Errors  

The OFXAggregate class supports parsing of XML aggregates that can be retrieved from other classes.

Syntax

OFXAggregate

Remarks

The OFXAggregate class supports simple XML aggregate traversal functionality. Simply set the Aggregate property to the value received from any aggregate property of any class in the package (e.g. the TxAggregate property from BankStatement or CCStatement). You can then use XPath to walk the Document Object Model (DOM) tree.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

Aggregate Property (OFXAggregate Class)

The full text of the current aggregate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAggregate();
int SetAggregate(const char* lpszAggregate);

Unicode (Windows)
LPWSTR GetAggregate();
INT SetAggregate(LPCWSTR lpszAggregate);

char* inebank_ofxaggregate_getaggregate(void* lpObj);
int inebank_ofxaggregate_setaggregate(void* lpObj, const char* lpszAggregate);

QString GetAggregate();
int SetAggregate(QString qsAggregate);

Default Value

""

Remarks

Aggregate contains the full text of the XML aggregate currently being represented by the class's DOM. You may set this to a value obtained from any aggregate property of any other control (such as SignOnInfoAggregate from FIProfile). Once set, you can use XPath to walk the DOM tree. XElement and XText will retrieve the current element's name and contents, and XChildren can be used to get the number of children.

Data Type

String

Namespaces Property (OFXAggregate Class)

This property includes a collection of namespaces in the current namespace stack.

Syntax

• C++
• C
• Qt

InEBankList<InEBankXMLNamespace>* GetNamespaces();
int SetNamespaces(InEBankList<InEBankXMLNamespace>* val);

int inebank_ofxaggregate_getnamespacecount(void* lpObj);
int inebank_ofxaggregate_setnamespacecount(void* lpObj, int iNamespaceCount);

char* inebank_ofxaggregate_getnamespaceprefix(void* lpObj, int namespaceindex);
int inebank_ofxaggregate_setnamespaceprefix(void* lpObj, int namespaceindex, const char* lpszNamespacePrefix);

char* inebank_ofxaggregate_getnamespaceuri(void* lpObj, int namespaceindex);
int inebank_ofxaggregate_setnamespaceuri(void* lpObj, int namespaceindex, const char* lpszNamespaceURI);

int GetNamespaceCount();
int SetNamespaceCount(int iNamespaceCount);

QString GetNamespacePrefix(int iNamespaceIndex);
int SetNamespacePrefix(int iNamespaceIndex, QString qsNamespacePrefix);

QString GetNamespaceURI(int iNamespaceIndex);
int SetNamespaceURI(int iNamespaceIndex, QString qsNamespaceURI);

Remarks

This property contains a collection of XML namespaces, which are standards for providing uniquely named elements and attributes in an XML instance.

This property is not available at design time.

Data Type

InEBankXMLNamespace

XChildren Property (OFXAggregate Class)

This property includes a collection of child elements of the currently selected XML element.

Syntax

• C++
• C
• Qt

InEBankList<InEBankXMLElement>* GetXChildren();
int SetXChildren(InEBankList<InEBankXMLElement>* val);

int inebank_ofxaggregate_getxchildcount(void* lpObj);
int inebank_ofxaggregate_setxchildcount(void* lpObj, int iXChildCount);

char* inebank_ofxaggregate_getxchildname(void* lpObj, int xchildindex);

char* inebank_ofxaggregate_getxchildnamespace(void* lpObj, int xchildindex);

char* inebank_ofxaggregate_getxchildprefix(void* lpObj, int xchildindex);

char* inebank_ofxaggregate_getxchildxtext(void* lpObj, int xchildindex);

int GetXChildCount();
int SetXChildCount(int iXChildCount);

QString GetXChildName(int iXChildIndex);

QString GetXChildNamespace(int iXChildIndex);

QString GetXChildPrefix(int iXChildIndex);

QString GetXChildXText(int iXChildIndex);

Remarks

This property contains a collection of child elements of the currently selected XML element. The elements are provided in the collection in the same order they are found in the XML document.

This property is not available at design time.

Data Type

InEBankXMLElement

XElement Property (OFXAggregate Class)

This property includes the name of the current element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXElement();
int SetXElement(const char* lpszXElement);

Unicode (Windows)
LPWSTR GetXElement();
INT SetXElement(LPCWSTR lpszXElement);

char* inebank_ofxaggregate_getxelement(void* lpObj);
int inebank_ofxaggregate_setxelement(void* lpObj, const char* lpszXElement);

QString GetXElement();
int SetXElement(QString qsXElement);

Default Value

""

Remarks

The current element is specified through the XPath property.

Data Type

String

XNamespace Property (OFXAggregate Class)

This property includes the namespace of the current element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXNamespace();
int SetXNamespace(const char* lpszXNamespace);

Unicode (Windows)
LPWSTR GetXNamespace();
INT SetXNamespace(LPCWSTR lpszXNamespace);

char* inebank_ofxaggregate_getxnamespace(void* lpObj);
int inebank_ofxaggregate_setxnamespace(void* lpObj, const char* lpszXNamespace);

QString GetXNamespace();
int SetXNamespace(QString qsXNamespace);

Default Value

""

Remarks

The current element is specified through the XPath property.

Data Type

String

XParent Property (OFXAggregate Class)

This property includes the parent of the current element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXParent();

Unicode (Windows)
LPWSTR GetXParent();

char* inebank_ofxaggregate_getxparent(void* lpObj);

QString GetXParent();

Default Value

""

Remarks

The current element is specified through the XPath property.

This property is read-only.

Data Type

String

XPath Property (OFXAggregate Class)

This property provides a way to point to a specific element in the document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXPath();
int SetXPath(const char* lpszXPath);

Unicode (Windows)
LPWSTR GetXPath();
INT SetXPath(LPCWSTR lpszXPath);

char* inebank_ofxaggregate_getxpath(void* lpObj);
int inebank_ofxaggregate_setxpath(void* lpObj, const char* lpszXPath);

QString GetXPath();
int SetXPath(QString qsXPath);

Default Value

""

Remarks

XPath implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML documents.

The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location.

The following are possible values for an element accessor:

BuildDOM must be set to True before parsing the document for the XPath functionality to be available.

Example. Setting XPath:

Data Type

String

XPrefix Property (OFXAggregate Class)

This property includes the prefix of the current element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXPrefix();
int SetXPrefix(const char* lpszXPrefix);

Unicode (Windows)
LPWSTR GetXPrefix();
INT SetXPrefix(LPCWSTR lpszXPrefix);

char* inebank_ofxaggregate_getxprefix(void* lpObj);
int inebank_ofxaggregate_setxprefix(void* lpObj, const char* lpszXPrefix);

QString GetXPrefix();
int SetXPrefix(QString qsXPrefix);

Default Value

""

Remarks

The current element is specified through the XPath property.

Data Type

String

XText Property (OFXAggregate Class)

This property includes the text of the current element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXText();
int SetXText(const char* lpszXText);

Unicode (Windows)
LPWSTR GetXText();
INT SetXText(LPCWSTR lpszXText);

char* inebank_ofxaggregate_getxtext(void* lpObj);
int inebank_ofxaggregate_setxtext(void* lpObj, const char* lpszXText);

QString GetXText();
int SetXText(QString qsXText);

Default Value

""

Remarks

The current element is specified through the XPath property.

Data Type

String

Config Method (OFXAggregate Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* inebank_ofxaggregate_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

HasXPath Method (OFXAggregate Class)

Checks whether a certain XPath exists inside the aggregate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
bool HasXPath(const char* lpszXPath);

Unicode (Windows)
bool HasXPath(LPCWSTR lpszXPath);

bool inebank_ofxaggregate_hasxpath(void* lpObj, const char* lpszXPath);

bool HasXPath(const QString& qsXPath);

Remarks

Used when there is no assurance that a certain XPath exists inside an aggregate.

Error Handling (C++)

This method returns a Boolean value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Error Event (OFXAggregate Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(OFXAggregateErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} OFXAggregateErrorEventParams;


Unicode (Windows)
virtual INT FireError(OFXAggregateErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} OFXAggregateErrorEventParams;

#define EID_OFXAGGREGATE_ERROR 1

virtual INT INEBANK_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class OFXAggregateErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(OFXAggregateErrorEventParams *e);

// Or, subclass OFXAggregate and override this emitter function.
virtual int FireError(OFXAggregateErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

XMLElement Type

This type describes an element contained within the XML document.

Syntax

InEBankXMLElement (declared in inebank.h)

Remarks

This type describes an XML element. The fields for this type describe the element Name, Prefix, and Namespace of the given element.

The elements are inserted into the array in the same order they are found in the document.

• Name
• Namespace
• Prefix
• XText

Fields

Constructors

XMLElement()

XMLNamespace Type

This type describes an XML namespace from the current namespace stack.

Syntax

InEBankXMLNamespace (declared in inebank.h)

Remarks

This type describes an XML namespace from the current stack. It includes fields to denote the Prefix and the URI of the namespace being defined.

The default namespace exists at index 0. The Prefix field at index 0 is xmlns, and the Name field contains the default namespace.

• Prefix
• URI

Fields

Constructors

XMLNamespace()

XMLNamespace(const char* lpszURI, const char* lpszPrefix)

InEBankList Type

Syntax

InEBankList<T> (declared in inebank.h)

Remarks

InEBankList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the OFXAggregate class.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

T* Set(int index, T* value) {}

Config Settings (OFXAggregate Class)

XML Config Settings

<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
...

Base Config Settings

Trappable Errors (OFXAggregate Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

XML Errors