Class SShipmentAddrRow

Addresses that are ready to be sent in a shipment.
Row Object for table 's_shipment_addr'. 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

System.Object

SqlCommand

PrivateSave

TableRowBase

SShipmentAddrRow

Implements

INestedPersist

ISoDataLookup

ISentryIgnorable

ISoItem

Inherited Members

TableRowBase._saveOwner

TableRowBase._sentries

TableRowBase._relatedNestedPersistMembers

TableRowBase._isSaving

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.add_OnElementSaved(OnSaved)

TableRowBase.remove_OnElementSaved(OnSaved)

TableRowBase.add_OnElementIdUpdate(OnIdUpdate)

TableRowBase.remove_OnElementIdUpdate(OnIdUpdate)

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.OnElementSaved

TableRowBase.OnElementIdUpdate

PrivateSave.GetTableInfos()

PrivateSave.add_OnUpdateField(UpdateField)

PrivateSave.remove_OnUpdateField(UpdateField)

PrivateSave.CloneToBasicUpdatingQuery()

PrivateSave.SetTicketLogAction(TicketLogAction, String)

PrivateSave.DoNotWriteTraveltransactionLog

PrivateSave.OnUpdateField

SqlCommand.Origin

SqlCommand.AdditionalInfo

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

Namespace: SuperOffice.CRM.Rows

Assembly: SoDataBase.dll

Syntax

public class SShipmentAddrRow : 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) SShipmentAddrRow SShipmentAddrRow.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(SShipmentAddrRow.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 SShipmentAddrTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, SShipmentAddrTableInfo) 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 SShipmentAddrRows collection, which has nested classes and GetFromIdx methods for each non-unique index. Similarly, there is a GetFromReader(SoDataReader, SShipmentAddrTableInfo) method to retrieve the results of queries that return more than one row.

Unique indexes on table SShipmentAddr are:

Index fields	Nested index class name

Constructors

SShipmentAddrRow(SShipmentAddrRow.SShipmentAddrRowIdxBase)

Constructor for the class taking an index as argument. Addresses that are ready to be sent in a shipment.

Declaration

protected SShipmentAddrRow(SShipmentAddrRow.SShipmentAddrRowIdxBase idx)

Parameters

Type	Name	Description
SuperOffice.CRM.Rows.SShipmentAddrRow.SShipmentAddrRowIdxBase	idx	The index representing a SELECT command to the database.

Fields

_currentAddress

Current value, see property Address.

Declaration

protected string _currentAddress

Field Value

Type	Description
System.String

_currentBounceCode

Current value, see property BounceCode.

Declaration

protected int _currentBounceCode

Field Value

Type	Description
System.Int32

_currentBounceReason

Current value, see property BounceReason.

Declaration

protected string _currentBounceReason

Field Value

Type	Description
System.String

_currentBounceReasontag

Current value, see property BounceReasontag.

Declaration

protected string _currentBounceReasontag

Field Value

Type	Description
System.String

_currentCleaned

Current value, see property Cleaned.

Declaration

protected short _currentCleaned

Field Value

Type	Description
System.Int16

_currentContactId

Current value, see property ContactId.

Declaration

protected int _currentContactId

Field Value

Type	Description
System.Int32

_currentCustomerId

Current value, see property CustomerId.

Declaration

protected int _currentCustomerId

Field Value

Type	Description
System.Int32

_currentFormSubmissionId

Current value, see property FormSubmissionId.

Declaration

protected int _currentFormSubmissionId

Field Value

Type	Description
System.Int32

_currentName

Current value, see property Name.

Declaration

protected string _currentName

Field Value

Type	Description
System.String

_currentSenderNr

Current value, see property SenderNr.

Declaration

protected int _currentSenderNr

Field Value

Type	Description
System.Int32

_currentSendingTime

Current value, see property SendingTime.

Declaration

protected DateTime _currentSendingTime

Field Value

Type	Description
System.DateTime

_currentShipmentId

Current value, see property ShipmentId.

Declaration

protected int _currentShipmentId

Field Value

Type	Description
System.Int32

_currentSShipmentAddrId

Current value, see property SShipmentAddrId.

Declaration

protected int _currentSShipmentAddrId

Field Value

Type	Description
System.Int32

_currentStatus

Current value, see property Status.

Declaration

protected ShipmentAddrStatus _currentStatus

Field Value

Type	Description
ShipmentAddrStatus

_currentTicketId

Current value, see property TicketId.

Declaration

protected int _currentTicketId

Field Value

Type	Description
System.Int32

_currentTimestamp

Current value, see property Timestamp.

Declaration

protected int _currentTimestamp

Field Value

Type	Description
System.Int32

_currentType

Current value, see property Type.

Declaration

protected int _currentType

Field Value

Type	Description
System.Int32

_currentWorkflowInstanceId

Current value, see property WorkflowInstanceId.

Declaration

protected int _currentWorkflowInstanceId

Field Value

Type	Description
System.Int32

_currentWorkflowStepId

Current value, see property WorkflowStepId.

Declaration

protected int _currentWorkflowStepId

