Show / Hide Table of Contents

Class AddressRow

Contact and Person addresses
Row Object for table 'address'. Row objects correspond directly to database tables, and one instance of a row object represents one row in the corresponding table in the database.

Inheritance
Object
SqlCommand
PrivateSave
TableRowBase
AddressRow
Implements
INestedPersist
ISoDataLookup
ISentryIgnorable
ISoItem
Inherited Members
TableRowBase._saveOwner
TableRowBase._sentries
TableRowBase._onValueChange
TableRowBase._relatedNestedPersistMembers
TableRowBase._sqlType
TableRowBase.InternalSetValue(Int32, Object)
TableRowBase.InternalSetValue(SoField, Object)
TableRowBase.GetFieldValue(FieldInfo)
TableRowBase.GetKnownFields()
TableRowBase.ISoDataLookup.GetPersistedFieldValue(FieldInfo)
TableRowBase.ISoDataLookup.IsPersistedFieldValueKnown(FieldInfo)
TableRowBase.IsGhostField(FieldInfo)
TableRowBase.RowLoad()
TableRowBase.RowLoad(ITableRowLoadHandler)
TableRowBase.OnLoaded(IdxBase)
TableRowBase.Load(IdxBase, SoDataReader)
TableRowBase.Load(SoDataReader, TableInfo)
TableRowBase.SetDefaults()
TableRowBase.SetDefaults(DashboardTileDefinitionRow, String)
TableRowBase.SetSaveOwner(INestedPersist)
TableRowBase.Save()
TableRowBase.Delete()
TableRowBase.Validate()
TableRowBase.SetDirty(Int32, Object, Object)
TableRowBase.INestedPersist.OnPreIdUpdate()
TableRowBase.INestedPersist.OnPrimaryKeyRequest(PKContainer)
TableRowBase.INestedPersist.OnPrimaryKeyUpdate(PKContainer)
TableRowBase.INestedPersist.OnIdUpdate()
TableRowBase.INestedPersist.OnSave(BatchSave)
TableRowBase.INestedPersist.OnSaved(Boolean)
TableRowBase.OnPreIdUpdate()
TableRowBase.OnPrimaryKeyRequest(PKContainer)
TableRowBase.OnPrimaryKeyUpdate(PKContainer)
TableRowBase.OnIdUpdate()
TableRowBase.BeginIgnoreSentryCheck()
TableRowBase.EndIgnoreSentryCheck()
TableRowBase.GetRelatedNestedPersist()
TableRowBase.Item[Int32]
TableRowBase.Item[SoField]
TableRowBase.Sentries
TableRowBase.ForeignKeyHelper
TableRowBase.IsDeleted
TableRowBase.IsSaving
TableRowBase.SqlType
TableRowBase.IsSentryIgnored
TableRowBase.IsMarkedForDelete
TableRowBase.OnValueChanged
TableRowBase.OnElementSaved
TableRowBase.OnElementIdUpdate
PrivateSave.GetTableInfos()
PrivateSave.CloneToBasicUpdatingQuery()
PrivateSave.OnUpdateField
SqlCommand.Origin
SqlCommand.AddIgnoreAutoSentryTableInfo(TableInfo)
SqlCommand.AddIgnoreAutoSentryTableInfo(IEnumerable<TableInfo>)
SqlCommand.RemoveIgnoreAutoSentryTableInfo(TableInfo)
SqlCommand.ClearIgnoreAutoSentryTableInfos()
SqlCommand.IsAutoSentryIgnoredOnTableInfo(TableInfo)
SqlCommand.GetPrivateSaves()
SqlCommand.GetInserts()
SqlCommand.GetUpdates()
SqlCommand.GetDeletes()
SqlCommand.GetSelect()
SqlCommand.AutoSentryIgnoredTables
Object.Equals(Object)
Object.Equals(Object, Object)
Object.ReferenceEquals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class AddressRow : TableRowBase, INestedPersist, ISoDataLookup, ISentryIgnorable, ISoItem
Remarks

