Class ExternalEventRow

The definition of projects as events in Audience (or other Collaborative apps)
Row Object for table 'ExternalEvent'. 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
ExternalEventRow
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class ExternalEventRow : 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) ExternalEventRow ExternalEventRow.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(ExternalEventRow.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 ExternalEventTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, ExternalEventTableInfo) 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 ExternalEventRows collection, which has nested classes and GetFromIdx methods for each non-unique index. Similarly, there is a GetFromReader(SoDataReader, ExternalEventTableInfo) method to retrieve the results of queries that return more than one row.

Unique indexes on table ExternalEvent are:

Index fieldsNested index class name

Constructors

ExternalEventRow(ExternalEventRow.ExternalEventRowIdxBase)

Constructor for the class taking an index as argument. The definition of projects as events in Audience (or other Collaborative apps)

Declaration
protected ExternalEventRow(ExternalEventRow.ExternalEventRowIdxBase idx)
Parameters
Type Name Description
ExternalEventRow.ExternalEventRowIdxBase idx

The index representing a SELECT command to the database.

Fields

_currentEventDate

Current value, see property EventDate.

Declaration
protected DateTime _currentEventDate
Field Value
Type Description
DateTime

_currentEventEnabled

Current value, see property EventEnabled.

Declaration
protected short _currentEventEnabled
Field Value
Type Description
Int16

_currentExternalEventId

Current value, see property ExternalEventId.

Declaration
protected int _currentExternalEventId
Field Value
Type Description
Int32

_currentParentRecord

Current value, see property ParentRecord.

Declaration
protected int _currentParentRecord
Field Value
Type Description
Int32

_currentParentTable

Current value, see property ParentTable.

Declaration
protected short _currentParentTable
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

_currentSignOff

Current value, see property SignOff.

Declaration
protected short _currentSignOff
Field Value
Type Description
Int16

_currentSignOffAssocId

Current value, see property SignOffAssocId.

Declaration
protected int _currentSignOffAssocId
Field Value
Type Description
Int32

_currentSignOffConfTextId

Current value, see property SignOffConfTextId.

Declaration
protected int _currentSignOffConfTextId
Field Value
Type Description
Int32

_currentSignOffTaskEnable

Current value, see property SignOffTaskEnable.

Declaration
protected short _currentSignOffTaskEnable
Field Value
Type Description
Int16

_currentSignOffTaskId

Current value, see property SignOffTaskId.

Declaration
protected int _currentSignOffTaskId
Field Value
Type Description
Int32

_currentSignOffTextId

Current value, see property SignOffTextId.

Declaration
protected int _currentSignOffTextId
Field Value
Type Description
Int32

_currentSignOffTriggersAssign

Current value, see property SignOffTriggersAssign.

Declaration
protected short _currentSignOffTriggersAssign
Field Value
Type Description
Int16

_currentSignOn

Current value, see property SignOn.

Declaration
protected short _currentSignOn
Field Value
Type Description
Int16

_currentSignOnAssocId

Current value, see property SignOnAssocId.

Declaration
protected int _currentSignOnAssocId
Field Value
Type Description
Int32

_currentSignOnConfTextId

Current value, see property SignOnConfTextId.

Declaration
protected int _currentSignOnConfTextId
Field Value
Type Description
Int32

_currentSignOnTaskEnable

Current value, see property SignOnTaskEnable.

Declaration
protected short _currentSignOnTaskEnable
Field Value
Type Description
Int16

_currentSignOnTaskId

Current value, see property SignOnTaskId.

Declaration
protected int _currentSignOnTaskId
Field Value
Type Description
Int32

_currentSignOnTextId

Current value, see property SignOnTextId.

Declaration
protected int _currentSignOnTextId
Field Value
Type Description
Int32

_currentSignOnTriggersAssign

Current value, see property SignOnTriggersAssign.

Declaration
protected short _currentSignOnTriggersAssign
Field Value
Type Description
Int16

_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

_persistedEventDate

Persisted value, see property EventDate.

Declaration
protected DateTime _persistedEventDate
Field Value
Type Description
DateTime

_persistedEventEnabled

Persisted value, see property EventEnabled.

Declaration
protected short _persistedEventEnabled
Field Value
Type Description
Int16

_persistedExternalEventId

Persisted value, see property ExternalEventId.

Declaration
protected int _persistedExternalEventId
Field Value
Type Description
Int32

