Interface ISupaRecord

Namespace

Subsembly.Supa

Assembly

Subsembly.Sepa.dll

An abstract name/value container representing a single SUPA data record. A SUPA record is basically just a name/value string dictionary.

public interface ISupaRecord

Methods

GetBool(string)

Gets the named field value from this record as a boolean value. If the field does not exist, then false is returned.

bool GetBool(string sName)

Parameters

sName string

Returns

bool

Exceptions

ArgumentNullException

The parameter sName was null.

GetDate(string)

Attempts to get a date record value. If the requested field does not exist, then the value Date.MinValue is returned.

DateTime GetDate(string sName)

Parameters

sName string

Returns

DateTime

Exceptions

ArgumentNullException

The parameter sName was null.

FormatException

The extracted field data was not a valid date format.

GetDateTime(string)

Attempts to get a date and time record value. If the requested field does not exist, then the value Date.MinValue is returned.

DateTime GetDateTime(string sName)

Parameters

sName string

Returns

DateTime

Exceptions

ArgumentNullException

The parameter sName was null.

FormatException

The extracted field data was not a valid date format.

GetDecimal(string)

Attempts to get a decimal record value. If the requested field does not exist, then the value Dezimal.Zero is returned.

decimal GetDecimal(string sName)

Parameters

sName string

Returns

decimal

Exceptions

ArgumentNullException

The parameter sName was null.

GetNumber(string)

Attempts to get an integer record value. If the requested field does not exist, then the value zero is returned.

int GetNumber(string sName)

Parameters

sName string

Returns

int

GetValue(string)

Gets the named field value from this record as a string. If the field does not exist, then null is returned.

string GetValue(string sName)

Parameters

sName string

Returns

string

Exceptions

ArgumentNullException

The parameter sName was null.

HasValue(string)

Indicates whether the record contains a non-null entry for the given field.

bool HasValue(string sName)

Parameters

sName string

Returns

bool

Exceptions

ArgumentNullException

The parameter sName was null.

SetBool(string, bool)

Sets the named field value from the SUPA formatted boolean value.

void SetBool(string sName, bool fValue)

Parameters

sName string

fValue bool

Exceptions

ArgumentNullException

The parameter sName was null.

SetDate(string, DateTime)

void SetDate(string sName, DateTime tDate)

Parameters

sName string

tDate DateTime

Exceptions

ArgumentNullException

The parameter sName was null.

SetDateTime(string, DateTime)

void SetDateTime(string sName, DateTime tDate)

Parameters

sName string

tDate DateTime

Exceptions

ArgumentNullException

The parameter sName was null.

SetDecimal(string, decimal)

void SetDecimal(string sName, decimal nValue)

Parameters

sName string

nValue decimal

Exceptions

ArgumentNullException

The parameter sName was null.

SetNumber(string, int)

void SetNumber(string sName, int nValue)

Parameters

sName string

nValue int

Exceptions

ArgumentNullException

The parameter sName was null.

SetValue(string, string)

Sets the named field with the string value.

void SetValue(string sName, string sValue)

Parameters

sName string

sValue string

Exceptions

ArgumentNullException

The parameter sName was null.

See Also

SupaRecordJson

SupaRecordCsv