Row objects can be created in several ways.

  • Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database.
  • You can create a (nested) AddressRow AddressRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(AddressRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
  • For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
  • Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the AddressTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, AddressTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Non-unique indexes are handled through the AddressRows collection, which has nested classes and GetFromIdx methods for each non-unique index. Similarly, there is a GetFromReader(SoDataReader, AddressTableInfo) method to retrieve the results of queries that return more than one row.

Unique indexes on table Address are:

Index fieldsNested index class name

Constructors

AddressRow(AddressRow.AddressRowIdxBase)

Constructor for the class taking an index as argument. Contact and Person addresses

Declaration
protected AddressRow(AddressRow.AddressRowIdxBase idx)
Parameters
Type Name Description
AddressRow.AddressRowIdxBase idx

The index representing a SELECT command to the database.

Fields

_currentAddress1

Current value, see property Address1.

Declaration
protected string _currentAddress1
Field Value
Type Description
String

_currentAddress2

Current value, see property Address2.

Declaration
protected string _currentAddress2
Field Value
Type Description
String

_currentAddress3

Current value, see property Address3.

Declaration
protected string _currentAddress3
Field Value
Type Description
String

_currentAddressId

Current value, see property AddressId.

Declaration
protected int _currentAddressId
Field Value
Type Description
Int32

_currentAtypeIdx

Current value, see property AtypeIdx.

Declaration
protected AddressType _currentAtypeIdx
Field Value
Type Description
AddressType

_currentCity

Current value, see property City.

Declaration
protected string _currentCity
Field Value
Type Description
String

_currentCounty

Current value, see property County.

Declaration
protected string _currentCounty
Field Value
Type Description
String

_currentOwnerId

Current value, see property OwnerId.

Declaration
protected int _currentOwnerId
Field Value
Type Description
Int32

_currentRegistered

Current value, see property Registered.

Declaration
protected DateTime _currentRegistered
Field Value
Type Description
DateTime

_currentRegisteredAssociateId

Current value, see property RegisteredAssociateId.

Declaration
protected int _currentRegisteredAssociateId
Field Value
Type Description
Int32

_currentState

Current value, see property State.

Declaration
protected string _currentState
Field Value
Type Description
String

_currentUpdated

Current value, see property Updated.

Declaration
protected DateTime _currentUpdated
Field Value
Type Description
DateTime

_currentUpdatedAssociateId

Current value, see property UpdatedAssociateId.

Declaration
protected int _currentUpdatedAssociateId
Field Value
Type Description
Int32

_currentUpdatedCount

Current value, see property UpdatedCount.

Declaration
protected short _currentUpdatedCount
Field Value
Type Description
Int16

_currentValidFrom

Current value, see property ValidFrom.

Declaration
protected DateTime _currentValidFrom
Field Value
Type Description
DateTime

_currentValidTo

Current value, see property ValidTo.

Declaration
protected DateTime _currentValidTo
Field Value
Type Description
DateTime

_currentWgs84Latitude

Current value, see property Wgs84Latitude.

Declaration
protected double _currentWgs84Latitude
Field Value
Type Description
Double

_currentWgs84Longitude

Current value, see property Wgs84Longitude.

Declaration
protected double _currentWgs84Longitude
Field Value
Type Description
Double

_currentZipcode

Current value, see property Zipcode.

Declaration
protected string _currentZipcode
Field Value
Type Description
String

_persistedAddress1

Persisted value, see property Address1.

Declaration
protected string _persistedAddress1
Field Value
Type Description
String

_persistedAddress2

Persisted value, see property Address2.

Declaration
protected string _persistedAddress2
Field Value
Type Description
String

_persistedAddress3

Persisted value, see property Address3.

Declaration
protected string _persistedAddress3
Field Value
Type Description
String

_persistedAddressId

Persisted value, see property AddressId.

Declaration
protected int _persistedAddressId
Field Value
Type Description
Int32

_persistedAtypeIdx

Persisted value, see property AtypeIdx.

Declaration
protected AddressType _persistedAtypeIdx
Field Value
Type Description
AddressType

_persistedCity

Persisted value, see property City.

Declaration
protected string _persistedCity
Field Value
Type Description
String

_persistedCounty

Persisted value, see property County.

Declaration
protected string _persistedCounty
Field Value
Type Description
String

_persistedOwnerId

Persisted value, see property OwnerId.

Declaration
protected int _persistedOwnerId
Field Value
Type Description
Int32

_persistedRegistered

Persisted value, see property Registered.

Declaration
protected DateTime _persistedRegistered
Field Value
Type Description
DateTime

_persistedRegisteredAssociateId

Persisted value, see property RegisteredAssociateId.

Declaration
protected int _persistedRegisteredAssociateId
Field Value
Type Description
Int32

_persistedState

Persisted value, see property State.

Declaration
protected string _persistedState
Field Value
Type Description
String

_persistedUpdated

Persisted value, see property Updated.

Declaration
protected DateTime _persistedUpdated
Field Value
Type Description
DateTime

_persistedUpdatedAssociateId

Persisted value, see property UpdatedAssociateId.

Declaration
protected int _persistedUpdatedAssociateId
Field Value
Type Description
Int32

_persistedUpdatedCount

Persisted value, see property UpdatedCount.

Declaration
protected short _persistedUpdatedCount
Field Value
Type Description
Int16

_persistedValidFrom

Persisted value, see property ValidFrom.

Declaration
protected DateTime _persistedValidFrom
Field Value
Type Description
DateTime

_persistedValidTo

Persisted value, see property ValidTo.

Declaration
protected DateTime _persistedValidTo
Field Value
Type Description
DateTime

_persistedWgs84Latitude

Persisted value, see property Wgs84Latitude.

Declaration
protected double _persistedWgs84Latitude
Field Value
Type Description
Double

_persistedWgs84Longitude

Persisted value, see property Wgs84Longitude.

Declaration
protected double _persistedWgs84Longitude
Field Value
Type Description
Double

_persistedZipcode

Persisted value, see property Zipcode.

Declaration
protected string _persistedZipcode
Field Value
Type Description
String

Properties

Address1

.NET type: string. Address line 1

Declaration
public virtual string Address1 { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[80].

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (string.Empty)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

Address2

.NET type: string. Address line 2

Declaration
public virtual string Address2 { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[80].

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (string.Empty)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

Address3

.NET type: string. Address line 3

Declaration
public virtual string Address3 { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[80].

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (string.Empty)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

AddressId

.NET type: int. Primary key

Declaration
public virtual int AddressId { get; }
Property Value
Type Description
Int32
Remarks

Original type in dictionary: PK.

This field is the primary key and can only be read, never written.

This field is not protected by the Sentry system, and can always be read

AddressTableInfo

Get the AddressTableInfo object associated with the row.

Declaration
public AddressTableInfo AddressTableInfo { get; }
Property Value
Type Description
AddressTableInfo

AtypeIdx

.NET type: AddressType. Bit mask, combines address type (EAddressType) and owner type (EOwnerType)

Declaration
public virtual AddressType AtypeIdx { get; set; }
Property Value
Type Description
AddressType
Remarks

Original type in dictionary: Enum.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((short)0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

City

.NET type: string. City corresponding to zip code

Declaration
public virtual string City { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[80].

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (string.Empty)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

County

.NET type: string. County (not country)

Declaration
public virtual string County { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[30].

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (string.Empty)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

InnerFieldValuePairs

The values of all the fields in the row.
The first field is the primary key.
The index of the value corresponds to the name of the field returned from the Fields property.

Declaration
protected override ArgumentParameterCollection InnerFieldValuePairs { get; }
Property Value
Type Description
ArgumentParameterCollection
Overrides
PrivateSave.InnerFieldValuePairs

InnerPrimaryKey

The primary key needed to decide which specific row to alter with the current sql-command.

Declaration
protected override FieldInfo InnerPrimaryKey { get; }
Property Value
Type Description
FieldInfo
Overrides
PrivateSave.InnerPrimaryKey

InnerPrimaryKeyValue

The actual value the primary key must have.

Declaration
protected override Parameter InnerPrimaryKeyValue { get; }
Property Value
Type Description
Parameter
Overrides
PrivateSave.InnerPrimaryKeyValue

IsDirty

Is the row dirty, e.g. been modified since the last time it was saved to the database.

Declaration
public override bool IsDirty { get; }
Property Value
Type Description
Boolean
Overrides
TableRowBase.IsDirty

IsNew

Is this object new, meaning that it does not exist in the database.

Declaration
public override bool IsNew { get; }
Property Value
Type Description
Boolean
Overrides
TableRowBase.IsNew

Item[String]

Get or set a value based on the name of the field.

Declaration
public override object this[string fieldName] { get; set; }
Parameters
Type Name Description
String fieldName

Name of the field in the database

Property Value
Type Description
Object

Value of the field.

Overrides
TableRowBase.Item[String]
Exceptions
Type Condition
ArgumentException

Thrown if the field is not known.

OwnerId

.NET type: int. Record id of owner: Contact or Person

Declaration
public virtual int OwnerId { get; set; }
Property Value
Type Description
Int32
Remarks

Original type in dictionary: Id.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

Registered

.NET type: DateTime. Registered when in UTC

Declaration
public virtual DateTime Registered { get; set; }
Property Value
Type Description
DateTime
Remarks

Original type in dictionary: UtcDateTime.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (DateTime.MinValue)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

RegisteredAssociateId

.NET type: int. Registered by whom

Declaration
public virtual int RegisteredAssociateId { get; set; }
Property Value
Type Description
Int32
Remarks

Original type in dictionary: FK.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

State

.NET type: string. State

Declaration
public virtual string State { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[6].

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (string.Empty)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

TableInfo

Get the TableInfo for the table.

Declaration
public override TableInfo TableInfo { get; }
Property Value
Type Description
TableInfo

The TableInfo for the table.

Overrides
TableRowBase.TableInfo

Updated

.NET type: DateTime. Last updated when in UTC

Declaration
public virtual DateTime Updated { get; set; }
Property Value
Type Description
DateTime
Remarks

Original type in dictionary: UtcDateTime.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (DateTime.MinValue)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

UpdatedAssociateId

.NET type: int. Last updated by whom

Declaration
public virtual int UpdatedAssociateId { get; set; }
Property Value
Type Description
Int32
Remarks

Original type in dictionary: FK.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

UpdatedCount

.NET type: short. Number of updates made to this record

Declaration
public virtual short UpdatedCount { get; set; }
Property Value
Type Description
Int16
Remarks

Original type in dictionary: UShort.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((Int16)0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

ValidFrom

.NET type: DateTime. Valid from date for this record

Declaration
public virtual DateTime ValidFrom { get; set; }
Property Value
Type Description
DateTime
Remarks

Original type in dictionary: DateTime.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

ValidTo

.NET type: DateTime. Valid to date for this record

Declaration
public virtual DateTime ValidTo { get; set; }
Property Value
Type Description
DateTime
Remarks

Original type in dictionary: DateTime.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

Wgs84Latitude

.NET type: double. Latitude (that's north/south), decimal degrees, relative to WGS 84 ellipsoid. SuperOffice ASA is at 59.91892. This value needs no further grid reference or other qualifying information.

Declaration
public virtual double Wgs84Latitude { get; set; }
Property Value
Type Description
Double
Remarks

Original type in dictionary: Double.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

Wgs84Longitude

.NET type: double. Longitude (that's East/west), decimal degrees, relative to WGS 84 ellipsoid. SuperOffice ASA is at 10.73159. This value needs no further grid reference or other qualifying information.

Declaration
public virtual double Wgs84Longitude { get; set; }
Property Value
Type Description
Double
Remarks

Original type in dictionary: Double.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

Zipcode

.NET type: string. Zip code, alphanumeric

Declaration
public virtual string Zipcode { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[12].

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (string.Empty)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions
Type Condition
SoSentryException

Thrown if the set method is accessed without having the Write access right to the field

Methods

CreateNew()

Create a new instance of the AddressRow object. Contact and Person addresses

Declaration
public static AddressRow CreateNew()
Returns
Type Description
AddressRow

A new instance of the AddressRow object.

GetFromCustomSearch(AddressRow.CustomSearch)

Create a new instance of the AddressRow object, and populate it with data from a custom search. If the search returns no results, an object with IsNew will be returned; if the result contains one row, an object representing that row will be returned. If the result contains more than one row, the first row will be used and the rest discarded (there is no way of detecting this situation).

Declaration
public static AddressRow GetFromCustomSearch(AddressRow.CustomSearch query)
Parameters
Type Name Description
AddressRow.CustomSearch query

The custom search to execute against the database

Returns
Type Description
AddressRow

A new instance of the AddressRow object, reflecting the result of the query.

GetFromIdxAddressId(Int32)

Create a new instance of the AddressRow object, by querying the database table via the index 'IDXAddrId'. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static AddressRow GetFromIdxAddressId(int addressId)
Parameters
Type Name Description
Int32 addressId
Returns
Type Description
AddressRow

Row object that represents the result of the search. IsNew will be true if the query did not match any row in the table

Remarks

This method represents one of the unique indexes on the Address table. Non-unique indexes have corresponding inner classes and methods in the AddressRows collection, since they may return more than one row.

GetFromIdxOwnerIdAtypeIdx(Int32, AddressType)

Create a new instance of the AddressRow object, by querying the database table via the index 'IOwner_idType_idx'. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static AddressRow GetFromIdxOwnerIdAtypeIdx(int ownerId, AddressType atypeIdx)
Parameters
Type Name Description
Int32 ownerId
AddressType atypeIdx
Returns
Type Description
AddressRow

Row object that represents the result of the search. IsNew will be true if the query did not match any row in the table

Remarks

This method represents one of the unique indexes on the Address table. Non-unique indexes have corresponding inner classes and methods in the AddressRows collection, since they may return more than one row.

GetFromReader(SoDataReader, AddressTableInfo)

Create a new instance of the AddressRow object, and populate it with data from a reader/tableinfo. If the reader has DBNull as the current value of the primary key field, an unpopulated object with IsNew == true will be returned. If any fields are missing or one of the non-primary key fields is DBNull, an exception will be thrown. Contact and Person addresses

Declaration
public static AddressRow GetFromReader(SoDataReader reader, AddressTableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.

AddressTableInfo tableInfo

AddressTableInfo instance used in the query that is the source of the reader. The fields used from the reader will be those owned by this tableinfo object.

Returns
Type Description
AddressRow

A new instance of the AddressRow object.

GetPersistedFieldValue(FieldInfo)

Get the persisted value of a field.

Declaration
public override object GetPersistedFieldValue(FieldInfo field)
Parameters
Type Name Description
FieldInfo field

Specification of a field

Returns
Type Description
Object

Field value, such as an int, DateTime, string ... Null can be returned if the value is not known.

Overrides
PrivateSave.GetPersistedFieldValue(FieldInfo)
Exceptions
Type Condition
ArgumentException

Thrown if the field is not known.

InternalSetValue(String, Object)

Declaration
protected override void InternalSetValue(string fieldName, object value)
Parameters
Type Name Description
String fieldName
Object value
Overrides
TableRowBase.InternalSetValue(String, Object)

IsPersistedFieldValueKnown(FieldInfo)

Check if the persisted value for a field is known.

Declaration
public override bool IsPersistedFieldValueKnown(FieldInfo field)
Parameters
Type Name Description
FieldInfo field

Specification of a field

Returns
Type Description
Boolean

True if the value is known and sentry permits read.

Overrides
PrivateSave.IsPersistedFieldValueKnown(FieldInfo)

OnLoad(SoDataReader, TableInfo)

Fill the object with data returned from the database.

Declaration
protected override void OnLoad(SoDataReader reader, TableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

Object holding the data returned from the database.

TableInfo tableInfo

The TableInfo used for the SELECT statement.

Overrides
TableRowBase.OnLoad(SoDataReader, TableInfo)

OnSave(BatchSave)

Add the object to the BatchSave list if it needs saving.

Declaration
protected override void OnSave(BatchSave batchSave)
Parameters
Type Name Description
BatchSave batchSave

Collection of objects to be saved within the transaction.

Overrides
TableRowBase.OnSave(BatchSave)
Remarks

Classes overriding this method should call it.

OnSaved(Boolean)

Method called after the save operation has been performed.

Declaration
protected override void OnSaved(bool bSucceeded)
Parameters
Type Name Description
Boolean bSucceeded

True if the save operation succeeded (e.g. transaction committed), or false if the save operation failed (e.g. transaction rolled back)

Overrides
TableRowBase.OnSaved(Boolean)

Reset()

Reset the changes made on the object.

Declaration
protected override void Reset()
Overrides
TableRowBase.Reset()
Remarks

If the row is not persisted to the database (e.g. IsNew is true), all the values will be reset. If the row has been persisted to or loaded from the database, the properties will be set to those of the last persisted or loaded values.

SetDefaults(DefaulterStrategy)

Set default values for the row.

Declaration
public override void SetDefaults(DefaulterStrategy strategy)
Parameters
Type Name Description
DefaulterStrategy strategy

Strategy used when applying default values; values depend on where we are in the Create/Fetch/Populate/Save cycle

Overrides
TableRowBase.SetDefaults(DefaulterStrategy)

SetPrimaryKey(Int32)

Set the primary key for the row.

Declaration
protected override void SetPrimaryKey(int primaryKey)
Parameters
Type Name Description
Int32 primaryKey

The new primary key for the row.

Overrides
TableRowBase.SetPrimaryKey(Int32)

SetRowAsNew()

Declaration
public override void SetRowAsNew()
Overrides
TableRowBase.SetRowAsNew()

ToString()

ToString method intended for debugging, returns a string that displays the object type, new/dirty status, primary key and the string fields

Declaration
public override string ToString()
Returns
Type Description
String
Overrides
Object.ToString()

Validate(RowValidator)

Validate this row.

Declaration
public override void Validate(RowValidator rowValidator)
Parameters
Type Name Description
RowValidator rowValidator

RowValidator for inserting the result of the validation

Overrides
TableRowBase.Validate(RowValidator)

Events

_onAddress1Change

Change envent for property Address1; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onAddress1Change
Event Type
Type Description
OnFieldChange<String>

_onAddress2Change

Change envent for property Address2; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onAddress2Change
Event Type
Type Description
OnFieldChange<String>

_onAddress3Change

Change envent for property Address3; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onAddress3Change
Event Type
Type Description
OnFieldChange<String>

_onAtypeIdxChange

Change envent for property AtypeIdx; field is of .NET type short.

Declaration
protected event OnFieldChange<AddressType> _onAtypeIdxChange
Event Type
Type Description
OnFieldChange<AddressType>

_onCityChange

Change envent for property City; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onCityChange
Event Type
Type Description
OnFieldChange<String>

_onCountyChange

Change envent for property County; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onCountyChange
Event Type
Type Description
OnFieldChange<String>

_onOwnerIdChange

Change envent for property OwnerId; field is of .NET type int.

Declaration
protected event OnFieldChange<int> _onOwnerIdChange
Event Type
Type Description
OnFieldChange<Int32>

_onRegisteredAssociateIdChange

Change envent for property RegisteredAssociateId; field is of .NET type int.

Declaration
protected event OnFieldChange<int> _onRegisteredAssociateIdChange
Event Type
Type Description
OnFieldChange<Int32>

_onRegisteredChange

Change envent for property Registered; field is of .NET type DateTime.

Declaration
protected event OnFieldChange<DateTime> _onRegisteredChange
Event Type
Type Description
OnFieldChange<DateTime>

_onStateChange

Change envent for property State; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onStateChange
Event Type
Type Description
OnFieldChange<String>

_onUpdatedAssociateIdChange

Change envent for property UpdatedAssociateId; field is of .NET type int.

Declaration
protected event OnFieldChange<int> _onUpdatedAssociateIdChange
Event Type
Type Description
OnFieldChange<Int32>

_onUpdatedChange

Change envent for property Updated; field is of .NET type DateTime.

Declaration
protected event OnFieldChange<DateTime> _onUpdatedChange
Event Type
Type Description
OnFieldChange<DateTime>

_onUpdatedCountChange

Change envent for property UpdatedCount; field is of .NET type short.

Declaration
protected event OnFieldChange<short> _onUpdatedCountChange
Event Type
Type Description
OnFieldChange<Int16>

_onValidFromChange

Change envent for property ValidFrom; field is of .NET type DateTime.

Declaration
protected event OnFieldChange<DateTime> _onValidFromChange
Event Type
Type Description
OnFieldChange<DateTime>

_onValidToChange

Change envent for property ValidTo; field is of .NET type DateTime.

Declaration
protected event OnFieldChange<DateTime> _onValidToChange
Event Type
Type Description
OnFieldChange<DateTime>

_onWgs84LatitudeChange

Change envent for property Wgs84Latitude; field is of .NET type double.

Declaration
protected event OnFieldChange<double> _onWgs84LatitudeChange
Event Type
Type Description
OnFieldChange<Double>

_onWgs84LongitudeChange

Change envent for property Wgs84Longitude; field is of .NET type double.

Declaration
protected event OnFieldChange<double> _onWgs84LongitudeChange
Event Type
Type Description
OnFieldChange<Double>

_onZipcodeChange

Change envent for property Zipcode; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onZipcodeChange
Event Type
Type Description
OnFieldChange<String>

OnAddress1Change

Event raised when Address1 is changing.

Declaration
public event OnFieldChange<string> OnAddress1Change
Event Type
Type Description
OnFieldChange<String>

OnAddress2Change

Event raised when Address2 is changing.

Declaration
public event OnFieldChange<string> OnAddress2Change
Event Type
Type Description
OnFieldChange<String>

OnAddress3Change

Event raised when Address3 is changing.

Declaration
public event OnFieldChange<string> OnAddress3Change
Event Type
Type Description
OnFieldChange<String>

OnAtypeIdxChange

Event raised when AtypeIdx is changing.

Declaration
public event OnFieldChange<AddressType> OnAtypeIdxChange
Event Type
Type Description
OnFieldChange<AddressType>

OnCityChange

Event raised when City is changing.

Declaration
public event OnFieldChange<string> OnCityChange
Event Type
Type Description
OnFieldChange<String>

OnCountyChange

Event raised when County is changing.

Declaration
public event OnFieldChange<string> OnCountyChange
Event Type
Type Description
OnFieldChange<String>

OnOwnerIdChange

Event raised when OwnerId is changing.

Declaration
public event OnFieldChange<int> OnOwnerIdChange
Event Type
Type Description
OnFieldChange<Int32>

OnRegisteredAssociateIdChange

Event raised when RegisteredAssociateId is changing.

Declaration
public event OnFieldChange<int> OnRegisteredAssociateIdChange
Event Type
Type Description
OnFieldChange<Int32>

OnRegisteredChange

Event raised when Registered is changing.

Declaration
public event OnFieldChange<DateTime> OnRegisteredChange
Event Type
Type Description
OnFieldChange<DateTime>

OnStateChange

Event raised when State is changing.

Declaration
public event OnFieldChange<string> OnStateChange
Event Type
Type Description
OnFieldChange<String>

OnUpdatedAssociateIdChange

Event raised when UpdatedAssociateId is changing.

Declaration
public event OnFieldChange<int> OnUpdatedAssociateIdChange
Event Type
Type Description
OnFieldChange<Int32>

OnUpdatedChange

Event raised when Updated is changing.

Declaration
public event OnFieldChange<DateTime> OnUpdatedChange
Event Type
Type Description
OnFieldChange<DateTime>

OnUpdatedCountChange

Event raised when UpdatedCount is changing.

Declaration
public event OnFieldChange<short> OnUpdatedCountChange
Event Type
Type Description
OnFieldChange<Int16>

OnValidFromChange

Event raised when ValidFrom is changing.

Declaration
public event OnFieldChange<DateTime> OnValidFromChange
Event Type
Type Description
OnFieldChange<DateTime>

OnValidToChange

Event raised when ValidTo is changing.

Declaration
public event OnFieldChange<DateTime> OnValidToChange
Event Type
Type Description
OnFieldChange<DateTime>

OnWgs84LatitudeChange

Event raised when Wgs84Latitude is changing.

Declaration
public event OnFieldChange<double> OnWgs84LatitudeChange
Event Type
Type Description
OnFieldChange<Double>

OnWgs84LongitudeChange

Event raised when Wgs84Longitude is changing.

Declaration
public event OnFieldChange<double> OnWgs84LongitudeChange
Event Type
Type Description
OnFieldChange<Double>

OnZipcodeChange

Event raised when Zipcode is changing.

Declaration
public event OnFieldChange<string> OnZipcodeChange
Event Type
Type Description
OnFieldChange<String>

Implements

INestedPersist
ISoDataLookup
ISentryIgnorable
ISoItem

Extension Methods

EnumUtil.MapEnums<From, To>(From)
QueryExectionExtensions.ExecuteReader(SqlCommand, Boolean)
QueryExectionExtensions.ExecuteScalar<T>(SqlCommand)
QueryExectionExtensions.ExecuteNonQuery(SqlCommand)
QuoteExtensions.CloneAddress(AddressRow)
Converters.MapEnums<From, To>(From)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top