Class EbicsElement
Inheritance
Inherited Members
Namespace: Subsembly.EBICS
Assembly: Subsembly.EBICS.Core.dll
Syntax
public abstract class EbicsElement
Remarks
Base class for all classes that directly represent EBICS XML elements. This base class defines common generic methods for converting the data to and from various XML formats.
Methods
BuildXml(XmlDocument, EbicsVersion)
Builds a new XmlElement instance with the data of this EbicsElement.
Declaration
public abstract XmlElement BuildXml(XmlDocument xmlDocument, EbicsVersion nVersion)
Parameters
Type | Name | Description |
---|---|---|
System.Xml.XmlDocument | xmlDocument | The XmlDocument that shall own the new XmlElement. All nodes of the XML that is
built by this method must be created from this XML document. This parameter must
not be |
EbicsVersion | nVersion | The EBICS version that the built XML element shall adhere to. This version implicitly also selects the namespace to be used for the EBICS XML tags in the output. |
Returns
Type | Description |
---|---|
System.Xml.XmlElement |
Remarks
This method must be implemented by a derived class.
BuildXmlDocument(EbicsVersion)
Builds a new XML document that contains this XML element as the document element.
Declaration
public XmlDocument BuildXmlDocument(EbicsVersion nVersion)
Parameters
Type | Name | Description |
---|---|---|
EbicsVersion | nVersion |
Returns
Type | Description |
---|---|
System.Xml.XmlDocument |
FromBuffer(EbicsDataBuffer, EbicsVersion)
Loads this EbicsElement from a binary buffer.
Declaration
public void FromBuffer(EbicsDataBuffer aBuffer, EbicsVersion nVersion)
Parameters
Type | Name | Description |
---|---|---|
EbicsDataBuffer | aBuffer | |
EbicsVersion | nVersion |
Load(Stream, EbicsVersion)
Loads this EbicsElement from a XML document stream.
Declaration
public void Load(Stream aStream, EbicsVersion nVersion)
Parameters
Type | Name | Description |
---|---|---|
System.IO.Stream | aStream | |
EbicsVersion | nVersion |
Load(String, EbicsVersion)
Loads this EbicsElement from a XML document file.
Declaration
public void Load(string sFileName, EbicsVersion nVersion)
Parameters
Type | Name | Description |
---|---|---|
System.String | sFileName | |
EbicsVersion | nVersion |
ParseXml(XmlElement, EbicsVersion)
Extract data for this EbicsElement from the given XmlElement.
Declaration
public abstract void ParseXml(XmlElement xmlElement, EbicsVersion nVersion)
Parameters
Type | Name | Description |
---|---|---|
System.Xml.XmlElement | xmlElement | The XML element to be parsed. |
EbicsVersion | nVersion | The EBICS version that the given XML element adheres to. This version implicitly selects the namespace of the expected EBICS XML tags. |
Remarks
This method must be implemented by a derived class.
Save(Stream, EbicsVersion)
Saves this EbicsElement in a XML document stream.
Declaration
public void Save(Stream aStream, EbicsVersion nVersion)
Parameters
Type | Name | Description |
---|---|---|
System.IO.Stream | aStream | |
EbicsVersion | nVersion |
Save(String, EbicsVersion)
Saves this EbicsElement in a XML document file.
Declaration
public void Save(string sFileName, EbicsVersion nVersion)
Parameters
Type | Name | Description |
---|---|---|
System.String | sFileName | |
EbicsVersion | nVersion |
ToBuffer(EbicsVersion)
Saves this EbicsElement in a binary buffer.
Declaration
public EbicsDataBuffer ToBuffer(EbicsVersion nVersion)
Parameters
Type | Name | Description |
---|---|---|
EbicsVersion | nVersion |
Returns
Type | Description |
---|---|
EbicsDataBuffer |