_persistedParentRecord

Persisted value, see property ParentRecord.

Declaration
protected int _persistedParentRecord
Field Value
Type Description
Int32

_persistedParentTable

Persisted value, see property ParentTable.

Declaration
protected short _persistedParentTable
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

_persistedSignOff

Persisted value, see property SignOff.

Declaration
protected short _persistedSignOff
Field Value
Type Description
Int16

_persistedSignOffAssocId

Persisted value, see property SignOffAssocId.

Declaration
protected int _persistedSignOffAssocId
Field Value
Type Description
Int32

_persistedSignOffConfTextId

Persisted value, see property SignOffConfTextId.

Declaration
protected int _persistedSignOffConfTextId
Field Value
Type Description
Int32

_persistedSignOffTaskEnable

Persisted value, see property SignOffTaskEnable.

Declaration
protected short _persistedSignOffTaskEnable
Field Value
Type Description
Int16

_persistedSignOffTaskId

Persisted value, see property SignOffTaskId.

Declaration
protected int _persistedSignOffTaskId
Field Value
Type Description
Int32

_persistedSignOffTextId

Persisted value, see property SignOffTextId.

Declaration
protected int _persistedSignOffTextId
Field Value
Type Description
Int32

_persistedSignOffTriggersAssign

Persisted value, see property SignOffTriggersAssign.

Declaration
protected short _persistedSignOffTriggersAssign
Field Value
Type Description
Int16

_persistedSignOn

Persisted value, see property SignOn.

Declaration
protected short _persistedSignOn
Field Value
Type Description
Int16

_persistedSignOnAssocId

Persisted value, see property SignOnAssocId.

Declaration
protected int _persistedSignOnAssocId
Field Value
Type Description
Int32

_persistedSignOnConfTextId

Persisted value, see property SignOnConfTextId.

Declaration
protected int _persistedSignOnConfTextId
Field Value
Type Description
Int32

_persistedSignOnTaskEnable

Persisted value, see property SignOnTaskEnable.

Declaration
protected short _persistedSignOnTaskEnable
Field Value
Type Description
Int16

_persistedSignOnTaskId

Persisted value, see property SignOnTaskId.

Declaration
protected int _persistedSignOnTaskId
Field Value
Type Description
Int32

_persistedSignOnTextId

Persisted value, see property SignOnTextId.

Declaration
protected int _persistedSignOnTextId
Field Value
Type Description
Int32

_persistedSignOnTriggersAssign

Persisted value, see property SignOnTriggersAssign.

Declaration
protected short _persistedSignOnTriggersAssign
Field Value
Type Description
Int16

_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

EventDate

.NET type: DateTime. Dateof the event; publishing/visibility dates are in Publish, and restrictions are in AudienceVisibility

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

EventEnabled

.NET type: short. Is the event enabled

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

ExternalEventId

.NET type: int. Primary key

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

ExternalEventTableInfo

Get the ExternalEventTableInfo object associated with the row.

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

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

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

InnerPrimaryKeyValue

The actual value the primary key must have.

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

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

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

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
Exceptions
Type Condition
ArgumentException

Thrown if the field is not known.

ParentRecord

.NET type: int. The thing, that has now become an Event

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

ParentTable

.NET type: short. The thing, that has now become an Event

