Class ScriptTraceRunRow
Traces of executed scripts
Row Object for table 'script_trace_run'. 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 ScriptTraceRunRow : 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) ScriptTraceRunRow ScriptTraceRunRow.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(ScriptTraceRunRow.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 ScriptTraceRunTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, ScriptTraceRunTableInfo) 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 ScriptTraceRun are:
Index fields | Nested index class name |
---|
Constructors
ScriptTraceRunRow(ScriptTraceRunRow.ScriptTraceRunRowIdxBase)
Constructor for the class taking an index as argument. Traces of executed scripts
Declaration
protected ScriptTraceRunRow(ScriptTraceRunRow.ScriptTraceRunRowIdxBase idx)
Parameters
Type | Name | Description |
---|---|---|
ScriptTraceRunRow.ScriptTraceRunRowIdxBase | idx | The index representing a SELECT command to the database. |
Fields
_currentAssociateId
Current value, see property AssociateId.
Declaration
protected int _currentAssociateId
Field Value
Type | Description |
---|---|
Int32 |
_currentEndedAt
Current value, see property EndedAt.
Declaration
protected DateTime _currentEndedAt
Field Value
Type | Description |
---|---|
DateTime |
_currentExecutionTime
Current value, see property ExecutionTime.
Declaration
protected int _currentExecutionTime
Field Value
Type | Description |
---|---|
Int32 |
_currentFileSize
Current value, see property FileSize.
Declaration
protected int _currentFileSize
Field Value
Type | Description |
---|---|
Int32 |
_currentNumFrames
Current value, see property NumFrames.
Declaration
protected int _currentNumFrames
Field Value
Type | Description |
---|---|
Int32 |
_currentPeakMemory
Current value, see property PeakMemory.
Declaration
protected int _currentPeakMemory
Field Value
Type | Description |
---|---|
Int32 |
_currentScriptTraceId
Current value, see property ScriptTraceId.
Declaration
protected int _currentScriptTraceId
Field Value
Type | Description |
---|---|
Int32 |
_currentScriptTraceRunId
Current value, see property ScriptTraceRunId.
Declaration
protected int _currentScriptTraceRunId
Field Value
Type | Description |
---|---|
Int32 |
_currentStartedAt
Current value, see property StartedAt.
Declaration
protected DateTime _currentStartedAt
Field Value
Type | Description |
---|---|
DateTime |
_currentStatus
Current value, see property Status.
Declaration
protected string _currentStatus
Field Value
Type | Description |
---|---|
String |
_currentUserExecutionTime
Current value, see property UserExecutionTime.
Declaration
protected int _currentUserExecutionTime
Field Value
Type | Description |
---|---|
Int32 |
_persistedAssociateId
Persisted value, see property AssociateId.
Declaration
protected int _persistedAssociateId
Field Value
Type | Description |
---|---|
Int32 |
_persistedEndedAt
Persisted value, see property EndedAt.
Declaration
protected DateTime _persistedEndedAt
Field Value
Type | Description |
---|---|
DateTime |
_persistedExecutionTime
Persisted value, see property ExecutionTime.
Declaration
protected int _persistedExecutionTime
Field Value
Type | Description |
---|---|
Int32 |
_persistedFileSize
Persisted value, see property FileSize.
Declaration
protected int _persistedFileSize
Field Value
Type | Description |
---|---|
Int32 |
_persistedNumFrames
Persisted value, see property NumFrames.
Declaration
protected int _persistedNumFrames
Field Value
Type | Description |
---|---|
Int32 |
_persistedPeakMemory
Persisted value, see property PeakMemory.
Declaration
protected int _persistedPeakMemory
Field Value
Type | Description |
---|---|
Int32 |
_persistedScriptTraceId
Persisted value, see property ScriptTraceId.
Declaration
protected int _persistedScriptTraceId
Field Value
Type | Description |
---|---|
Int32 |
_persistedScriptTraceRunId
Persisted value, see property ScriptTraceRunId.
Declaration
protected int _persistedScriptTraceRunId
Field Value
Type | Description |
---|---|
Int32 |
_persistedStartedAt
Persisted value, see property StartedAt.
Declaration
protected DateTime _persistedStartedAt
Field Value
Type | Description |
---|---|
DateTime |
_persistedStatus
Persisted value, see property Status.
Declaration
protected string _persistedStatus
Field Value
Type | Description |
---|---|
String |
_persistedUserExecutionTime
Persisted value, see property UserExecutionTime.
Declaration
protected int _persistedUserExecutionTime
Field Value
Type | Description |
---|---|
Int32 |
Properties
AssociateId
.NET type: int. Associate who the script was executed as
Declaration
public virtual int AssociateId { 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
EndedAt
.NET type: DateTime. When the trace was ended
Declaration
public virtual DateTime EndedAt { 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
ExecutionTime
.NET type: int. Real seconds spent executing
Declaration
public virtual int ExecutionTime { 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
FileSize
.NET type: int. The size of the trace file
Declaration
public virtual int FileSize { 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
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. |
NumFrames
.NET type: int. The number of frames saved
Declaration
public virtual int NumFrames { 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
PeakMemory
.NET type: int. The maximum amount of used memory during execution (in kB)
Declaration
public virtual int PeakMemory { 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
ScriptTraceId
.NET type: int. Id of parent script_trace record
Declaration
public virtual int ScriptTraceId { 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
ScriptTraceRunId
.NET type: int. Primary key
Declaration
public virtual int ScriptTraceRunId { 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
ScriptTraceRunTableInfo
Get the ScriptTraceRunTableInfo object associated with the row.
Declaration
public ScriptTraceRunTableInfo ScriptTraceRunTableInfo { get; }
Property Value
Type | Description |
---|---|
ScriptTraceRunTableInfo |
StartedAt
.NET type: DateTime. When the trace was started
Declaration
public virtual DateTime StartedAt { 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
Status
.NET type: string. The status of the script, or exception if it fails
Declaration
public virtual string Status { get; set; }
Property Value
Type | Description |
---|---|
String |
Remarks
Original type in dictionary: String[2048].
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
UserExecutionTime
.NET type: int. CPU seconds spent executing
Declaration
public virtual int UserExecutionTime { 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
Methods
CreateNew()
Create a new instance of the ScriptTraceRunRow object. Traces of executed scripts
Declaration
public static ScriptTraceRunRow CreateNew()
Returns
Type | Description |
---|---|
ScriptTraceRunRow | A new instance of the ScriptTraceRunRow object. |
GetFromCustomSearch(ScriptTraceRunRow.CustomSearch)
Create a new instance of the ScriptTraceRunRow 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 ScriptTraceRunRow GetFromCustomSearch(ScriptTraceRunRow.CustomSearch query)
Parameters
Type | Name | Description |
---|---|---|
ScriptTraceRunRow.CustomSearch | query | The custom search to execute against the database |
Returns
Type | Description |
---|---|
ScriptTraceRunRow | A new instance of the ScriptTraceRunRow object, reflecting the result of the query. |
GetFromIdxScriptTraceRunId(Int32)
Create a new instance of the ScriptTraceRunRow object, by querying the database table via the index 'IDXScript_trace_runId'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static ScriptTraceRunRow GetFromIdxScriptTraceRunId(int scriptTraceRunId)
Parameters
Type | Name | Description |
---|---|---|
Int32 | scriptTraceRunId |
Returns
Type | Description |
---|---|
ScriptTraceRunRow | 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 ScriptTraceRun table. Non-unique indexes have corresponding inner classes and methods in the ScriptTraceRunRows collection, since they may return more than one row.
GetFromReader(SoDataReader, ScriptTraceRunTableInfo)
Create a new instance of the ScriptTraceRunRow 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. Traces of executed scripts
Declaration
public static ScriptTraceRunRow GetFromReader(SoDataReader reader, ScriptTraceRunTableInfo tableInfo)
Parameters
Type | Name | Description |
---|---|---|
SoDataReader | reader | SoDataReader positioned to a valid database row. |
ScriptTraceRunTableInfo | tableInfo | ScriptTraceRunTableInfo 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 |
---|---|
ScriptTraceRunRow | A new instance of the ScriptTraceRunRow 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
_onAssociateIdChange
Change envent for property AssociateId; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onAssociateIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
_onEndedAtChange
Change envent for property EndedAt; field is of .NET type DateTime.
Declaration
protected event OnFieldChange<DateTime> _onEndedAtChange
Event Type
Type | Description |
---|---|
OnFieldChange<DateTime> |
_onExecutionTimeChange
Change envent for property ExecutionTime; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onExecutionTimeChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
_onFileSizeChange
Change envent for property FileSize; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onFileSizeChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
_onNumFramesChange
Change envent for property NumFrames; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onNumFramesChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
_onPeakMemoryChange
Change envent for property PeakMemory; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onPeakMemoryChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
_onScriptTraceIdChange
Change envent for property ScriptTraceId; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onScriptTraceIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
_onStartedAtChange
Change envent for property StartedAt; field is of .NET type DateTime.
Declaration
protected event OnFieldChange<DateTime> _onStartedAtChange
Event Type
Type | Description |
---|---|
OnFieldChange<DateTime> |
_onStatusChange
Change envent for property Status; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onStatusChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
_onUserExecutionTimeChange
Change envent for property UserExecutionTime; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onUserExecutionTimeChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
OnAssociateIdChange
Event raised when AssociateId is changing.
Declaration
public event OnFieldChange<int> OnAssociateIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
OnEndedAtChange
Event raised when EndedAt is changing.
Declaration
public event OnFieldChange<DateTime> OnEndedAtChange
Event Type
Type | Description |
---|---|
OnFieldChange<DateTime> |
OnExecutionTimeChange
Event raised when ExecutionTime is changing.
Declaration
public event OnFieldChange<int> OnExecutionTimeChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
OnFileSizeChange
Event raised when FileSize is changing.
Declaration
public event OnFieldChange<int> OnFileSizeChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
OnNumFramesChange
Event raised when NumFrames is changing.
Declaration
public event OnFieldChange<int> OnNumFramesChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
OnPeakMemoryChange
Event raised when PeakMemory is changing.
Declaration
public event OnFieldChange<int> OnPeakMemoryChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
OnScriptTraceIdChange
Event raised when ScriptTraceId is changing.
Declaration
public event OnFieldChange<int> OnScriptTraceIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
OnStartedAtChange
Event raised when StartedAt is changing.
Declaration
public event OnFieldChange<DateTime> OnStartedAtChange
Event Type
Type | Description |
---|---|
OnFieldChange<DateTime> |
OnStatusChange
Event raised when Status is changing.
Declaration
public event OnFieldChange<string> OnStatusChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
OnUserExecutionTimeChange
Event raised when UserExecutionTime is changing.
Declaration
public event OnFieldChange<int> OnUserExecutionTimeChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |