Show / Hide Table of Contents

Class BatchTaskRow

Batch task request details, corresponding to the message body of a batch request message
Row Object for table 'BatchTask'. 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
BatchTaskRow
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 BatchTaskRow : 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) BatchTaskRow BatchTaskRow.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(BatchTaskRow.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 BatchTaskTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, BatchTaskTableInfo) 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 BatchTaskRows collection, which has nested classes and GetFromIdx methods for each non-unique index. Similarly, there is a GetFromReader(SoDataReader, BatchTaskTableInfo) method to retrieve the results of queries that return more than one row.

Unique indexes on table BatchTask are:

Index fieldsNested index class name

Constructors

BatchTaskRow(BatchTaskRow.BatchTaskRowIdxBase)

Constructor for the class taking an index as argument. Batch task request details, corresponding to the message body of a batch request message

Declaration
protected BatchTaskRow(BatchTaskRow.BatchTaskRowIdxBase idx)
Parameters
Type Name Description
BatchTaskRow.BatchTaskRowIdxBase idx

The index representing a SELECT command to the database.

Fields

_currentBatchTaskDefinitionId

Current value, see property BatchTaskDefinitionId.

Declaration
protected int _currentBatchTaskDefinitionId
Field Value
Type Description
Int32

_currentBatchTaskId

Current value, see property BatchTaskId.

Declaration
protected int _currentBatchTaskId
Field Value
Type Description
Int32

_currentDbTag

Current value, see property DbTag.

Declaration
protected string _currentDbTag
Field Value
Type Description
String

_currentDescription

Current value, see property Description.

Declaration
protected string _currentDescription
Field Value
Type Description
String

_currentDetailsRecord

Current value, see property DetailsRecord.

Declaration
protected int _currentDetailsRecord
Field Value
Type Description
Int32

_currentDetailsTable

Current value, see property DetailsTable.

Declaration
protected short _currentDetailsTable
Field Value
Type Description
Int16

_currentFileName

Current value, see property FileName.

Declaration
protected string _currentFileName
Field Value
Type Description
String

_currentLastStarted

Current value, see property LastStarted.

Declaration
protected DateTime _currentLastStarted
Field Value
Type Description
DateTime

_currentProgressDescription

Current value, see property ProgressDescription.

Declaration
protected string _currentProgressDescription
Field Value
Type Description
String

_currentProgressPercent

Current value, see property ProgressPercent.

Declaration
protected short _currentProgressPercent
Field Value
Type Description
Int16

_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

_currentRequest

Current value, see property Request.

Declaration
protected string _currentRequest
Field Value
Type Description
String

_currentResponse

Current value, see property Response.

Declaration
protected string _currentResponse
Field Value
Type Description
String

_currentStartCount

Current value, see property StartCount.

Declaration
protected int _currentStartCount
Field Value
Type Description
Int32

_currentState

Current value, see property State.

Declaration
protected int _currentState
Field Value
Type Description
Int32

_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

_persistedBatchTaskDefinitionId

Persisted value, see property BatchTaskDefinitionId.

Declaration
protected int _persistedBatchTaskDefinitionId
Field Value
Type Description
Int32

_persistedBatchTaskId

Persisted value, see property BatchTaskId.

Declaration
protected int _persistedBatchTaskId
Field Value
Type Description
Int32

_persistedDbTag

Persisted value, see property DbTag.

Declaration
protected string _persistedDbTag
Field Value
Type Description
String

_persistedDescription

Persisted value, see property Description.

Declaration
protected string _persistedDescription
Field Value
Type Description
String

_persistedDetailsRecord

Persisted value, see property DetailsRecord.

Declaration
protected int _persistedDetailsRecord
Field Value
Type Description
Int32

_persistedDetailsTable

Persisted value, see property DetailsTable.

Declaration
protected short _persistedDetailsTable
Field Value
Type Description
Int16

_persistedFileName

Persisted value, see property FileName.

Declaration
protected string _persistedFileName
Field Value
Type Description
String

_persistedLastStarted

Persisted value, see property LastStarted.

Declaration
protected DateTime _persistedLastStarted
Field Value
Type Description
DateTime

_persistedProgressDescription

Persisted value, see property ProgressDescription.

Declaration
protected string _persistedProgressDescription
Field Value
Type Description
String

_persistedProgressPercent

Persisted value, see property ProgressPercent.

Declaration
protected short _persistedProgressPercent
Field Value
Type Description
Int16

_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

_persistedRequest

Persisted value, see property Request.

Declaration
protected string _persistedRequest
Field Value
Type Description
String

_persistedResponse

Persisted value, see property Response.

Declaration
protected string _persistedResponse
Field Value
Type Description
String

_persistedStartCount

Persisted value, see property StartCount.

Declaration
protected int _persistedStartCount
Field Value
Type Description
Int32

_persistedState

Persisted value, see property State.

Declaration
protected int _persistedState
Field Value
Type Description
Int32

_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

Properties

BatchTaskDefinitionId

.NET type: int. Batch task definition, which is populated from code attributes

Declaration
public virtual int BatchTaskDefinitionId { get; set; }
Property Value
Type Description
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

BatchTaskId

.NET type: int. Primary key

Declaration
public virtual int BatchTaskId { 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

BatchTaskTableInfo

Get the BatchTaskTableInfo object associated with the row.

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

DbTag

.NET type: string. Database tag that this task applies to, to ensure tasks are execute on the correct database only

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

Original type in dictionary: String[40].

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

Description

.NET type: string. Description of task (for monitoring and debugging)

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

Original type in dictionary: String[255].

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

DetailsRecord

.NET type: int. Optional record containing further details that will not fit in the standard request/response fields

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

Original type in dictionary: RecordId.

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

DetailsTable

.NET type: short. Optional table containing further details that will not fit in the standard request/response fields

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

Original type in dictionary: TableNumber.

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

FileName

.NET type: string. The filename related to the batchtask.

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

Original type in dictionary: String[261].

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

LastStarted

.NET type: DateTime. When was this job last started

Declaration
public virtual DateTime LastStarted { 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

ProgressDescription

.NET type: string. Descriptive text for the current stage

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

Original type in dictionary: String[255].

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

ProgressPercent

.NET type: short. Task progress, in percent of estimated total

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

Original type in dictionary: UShort.

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.

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

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.

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

Request

.NET type: string. The batch request, specifying what to do

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

Original type in dictionary: String[255].

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

Response

.NET type: string. The response from the batch task processor

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

Original type in dictionary: String[255].

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

StartCount

.NET type: int. Number of times this batch task has been started (0 for tasks that have never been executed)

Declaration
public virtual int StartCount { 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

State

.NET type: int. 0=Unknown; 1=New; 2=Assigned; 3=Started; 4=Succeeded; 5=Failed

Declaration
public virtual int State { get; set; }
Property Value
Type Description
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

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. 'heartbeat' that is updated once a minute by the batch task process in UTC

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

Original type in dictionary: UtcDateTime.

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

UpdatedAssociateId

.NET type: int. 'heartbeat' that is updated once a minute by the batch task process

Declaration
public virtual int UpdatedAssociateId { get; set; }
Property Value
Type Description
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

UpdatedCount

.NET type: short. 'heartbeat' that is updated once a minute by the batch task process

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

Original type in dictionary: UShort.

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 BatchTaskRow object. Batch task request details, corresponding to the message body of a batch request message

Declaration
public static BatchTaskRow CreateNew()
Returns
Type Description
BatchTaskRow

A new instance of the BatchTaskRow object.

GetFromCustomSearch(BatchTaskRow.CustomSearch)

Create a new instance of the BatchTaskRow 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 BatchTaskRow GetFromCustomSearch(BatchTaskRow.CustomSearch query)
Parameters
Type Name Description
BatchTaskRow.CustomSearch query

The custom search to execute against the database

Returns
Type Description
BatchTaskRow

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

GetFromIdxBatchTaskId(Int32)

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

Declaration
public static BatchTaskRow GetFromIdxBatchTaskId(int batchTaskId)
Parameters
Type Name Description
Int32 batchTaskId
Returns
Type Description
BatchTaskRow

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

GetFromReader(SoDataReader, BatchTaskTableInfo)

Create a new instance of the BatchTaskRow 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. Batch task request details, corresponding to the message body of a batch request message

Declaration
public static BatchTaskRow GetFromReader(SoDataReader reader, BatchTaskTableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.

BatchTaskTableInfo tableInfo

BatchTaskTableInfo 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
BatchTaskRow

A new instance of the BatchTaskRow 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

_onBatchTaskDefinitionIdChange

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

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

_onDbTagChange

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

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

_onDescriptionChange

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

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

_onDetailsRecordChange

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

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

_onDetailsTableChange

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

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

_onFileNameChange

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

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

_onLastStartedChange

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

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

_onProgressDescriptionChange

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

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

_onProgressPercentChange

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

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

_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>

_onRequestChange

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

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

_onResponseChange

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

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

_onStartCountChange

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

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

_onStateChange

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

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

_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>

OnBatchTaskDefinitionIdChange

Event raised when BatchTaskDefinitionId is changing.

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

OnDbTagChange

Event raised when DbTag is changing.

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

OnDescriptionChange

Event raised when Description is changing.

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

OnDetailsRecordChange

Event raised when DetailsRecord is changing.

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

OnDetailsTableChange

Event raised when DetailsTable is changing.

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

OnFileNameChange

Event raised when FileName is changing.

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

OnLastStartedChange

Event raised when LastStarted is changing.

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

OnProgressDescriptionChange

Event raised when ProgressDescription is changing.

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

OnProgressPercentChange

Event raised when ProgressPercent is changing.

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

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>

OnRequestChange

Event raised when Request is changing.

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

OnResponseChange

Event raised when Response is changing.

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

OnStartCountChange

Event raised when StartCount is changing.

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

OnStateChange

Event raised when State is changing.

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

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>

Implements

INestedPersist
ISoDataLookup
ISentryIgnorable
ISoItem

Extension Methods

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