Declaration
public virtual short ParentTable { 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

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

SignOff

.NET type: short. Is Sign Off functionality enabled

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

SignOffAssocId

.NET type: int. If 0, the signOn Activity should go into the persons Our Contact; if not 0, this is the Associate whose diary should get the activity

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

SignOffConfTextId

.NET type: int. If not 0, the given text should be shown as a confirmation text before accpting Sign Off

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

SignOffTaskEnable

.NET type: short. If not 0, a task should be created when the external user Signs Off an event

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

SignOffTaskId

.NET type: int. If not 0, sign off should cause an Activity of this type to be registered

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

SignOffTextId

.NET type: int. If not 0, the given text should be shown as a confirmation text before accpting Sign Off

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

SignOffTriggersAssign

.NET type: short. If 1, the SignOff task should be created as an Assigned task, triggering the invitation dialog

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

SignOn

.NET type: short. Is Sign On functionality enabled

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

SignOnAssocId

.NET type: int. If 0, the signOn Activity should go into the persons Our Contact; if not 0, this is the Associate whose diary should get the activity

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

SignOnConfTextId

.NET type: int. If not 0, the given text should be shown as a confirmation text before accpting Sign On

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

SignOnTaskEnable

.NET type: short. If not 0, a task should be created when the external user Signs On to an event

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

SignOnTaskId

.NET type: int. If not 0, sign on should cause an Activity of this type to be registered

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

SignOnTextId

.NET type: int. If not 0, the given text should be entered into the appointment

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

SignOnTriggersAssign

.NET type: short. If 1, the SignOn task should be created as an Assigned task, triggering the invitation dialog

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

TableInfo

Get the TableInfo for the table.

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

The TableInfo for the table.
Overrides

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.

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. Last updated by whom

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

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 ExternalEventRow object. The definition of projects as events in Audience (or other Collaborative apps)

Declaration
public static ExternalEventRow CreateNew()
Returns
Type Description
ExternalEventRow

A new instance of the ExternalEventRow object.

GetFromCustomSearch(ExternalEventRow.CustomSearch)

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

The custom search to execute against the database
Returns
Type Description
ExternalEventRow

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

GetFromIdxExternalEventId(Int32)

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

Declaration
public static ExternalEventRow GetFromIdxExternalEventId(int externalEventId)
Parameters
Type Name Description
Int32 externalEventId
Returns
Type Description
ExternalEventRow

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

GetFromReader(SoDataReader, ExternalEventTableInfo)

Create a new instance of the ExternalEventRow 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. The definition of projects as events in Audience (or other Collaborative apps)

Declaration
public static ExternalEventRow GetFromReader(SoDataReader reader, ExternalEventTableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.
ExternalEventTableInfo tableInfo

ExternalEventTableInfo 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
ExternalEventRow

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

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

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

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

Reset()

Reset the changes made on the object.

Declaration
protected override void Reset()
Overrides
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

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

SetRowAsNew()

Declaration
public override void SetRowAsNew()
Overrides

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

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

Events

_onEventDateChange

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

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

_onEventEnabledChange

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

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

_onParentRecordChange

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

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

_onParentTableChange

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

Declaration
protected event OnFieldChange<short> _onParentTableChange
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>

_onSignOffAssocIdChange

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

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

_onSignOffChange

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

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

_onSignOffConfTextIdChange

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

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

_onSignOffTaskEnableChange

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

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

_onSignOffTaskIdChange

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

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

_onSignOffTextIdChange

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

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

_onSignOffTriggersAssignChange

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

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

_onSignOnAssocIdChange

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

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

_onSignOnChange

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

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

_onSignOnConfTextIdChange

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

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

_onSignOnTaskEnableChange

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

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

_onSignOnTaskIdChange

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

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

_onSignOnTextIdChange

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

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

_onSignOnTriggersAssignChange

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

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

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

OnEventDateChange

Event raised when EventDate is changing.

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

OnEventEnabledChange

Event raised when EventEnabled is changing.

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

OnParentRecordChange

Event raised when ParentRecord is changing.

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

OnParentTableChange

Event raised when ParentTable is changing.

Declaration
public event OnFieldChange<short> OnParentTableChange
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>

OnSignOffAssocIdChange

Event raised when SignOffAssocId is changing.

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

OnSignOffChange

Event raised when SignOff is changing.

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

OnSignOffConfTextIdChange

Event raised when SignOffConfTextId is changing.

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

OnSignOffTaskEnableChange

Event raised when SignOffTaskEnable is changing.

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

OnSignOffTaskIdChange

Event raised when SignOffTaskId is changing.

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

OnSignOffTextIdChange

Event raised when SignOffTextId is changing.

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

OnSignOffTriggersAssignChange

Event raised when SignOffTriggersAssign is changing.

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

OnSignOnAssocIdChange

Event raised when SignOnAssocId is changing.

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

OnSignOnChange

Event raised when SignOn is changing.

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

OnSignOnConfTextIdChange

Event raised when SignOnConfTextId is changing.

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

OnSignOnTaskEnableChange

Event raised when SignOnTaskEnable is changing.

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

OnSignOnTaskIdChange

Event raised when SignOnTaskId is changing.

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

OnSignOnTextIdChange

Event raised when SignOnTextId is changing.

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

OnSignOnTriggersAssignChange

Event raised when SignOnTriggersAssign is changing.

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

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

Extension Methods

EnumUtil.MapEnums<From, To>(From)