Class TravellerRow
Associates traveling out from this database
Row Object for table 'traveller'. Row objects correspond directly to database tables, and one
instance of a row object represents one row in the corresponding table in the database.
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class TravellerRow : 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) TravellerRow TravellerRow.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(TravellerRow.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 TravellerTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, TravellerTableInfo) 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.
Unique indexes on table Traveller are:
Index fields | Nested index class name |
---|
Constructors
TravellerRow(TravellerRow.TravellerRowIdxBase)
Constructor for the class taking an index as argument. Associates traveling out from this database
Declaration
protected TravellerRow(TravellerRow.TravellerRowIdxBase idx)
Parameters
Type | Name | Description |
---|---|---|
TravellerRow.TravellerRowIdxBase | idx | The index representing a SELECT command to the database. |
Fields
_currentAreaId
Current value, see property AreaId.
Declaration
protected int _currentAreaId
Field Value
Type | Description |
---|---|
Int32 |
_currentDatabasetype
Current value, see property Databasetype.
Declaration
protected short _currentDatabasetype
Field Value
Type | Description |
---|---|
Int16 |
_currentDbTag
Current value, see property DbTag.
Declaration
protected string _currentDbTag
Field Value
Type | Description |
---|---|
String |
_currentDefaultMakeReturn
Current value, see property DefaultMakeReturn.
Declaration
protected short _currentDefaultMakeReturn
Field Value
Type | Description |
---|---|
Int16 |
_currentEncryptedComm
Current value, see property EncryptedComm.
Declaration
protected TravelEncryptionChild _currentEncryptedComm
Field Value
Type | Description |
---|---|
TravelEncryptionChild |
_currentGeneratedtime
Current value, see property Generatedtime.
Declaration
protected DateTime _currentGeneratedtime
Field Value
Type | Description |
---|---|
DateTime |
_currentLastPlaybacknumber
Current value, see property LastPlaybacknumber.
Declaration
protected int _currentLastPlaybacknumber
Field Value
Type | Description |
---|---|
Int32 |
_currentLastPlaybacktime
Current value, see property LastPlaybacktime.
Declaration
protected DateTime _currentLastPlaybacktime
Field Value
Type | Description |
---|---|
DateTime |
_currentLastRecordnumber
Current value, see property LastRecordnumber.
Declaration
protected int _currentLastRecordnumber
Field Value
Type | Description |
---|---|
Int32 |
_currentLastRecordtime
Current value, see property LastRecordtime.
Declaration
protected DateTime _currentLastRecordtime
Field Value
Type | Description |
---|---|
DateTime |
_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 |
_currentSystemlevel
Current value, see property Systemlevel.
Declaration
protected short _currentSystemlevel
Field Value
Type | Description |
---|---|
Int16 |
_currentTravelId
Current value, see property TravelId.
Declaration
protected int _currentTravelId
Field Value
Type | Description |
---|---|
Int32 |
_currentTravellerId
Current value, see property TravellerId.
Declaration
protected int _currentTravellerId
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 |
_persistedAreaId
Persisted value, see property AreaId.
Declaration
protected int _persistedAreaId
Field Value
Type | Description |
---|---|
Int32 |
_persistedDatabasetype
Persisted value, see property Databasetype.
Declaration
protected short _persistedDatabasetype
Field Value
Type | Description |
---|---|
Int16 |
_persistedDbTag
Persisted value, see property DbTag.
Declaration
protected string _persistedDbTag
Field Value
Type | Description |
---|---|
String |
_persistedDefaultMakeReturn
Persisted value, see property DefaultMakeReturn.
Declaration
protected short _persistedDefaultMakeReturn
Field Value
Type | Description |
---|---|
Int16 |
_persistedEncryptedComm
Persisted value, see property EncryptedComm.
Declaration
protected TravelEncryptionChild _persistedEncryptedComm
Field Value
Type | Description |
---|---|
TravelEncryptionChild |
_persistedGeneratedtime
Persisted value, see property Generatedtime.
Declaration
protected DateTime _persistedGeneratedtime
Field Value
Type | Description |
---|---|
DateTime |
_persistedLastPlaybacknumber
Persisted value, see property LastPlaybacknumber.
Declaration
protected int _persistedLastPlaybacknumber
Field Value
Type | Description |
---|---|
Int32 |
_persistedLastPlaybacktime
Persisted value, see property LastPlaybacktime.
Declaration
protected DateTime _persistedLastPlaybacktime
Field Value
Type | Description |
---|---|
DateTime |
_persistedLastRecordnumber
Persisted value, see property LastRecordnumber.
Declaration
protected int _persistedLastRecordnumber
Field Value
Type | Description |
---|---|
Int32 |
_persistedLastRecordtime
Persisted value, see property LastRecordtime.
Declaration
protected DateTime _persistedLastRecordtime
Field Value
Type | Description |
---|---|
DateTime |
_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 |
_persistedSystemlevel
Persisted value, see property Systemlevel.
Declaration
protected short _persistedSystemlevel
Field Value
Type | Description |
---|---|
Int16 |
_persistedTravelId
Persisted value, see property TravelId.
Declaration
protected int _persistedTravelId
Field Value
Type | Description |
---|---|
Int32 |
_persistedTravellerId
Persisted value, see property TravellerId.
Declaration
protected int _persistedTravellerId
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
AreaId
.NET type: int. ID of Area this traveller is on
Declaration
public virtual int AreaId { get; set; }
Property Value
Type | Description |
---|---|
Int32 |
Remarks
Original type in dictionary: Id.
Read only for code not signed by SuperOffice.
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
Exceptions
Type | Condition |
---|---|
SecurityException | Thrown if the set method is accessed by code not signed by SuperOffice. |
Databasetype
.NET type: short. The database type he has
Declaration
public virtual short Databasetype { get; set; }
Property Value
Type | Description |
---|---|
Int16 |
Remarks
Original type in dictionary: UShort.
Read only for code not signed by SuperOffice.
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
Exceptions
Type | Condition |
---|---|
SecurityException | Thrown if the set method is accessed by code not signed by SuperOffice. |
DbTag
.NET type: string. Database tag, used for encryption key
Declaration
public virtual string DbTag { get; set; }
Property Value
Type | Description |
---|---|
String |
Remarks
Original type in dictionary: String[40].
Read only for code not signed by SuperOffice.
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
Exceptions
Type | Condition |
---|---|
SecurityException | Thrown if the set method is accessed by code not signed by SuperOffice. |
DefaultMakeReturn
.NET type: short. Default value for the 'make return log' checkbox, based on last answer
Declaration
public virtual short DefaultMakeReturn { get; set; }
Property Value
Type | Description |
---|---|
Int16 |
Remarks
Original type in dictionary: UShort.
Read only for code not signed by SuperOffice.
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
Exceptions
Type | Condition |
---|---|
SecurityException | Thrown if the set method is accessed by code not signed by SuperOffice. |
EncryptedComm
.NET type: TravelEncryptionChild. Use encrypted communication for this traveller: 0 = no, 1 = serial no as key, 2 = target db tag as key (secure but lots of hassle for support)
Declaration
public virtual TravelEncryptionChild EncryptedComm { get; set; }
Property Value
Type | Description |
---|---|
TravelEncryptionChild |
Remarks
Original type in dictionary: Enum.
Read only for code not signed by SuperOffice.
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
Exceptions
Type | Condition |
---|---|
SecurityException | Thrown if the set method is accessed by code not signed by SuperOffice. |
Generatedtime
.NET type: DateTime. Time of exit (local update)
Declaration
public virtual DateTime Generatedtime { get; set; }
Property Value
Type | Description |
---|---|
DateTime |
Remarks
Original type in dictionary: DateTime.
Read only for code not signed by SuperOffice.
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
Exceptions
Type | Condition |
---|---|
SecurityException | Thrown if the set method is accessed by code not signed by SuperOffice. |
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. |
LastPlaybacknumber
.NET type: int. File number of last file receieved from this traveller
Declaration
public virtual int LastPlaybacknumber { get; set; }
Property Value
Type | Description |
---|---|
Int32 |
Remarks
Original type in dictionary: FK.
Read only for code not signed by SuperOffice.
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
Exceptions
Type | Condition |
---|---|
SecurityException | Thrown if the set method is accessed by code not signed by SuperOffice. |
LastPlaybacktime
.NET type: DateTime. Datetime when we last read a file from this traveller
Declaration
public virtual DateTime LastPlaybacktime { get; set; }
Property Value
Type | Description |
---|---|
DateTime |
Remarks
Original type in dictionary: DateTime.
Read only for code not signed by SuperOffice.
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
Exceptions
Type | Condition |
---|---|
SecurityException | Thrown if the set method is accessed by code not signed by SuperOffice. |
LastRecordnumber
.NET type: int. Record ID of last traveltranslog record receieved from this traveller
Declaration
public virtual int LastRecordnumber { get; set; }
Property Value
Type | Description |
---|---|
Int32 |
Remarks
Original type in dictionary: FK.
Read only for code not signed by SuperOffice.
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
Exceptions
Type | Condition |
---|---|
SecurityException | Thrown if the set method is accessed by code not signed by SuperOffice. |
LastRecordtime
.NET type: DateTime. Datestamp from last traveltrans record read from this traveller (async)
Declaration
public virtual DateTime LastRecordtime { get; set; }
Property Value
Type | Description |
---|---|
DateTime |
Remarks
Original type in dictionary: DateTime.
Read only for code not signed by SuperOffice.
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
Exceptions
Type | Condition |
---|---|
SecurityException | Thrown if the set method is accessed by code not signed by SuperOffice. |
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.
Read only for code not signed by SuperOffice.
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
Exceptions
Type | Condition |
---|---|
SecurityException | Thrown if the set method is accessed by code not signed by SuperOffice. |
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.
Read only for code not signed by SuperOffice.
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
Exceptions
Type | Condition |
---|---|
SecurityException | Thrown if the set method is accessed by code not signed by SuperOffice. |
Systemlevel
.NET type: short. level in hierarchy
Declaration
public virtual short Systemlevel { get; set; }
Property Value
Type | Description |
---|---|
Int16 |
Remarks
Original type in dictionary: UShort.
Read only for code not signed by SuperOffice.
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
Exceptions
Type | Condition |
---|---|
SecurityException | Thrown if the set method is accessed by code not signed by SuperOffice. |
TableInfo
Get the TableInfo for the table.
Declaration
public override TableInfo TableInfo { get; }
Property Value
Type | Description |
---|---|
TableInfo | The TableInfo for the table. |
Overrides
TravelId
.NET type: int. Central=0, Departm.=H01000000-H7F000000, Travel=assoc_id
Declaration
public virtual int TravelId { get; set; }
Property Value
Type | Description |
---|---|
Int32 |
Remarks
Original type in dictionary: FK.
Read only for code not signed by SuperOffice.
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
Exceptions
Type | Condition |
---|---|
SecurityException | Thrown if the set method is accessed by code not signed by SuperOffice. |
TravellerId
.NET type: int. Primary key
Declaration
public virtual int TravellerId { 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.
Read only for code not signed by SuperOffice.
This field is not protected by the Sentry system, and can always be read
Exceptions
Type | Condition |
---|---|
SecurityException | Thrown if the set method is accessed by code not signed by SuperOffice. |
TravellerTableInfo
Get the TravellerTableInfo object associated with the row.
Declaration
public TravellerTableInfo TravellerTableInfo { get; }
Property Value
Type | Description |
---|---|
TravellerTableInfo |
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.
Read only for code not signed by SuperOffice.
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
Exceptions
Type | Condition |
---|---|
SecurityException | Thrown if the set method is accessed by code not signed by SuperOffice. |
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.
Read only for code not signed by SuperOffice.
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
Exceptions
Type | Condition |
---|---|
SecurityException | Thrown if the set method is accessed by code not signed by SuperOffice. |
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.
Read only for code not signed by SuperOffice.
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
Exceptions
Type | Condition |
---|---|
SecurityException | Thrown if the set method is accessed by code not signed by SuperOffice. |
Methods
CreateNew()
Create a new instance of the TravellerRow object. Associates traveling out from this database
Declaration
public static TravellerRow CreateNew()
Returns
Type | Description |
---|---|
TravellerRow | A new instance of the TravellerRow object. |
GetFromCustomSearch(TravellerRow.CustomSearch)
Create a new instance of the TravellerRow 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 TravellerRow GetFromCustomSearch(TravellerRow.CustomSearch query)
Parameters
Type | Name | Description |
---|---|---|
TravellerRow.CustomSearch | query | The custom search to execute against the database |
Returns
Type | Description |
---|---|
TravellerRow | A new instance of the TravellerRow object, reflecting the result of the query. |
GetFromIdxTravellerId(Int32)
Create a new instance of the TravellerRow object, by querying the database table via the index 'IDXTrlerId'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static TravellerRow GetFromIdxTravellerId(int travellerId)
Parameters
Type | Name | Description |
---|---|---|
Int32 | travellerId |
Returns
Type | Description |
---|---|
TravellerRow | 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 Traveller table. Non-unique indexes have corresponding inner classes and methods in the TravellerRows collection, since they may return more than one row.
GetFromReader(SoDataReader, TravellerTableInfo)
Create a new instance of the TravellerRow 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. Associates traveling out from this database
Declaration
public static TravellerRow GetFromReader(SoDataReader reader, TravellerTableInfo tableInfo)
Parameters
Type | Name | Description |
---|---|---|
SoDataReader | reader | SoDataReader positioned to a valid database row. |
TravellerTableInfo | tableInfo | TravellerTableInfo 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 |
---|---|
TravellerRow | A new instance of the TravellerRow 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
_onAreaIdChange
Change envent for property AreaId; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onAreaIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
_onDatabasetypeChange
Change envent for property Databasetype; field is of .NET type short.
Declaration
protected event OnFieldChange<short> _onDatabasetypeChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int16> |
_onDbTagChange
Change envent for property DbTag; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onDbTagChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
_onDefaultMakeReturnChange
Change envent for property DefaultMakeReturn; field is of .NET type short.
Declaration
protected event OnFieldChange<short> _onDefaultMakeReturnChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int16> |
_onEncryptedCommChange
Change envent for property EncryptedComm; field is of .NET type short.
Declaration
protected event OnFieldChange<TravelEncryptionChild> _onEncryptedCommChange
Event Type
Type | Description |
---|---|
OnFieldChange<TravelEncryptionChild> |
_onGeneratedtimeChange
Change envent for property Generatedtime; field is of .NET type DateTime.
Declaration
protected event OnFieldChange<DateTime> _onGeneratedtimeChange
Event Type
Type | Description |
---|---|
OnFieldChange<DateTime> |
_onLastPlaybacknumberChange
Change envent for property LastPlaybacknumber; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onLastPlaybacknumberChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
_onLastPlaybacktimeChange
Change envent for property LastPlaybacktime; field is of .NET type DateTime.
Declaration
protected event OnFieldChange<DateTime> _onLastPlaybacktimeChange
Event Type
Type | Description |
---|---|
OnFieldChange<DateTime> |
_onLastRecordnumberChange
Change envent for property LastRecordnumber; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onLastRecordnumberChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
_onLastRecordtimeChange
Change envent for property LastRecordtime; field is of .NET type DateTime.
Declaration
protected event OnFieldChange<DateTime> _onLastRecordtimeChange
Event Type
Type | Description |
---|---|
OnFieldChange<DateTime> |
_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> |
_onSystemlevelChange
Change envent for property Systemlevel; field is of .NET type short.
Declaration
protected event OnFieldChange<short> _onSystemlevelChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int16> |
_onTravelIdChange
Change envent for property TravelId; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onTravelIdChange
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> |
OnAreaIdChange
Event raised when AreaId is changing.
Declaration
public event OnFieldChange<int> OnAreaIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
OnDatabasetypeChange
Event raised when Databasetype is changing.
Declaration
public event OnFieldChange<short> OnDatabasetypeChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int16> |
OnDbTagChange
Event raised when DbTag is changing.
Declaration
public event OnFieldChange<string> OnDbTagChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
OnDefaultMakeReturnChange
Event raised when DefaultMakeReturn is changing.
Declaration
public event OnFieldChange<short> OnDefaultMakeReturnChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int16> |
OnEncryptedCommChange
Event raised when EncryptedComm is changing.
Declaration
public event OnFieldChange<TravelEncryptionChild> OnEncryptedCommChange
Event Type
Type | Description |
---|---|
OnFieldChange<TravelEncryptionChild> |
OnGeneratedtimeChange
Event raised when Generatedtime is changing.
Declaration
public event OnFieldChange<DateTime> OnGeneratedtimeChange
Event Type
Type | Description |
---|---|
OnFieldChange<DateTime> |
OnLastPlaybacknumberChange
Event raised when LastPlaybacknumber is changing.
Declaration
public event OnFieldChange<int> OnLastPlaybacknumberChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
OnLastPlaybacktimeChange
Event raised when LastPlaybacktime is changing.
Declaration
public event OnFieldChange<DateTime> OnLastPlaybacktimeChange
Event Type
Type | Description |
---|---|
OnFieldChange<DateTime> |
OnLastRecordnumberChange
Event raised when LastRecordnumber is changing.
Declaration
public event OnFieldChange<int> OnLastRecordnumberChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
OnLastRecordtimeChange
Event raised when LastRecordtime is changing.
Declaration
public event OnFieldChange<DateTime> OnLastRecordtimeChange
Event Type
Type | Description |
---|---|
OnFieldChange<DateTime> |
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> |
OnSystemlevelChange
Event raised when Systemlevel is changing.
Declaration
public event OnFieldChange<short> OnSystemlevelChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int16> |
OnTravelIdChange
Event raised when TravelId is changing.
Declaration
public event OnFieldChange<int> OnTravelIdChange
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> |