Field Value

Type	Description
System.Int32

_persistedAddress

Persisted value, see property Address.

Declaration

protected string _persistedAddress

Field Value

Type	Description
System.String

_persistedBounceCode

Persisted value, see property BounceCode.

Declaration

protected int _persistedBounceCode

Field Value

Type	Description
System.Int32

_persistedBounceReason

Persisted value, see property BounceReason.

Declaration

protected string _persistedBounceReason

Field Value

Type	Description
System.String

_persistedBounceReasontag

Persisted value, see property BounceReasontag.

Declaration

protected string _persistedBounceReasontag

Field Value

Type	Description
System.String

_persistedCleaned

Persisted value, see property Cleaned.

Declaration

protected short _persistedCleaned

Field Value

Type	Description
System.Int16

_persistedContactId

Persisted value, see property ContactId.

Declaration

protected int _persistedContactId

Field Value

Type	Description
System.Int32

_persistedCustomerId

Persisted value, see property CustomerId.

Declaration

protected int _persistedCustomerId

Field Value

Type	Description
System.Int32

_persistedFormSubmissionId

Persisted value, see property FormSubmissionId.

Declaration

protected int _persistedFormSubmissionId

Field Value

Type	Description
System.Int32

_persistedName

Persisted value, see property Name.

Declaration

protected string _persistedName

Field Value

Type	Description
System.String

_persistedSenderNr

Persisted value, see property SenderNr.

Declaration

protected int _persistedSenderNr

Field Value

Type	Description
System.Int32

_persistedSendingTime

Persisted value, see property SendingTime.

Declaration

protected DateTime _persistedSendingTime

Field Value

Type	Description
System.DateTime

_persistedShipmentId

Persisted value, see property ShipmentId.

Declaration

protected int _persistedShipmentId

Field Value

Type	Description
System.Int32

_persistedSShipmentAddrId

Persisted value, see property SShipmentAddrId.

Declaration

protected int _persistedSShipmentAddrId

Field Value

Type	Description
System.Int32

_persistedStatus

Persisted value, see property Status.

Declaration

protected ShipmentAddrStatus _persistedStatus

Field Value

Type	Description
ShipmentAddrStatus

_persistedTicketId

Persisted value, see property TicketId.

Declaration

protected int _persistedTicketId

Field Value

Type	Description
System.Int32

_persistedTimestamp

Persisted value, see property Timestamp.

Declaration

protected int _persistedTimestamp

Field Value

Type	Description
System.Int32

_persistedType

Persisted value, see property Type.

Declaration

protected int _persistedType

Field Value

Type	Description
System.Int32

_persistedWorkflowInstanceId

Persisted value, see property WorkflowInstanceId.

Declaration

protected int _persistedWorkflowInstanceId

Field Value

Type	Description
System.Int32

_persistedWorkflowStepId

Persisted value, see property WorkflowStepId.

Declaration

protected int _persistedWorkflowStepId

Field Value

Type	Description
System.Int32

Properties

Address

.NET type: string. The email address

Declaration

public virtual string Address { get; set; }

Property Value

Type	Description
System.String

Remarks

Original type in dictionary: String[256].

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

BounceCode

.NET type: int. If this recipient bounced and we have a bounce code, this field will contain the code

Declaration

public virtual int BounceCode { get; set; }

Property Value

Type	Description
System.Int32

Remarks

Original type in dictionary: Int.

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

BounceReason

.NET type: string. Reason text received from mailing system

Declaration

public virtual string BounceReason { get; set; }

Property Value

Type	Description
System.String

Remarks

Original type in dictionary: String[1024].

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

BounceReasontag

.NET type: string. If this recipient bounced and we have a bounce reason, this field will contain the reason

Declaration

public virtual string BounceReasontag { get; set; }

Property Value

Type	Description
System.String

Remarks

Original type in dictionary: String[4001].

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

Cleaned

.NET type: short. Used for indicating that a bounced recipient row has been cleaned, and now will not be presented again in the cleaning list

Declaration

public virtual short Cleaned { get; set; }

Property Value

Type	Description
System.Int16

Remarks

Original type in dictionary: Bool.

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

ContactId

.NET type: int. Id of contact bound to shipment address

Declaration

public virtual int ContactId { get; set; }

Property Value

Type	Description
System.Int32

Remarks

Original type in dictionary: FK.

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

CustomerId

.NET type: int. Id of the customer if this entry is created by a dynamic list

Declaration

public virtual int CustomerId { get; set; }

Property Value

Type	Description
System.Int32

Remarks

Original type in dictionary: FK.

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

FormSubmissionId

.NET type: int. If this mailing recipient is created from a form submission, this will contain a reference to that submission

Declaration

public virtual int FormSubmissionId { get; set; }

Property Value

Type	Description
System.Int32

Remarks

Original type in dictionary: FK.

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

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
System.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
System.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
System.String	fieldName	Name of the field in the database

Property Value

Type	Description
System.Object	Value of the field.

Overrides

TableRowBase.Item[String]

Exceptions

Type	Condition
ArgumentException	Thrown if the field is not known.

