Interface ISupaRecord

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

Namespace: Subsembly.Supa
Assembly: Subsembly.Sepa.dll
Syntax
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.

Declaration
bool GetBool(string sName)
Parameters
Type Name Description
string sName
Returns
Type Description
bool
Exceptions
Type Condition
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.

Declaration
DateTime GetDate(string sName)
Parameters
Type Name Description
string sName
Returns
Type Description
DateTime
Exceptions
Type Condition
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.

Declaration
DateTime GetDateTime(string sName)
Parameters
Type Name Description
string sName
Returns
Type Description
DateTime
Exceptions
Type Condition
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.

Declaration
decimal GetDecimal(string sName)
Parameters
Type Name Description
string sName
Returns
Type Description
decimal
Exceptions
Type Condition
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.

Declaration
int GetNumber(string sName)
Parameters
Type Name Description
string sName
Returns
Type Description
int

GetValue(string)

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

Declaration
string GetValue(string sName)
Parameters
Type Name Description
string sName
Returns
Type Description
string
Exceptions
Type Condition
ArgumentNullException

The parameter sName was null.

HasValue(string)

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

Declaration
bool HasValue(string sName)
Parameters
Type Name Description
string sName
Returns
Type Description
bool
Exceptions
Type Condition
ArgumentNullException

The parameter sName was null.

SetBool(string, bool)

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

Declaration
void SetBool(string sName, bool fValue)
Parameters
Type Name Description
string sName
bool fValue
Exceptions
Type Condition
ArgumentNullException

The parameter sName was null.

SetDate(string, DateTime)

Declaration
void SetDate(string sName, DateTime tDate)
Parameters
Type Name Description
string sName
DateTime tDate
Exceptions
Type Condition
ArgumentNullException

The parameter sName was null.

SetDateTime(string, DateTime)

Declaration
void SetDateTime(string sName, DateTime tDate)
Parameters
Type Name Description
string sName
DateTime tDate
Exceptions
Type Condition
ArgumentNullException

The parameter sName was null.

SetDecimal(string, decimal)

Declaration
void SetDecimal(string sName, decimal nValue)
Parameters
Type Name Description
string sName
decimal nValue
Exceptions
Type Condition
ArgumentNullException

The parameter sName was null.

SetNumber(string, int)

Declaration
void SetNumber(string sName, int nValue)
Parameters
Type Name Description
string sName
int nValue
Exceptions
Type Condition
ArgumentNullException

The parameter sName was null.

SetValue(string, string)

Sets the named field with the string value.

Declaration
void SetValue(string sName, string sValue)
Parameters
Type Name Description
string sName
string sValue
Exceptions
Type Condition
ArgumentNullException

The parameter sName was null.

See Also