Class FinStoDetails
Generic class that holds the execution details of a standing order.
Inherited Members
Namespace: Subsembly.FinTS
Assembly: Subsembly.FinTS.Core.dll
Syntax
public class FinStoDetails : FinPersistConstructors
FinStoDetails()
Declaration
public FinStoDetails()Properties
ExecDay
The day of the week or the day of the month when the standing order is executed.
Declaration
public int ExecDay { get; set; }Property Value
| Type | Description |
|---|---|
| int | The initial value of this property is zero. If the TimeUnit is Month, then the values 1 through 31, 97 (ultimo-2), 98 (ultimo-1), and 99 (ultimo) are permitted. If the TimeUnit is Week, then the values 0 (daily), 1 (monday) through 7 (sunday) are permitted. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentOutOfRangeException | An attempt was made to set a value less than zero or greater than 99. |
ExecTime
For standing instant payment orders, this property may specify a particular time when the standing order shall be executed.
Declaration
public SwiftTime ExecTime { get; set; }Property Value
| Type | Description |
|---|---|
| SwiftTime |
ExecuteFirstTimeOn
Date when the standing order is/was executed for the evry first time.
Declaration
public SwiftDate ExecuteFirstTimeOn { get; set; }Property Value
| Type | Description |
|---|---|
| SwiftDate | This may be a virtual date such as the February, 30th. The initial value of this property contains a null date. |
LastScheduledDate
Optional date when the standing order shall be executed for the very last time.
Declaration
public SwiftDate LastScheduledDate { get; set; }Property Value
| Type | Description |
|---|---|
| SwiftDate | This may be a virtual date such as the February, 30th. The initial value of this property contains a null date. |
PeriodLen
Length of the standing order period in months or weeks.
Declaration
public int PeriodLen { get; set; }Property Value
| Type | Description |
|---|---|
| int | Whether the period is given in months or weeks is defined by the property TimeUnit. The initial value of this property is zero, meaning that the period is not defined. If the TimeUnit is Month, then values from 1 through 12 are permitted. If the TimeUnit is Week, then values from 1 through 52 are permitted. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentOutOfRangeException | An attempt was made to set a value less than zero or greater than 99. |
TimeUnit
The unit of the standing order period given in property PeriodLen.
Declaration
public FinStoTimeUnit TimeUnit { get; set; }Property Value
| Type | Description |
|---|---|
| FinStoTimeUnit | The initial value of this property is Null. |
Methods
ReadXml(XmlReader)
Declaration
public override void ReadXml(XmlReader aXmlReader)Parameters
| Type | Name | Description |
|---|---|---|
| XmlReader | aXmlReader |
Overrides
Validate()
Validates all properties of this FinStoDetails.
Declaration
public bool Validate()Returns
| Type | Description |
|---|---|
| bool | If all properties have been correctly initialised and are consistent with each
other, then |
WriteXml(XmlWriter)
Declaration
public override void WriteXml(XmlWriter aXmlWriter)Parameters
| Type | Name | Description |
|---|---|---|
| XmlWriter | aXmlWriter |