Name

.NET type: string. The name of the recipient

Declaration

public virtual string Name { get; set; }

Property Value

Type	Description
System.String

Remarks

Original type in dictionary: String[256].

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

SenderNr

.NET type: int. Used for multiple ejSenders. This field indicate which ejSender process this belongs to

Declaration

public virtual int SenderNr { get; set; }

Property Value

Type	Description
System.Int32

Remarks

Original type in dictionary: Int.

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

SendingTime

.NET type: DateTime. Estimated or actual sent time (depends on status)

Declaration

public virtual DateTime SendingTime { get; set; }

Property Value

Type	Description
System.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

ShipmentId

.NET type: int. Which shipment this address belongs to

Declaration

public virtual int ShipmentId { get; set; }

Property Value

Type	Description
System.Int32

Remarks

Original type in dictionary: FK.

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

SShipmentAddrId

.NET type: int. Primary key

Declaration

public virtual int SShipmentAddrId { get; }

Property Value

Type	Description
System.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

SShipmentAddrTableInfo

Get the SShipmentAddrTableInfo object associated with the row.

Declaration

public SShipmentAddrTableInfo SShipmentAddrTableInfo { get; }

Property Value

Type	Description
SShipmentAddrTableInfo

Status

.NET type: ShipmentAddrStatus. Status for sending to this particular recipient

Declaration

public virtual ShipmentAddrStatus Status { get; set; }

Property Value

Type	Description
ShipmentAddrStatus

Remarks

Original type in dictionary: Enum.

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

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

TicketId

.NET type: int. Id of the ticket if this entry is created by a ticketSelection list

Declaration

public virtual int TicketId { get; set; }

Property Value

Type	Description
System.Int32

Remarks

Original type in dictionary: FK.

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

Timestamp

.NET type: int. A stamp set when this address it taken by ejSender to prevent two ejSenders to take one address.

Declaration

public virtual int Timestamp { get; set; }

Property Value

Type	Description
System.Int32

Remarks

Original type in dictionary: Int.

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

Type

.NET type: int. Indicates if this is an email or a sms

Declaration

public virtual int Type { get; set; }

Property Value

Type	Description
System.Int32

Remarks

Original type in dictionary: Int.

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

WorkflowInstanceId

.NET type: int. The row was created by this workflow instance

Declaration

public virtual int WorkflowInstanceId { get; set; }

Property Value

Type	Description
System.Int32

Remarks

Original type in dictionary: FK.

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

WorkflowStepId

.NET type: int. The row was created by this workflow step

Declaration

public virtual int WorkflowStepId { get; set; }

Property Value

Type	Description
System.Int32

Remarks

Original type in dictionary: FK.

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

Methods

CreateNew()

Create a new instance of the SShipmentAddrRow object. Addresses that are ready to be sent in a shipment.

Declaration

public static SShipmentAddrRow CreateNew()

Returns

Type	Description
SShipmentAddrRow	A new instance of the SShipmentAddrRow object.

GetFromCustomSearch(SShipmentAddrRow.CustomSearch)

Create a new instance of the SShipmentAddrRow 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 SShipmentAddrRow GetFromCustomSearch(SShipmentAddrRow.CustomSearch query)

Parameters

Type	Name	Description
SShipmentAddrRow.CustomSearch	query	The custom search to execute against the database

Returns

Type	Description
SShipmentAddrRow	A new instance of the SShipmentAddrRow object, reflecting the result of the query.

GetFromIdxSShipmentAddrId(Int32)

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

Declaration

public static SShipmentAddrRow GetFromIdxSShipmentAddrId(int sShipmentAddrId)

Parameters

Type	Name	Description
System.Int32	sShipmentAddrId

Returns

Type	Description
SShipmentAddrRow	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 SShipmentAddr table. Non-unique indexes have corresponding inner classes and methods in the SShipmentAddrRows collection, since they may return more than one row.

GetFromReader(SoDataReader, SShipmentAddrTableInfo)

Create a new instance of the SShipmentAddrRow 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. Addresses that are ready to be sent in a shipment.

Declaration

public static SShipmentAddrRow GetFromReader(SoDataReader reader, SShipmentAddrTableInfo tableInfo)

Parameters

Type	Name	Description
SoDataReader	reader	SoDataReader positioned to a valid database row.
SShipmentAddrTableInfo	tableInfo	SShipmentAddrTableInfo 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
SShipmentAddrRow	A new instance of the SShipmentAddrRow 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
System.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
System.String	fieldName
System.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
System.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
System.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
System.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
System.String

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)

Implements

INestedPersist

ISoDataLookup

ISentryIgnorable

ISoItem

Extension Methods

EnumUtil.MapEnums<From, To>(From)

QueryExectionExtensions.ExecuteReader(SqlCommand, Boolean)

QueryExectionExtensions.ExecuteScalar<T>(SqlCommand)

QueryExectionExtensions.ExecuteNonQuery(SqlCommand)

SShipmentAddrRecordDataExtensions.ToRecordData(SShipmentAddrRow)

Converters.MapEnums<From, To>(From)