OFXAggregate Module

Properties   Methods   Events   Config Settings   Errors  

The OFXAggregate module supports parsing of XML aggregates that can be retrieved from other modules.

Syntax

InEBank.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 module with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

Aggregate Property (OFXAggregate Module)

The full text of the current aggregate.

Syntax

• Swift
• Objective-C

public var aggregate: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=aggregate,setter=setAggregate:) NSString* aggregate;

- (NSString*)aggregate;
- (void)setAggregate :(NSString*)newAggregate;

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.

Namespaces Property (OFXAggregate Module)

Collection of namespaces in the current namespace stack.

Syntax

• Swift
• Objective-C

public var namespaces: Array<XMLNamespace> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=namespaceCount,setter=setNamespaceCount:) int namespaceCount;

- (int)namespaceCount;
- (void)setNamespaceCount :(int)newNamespaceCount;

- (NSString*)namespacePrefix:(int)namespaceIndex;
- (void)setNamespacePrefix:(int)namespaceIndex :(NSString*)newNamespacePrefix;

- (NSString*)namespaceURI:(int)namespaceIndex;
- (void)setNamespaceURI:(int)namespaceIndex :(NSString*)newNamespaceURI;

 

Default Value

""

Remarks

The current element is specified via the XPath property.

XChildren Property (OFXAggregate Module)

Collection of child elements of the currently selected XML element.

Syntax

• Swift
• Objective-C

public var xChildren: Array<XMLElement> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=XChildCount,setter=setXChildCount:) int XChildCount;

- (int)XChildCount;
- (void)setXChildCount :(int)newXChildCount;

- (NSString*)XChildName:(int)xChildIndex;

- (NSString*)XChildNamespace:(int)xChildIndex;

- (NSString*)XChildPrefix:(int)xChildIndex;

- (NSString*)XChildXText:(int)xChildIndex;

 

Default Value

""

Remarks

The current element is specified via the XPath property.

XElement Property (OFXAggregate Module)

The name of the current element.

Syntax

• Swift
• Objective-C

public var xElement: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=XElement,setter=setXElement:) NSString* XElement;

- (NSString*)XElement;
- (void)setXElement :(NSString*)newXElement;

Default Value

""

Remarks

The current element is specified via the XPath property.

XNamespace Property (OFXAggregate Module)

The namespace of the current element.

Syntax

• Swift
• Objective-C

public var xNamespace: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=XNamespace,setter=setXNamespace:) NSString* XNamespace;

- (NSString*)XNamespace;
- (void)setXNamespace :(NSString*)newXNamespace;

Default Value

""

Remarks

The current element is specified via the XPath property.

XParent Property (OFXAggregate Module)

The parent of the current element.

Syntax

• Swift
• Objective-C

public var xParent: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=XParent) NSString* XParent;

- (NSString*)XParent;

Default Value

""

Remarks

The current element is specified via the XPath property.

This property is read-only.

XPath Property (OFXAggregate Module)

Provides a way to point to a specific element in the document.

Syntax

• Swift
• Objective-C

public var xPath: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=XPath,setter=setXPath:) NSString* XPath;

- (NSString*)XPath;
- (void)setXPath :(NSString*)newXPath;

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:

When XPath is set to a valid path, XElement points to the name of the element, with XParent, XNamespace, XPrefix, XChildrenName, XChildrenNamespace, XChildrenPrefix, XChildrenXText, and XText providing other properties of the element. The attributes of the current element are provided in the XAttributesName, XAttributesNamespace, XAttributesPrefix, and XAttributesValue properties.

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

Example (Setting XPath):

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setXPath(xPath: String) throws

XPrefix Property (OFXAggregate Module)

The prefix of the current element.

Syntax

• Swift
• Objective-C

public var xPrefix: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=XPrefix,setter=setXPrefix:) NSString* XPrefix;

- (NSString*)XPrefix;
- (void)setXPrefix :(NSString*)newXPrefix;

Default Value

""

Remarks

The current element is specified via the XPath property.

XText Property (OFXAggregate Module)

The text of the current element.

Syntax

• Swift
• Objective-C

public var xText: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=XText,setter=setXText:) NSString* XText;

- (NSString*)XText;
- (void)setXText :(NSString*)newXText;

Default Value

""

Remarks

The current element is specified via the XPath property.

Config Method (OFXAggregate Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)configurationString;

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.

HasXPath Method (OFXAggregate Module)

Checks whether a certain XPath exists inside the aggregate.

Syntax

• Swift
• Objective-C

public func hasXPath(xPath: String) throws -> Bool

- (BOOL)hasXPath:(NSString*)XPath;

Remarks

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

Error Event (OFXAggregate Module)

Information about errors during data delivery.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

Remarks

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

ErrorCode contains an error code and Description 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

An element contained within the XML document.

Remarks

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

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

Fields

Constructors

public init()

XMLNamespace Type

An XML namespace from the current namespace stack.

Remarks

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

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

Fields

Constructors

public init()

public init(name: , prefix: )

Config Settings (OFXAggregate Module)

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

Trappable Errors (OFXAggregate Module)

XML Errors

	101   Invalid attribute index.
	102   No attributes available.
	103   Invalid namespace index.
	104   No namespaces available.
	105   Invalid element index.
	106   No elements available.
	107   Attribute does not exist.
	201   Unbalanced element tag.
	202   Unknown element prefix (can't find namespace).
	203   Unknown attribute prefix (can't find namespace).
	204   Invalid XML markup.
	205   Invalid end state for parser.
	206   Document contains unbalanced elements.
	207   Invalid XPath.
	208   No such child.
	209   Top element does not match start of path.
	210   DOM tree unavailable (set BuildDOM to true and reparse).
	302   Can't open file.
	401   Invalid XML would be generated.
	402   An invalid XML name has been specified.