Class TicketLogRow

This table contains log entries for the tickets.
Row Object for table 'ticket_log'. 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
TicketLogRow
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class TicketLogRow : 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) TicketLogRow TicketLogRow.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(TicketLogRow.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 TicketLogTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, TicketLogTableInfo) 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 TicketLogRows collection, which has nested classes and GetFromIdx methods for each non-unique index. Similarly, there is a GetFromReader(SoDataReader, TicketLogTableInfo) method to retrieve the results of queries that return more than one row.

Unique indexes on table TicketLog are:

Index fieldsNested index class name

Constructors

TicketLogRow(TicketLogRow.TicketLogRowIdxBase)

Constructor for the class taking an index as argument. This table contains log entries for the tickets.

Declaration
protected TicketLogRow(TicketLogRow.TicketLogRowIdxBase idx)
Parameters
Type Name Description
TicketLogRow.TicketLogRowIdxBase idx

The index representing a SELECT command to the database.

Fields

_currentLogCode

Current value, see property LogCode.

Declaration
protected short _currentLogCode
Field Value
Type Description
Int16

_currentLogDescription

Current value, see property LogDescription.

Declaration
protected string _currentLogDescription
Field Value
Type Description
String

_currentLogWhatValue2

Current value, see property LogWhatValue2.

Declaration
protected int _currentLogWhatValue2
Field Value
Type Description
Int32

_currentLogWhen

Current value, see property LogWhen.

Declaration
protected DateTime _currentLogWhen
Field Value
Type Description
DateTime

_currentLogWho

Current value, see property LogWho.

Declaration
protected string _currentLogWho
Field Value
Type Description
String

_currentTicketId

Current value, see property TicketId.

Declaration
protected int _currentTicketId
Field Value
Type Description
Int32

_currentTicketLogId

Current value, see property TicketLogId.

Declaration
protected int _currentTicketLogId
Field Value
Type Description
Int32

_persistedLogCode

Persisted value, see property LogCode.

Declaration
protected short _persistedLogCode
Field Value
Type Description
Int16

_persistedLogDescription

Persisted value, see property LogDescription.

Declaration
protected string _persistedLogDescription
Field Value
Type Description
String

_persistedLogWhatValue2

Persisted value, see property LogWhatValue2.

Declaration
protected int _persistedLogWhatValue2
Field Value
Type Description
Int32

_persistedLogWhen

Persisted value, see property LogWhen.

Declaration
protected DateTime _persistedLogWhen
Field Value
Type Description
DateTime

_persistedLogWho

Persisted value, see property LogWho.

Declaration
protected string _persistedLogWho
Field Value
Type Description
String

_persistedTicketId

Persisted value, see property TicketId.

Declaration
protected int _persistedTicketId
Field Value
Type Description
Int32

_persistedTicketLogId

Persisted value, see property TicketLogId.

Declaration
protected int _persistedTicketLogId
Field Value
Type Description
Int32

Properties

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.

LogCode

.NET type: short. An enum indicating what kind of log-entry this is.

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

Original type in dictionary: Enum.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

LogDescription

.NET type: string. A string describing the event (or part of such) to be logged.

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

Original type in dictionary: Clob.

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

LogWhatValue2

.NET type: int. A reference to various tables, depending on the log_code.

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

LogWhen

.NET type: DateTime. When the action occured.

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

LogWho

.NET type: string. The username/alias of the user performing the action.

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

Original type in dictionary: String[256].

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

TableInfo

Get the TableInfo for the table.

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

The TableInfo for the table.
Overrides

TicketId

.NET type: int. The id of the ticket this entry is connected to.

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

TicketLogId

.NET type: int. The primary key (auto-incremented)

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

TicketLogTableInfo

Get the TicketLogTableInfo object associated with the row.

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

Methods

CreateNew()

Create a new instance of the TicketLogRow object. This table contains log entries for the tickets.

Declaration
public static TicketLogRow CreateNew()
Returns
Type Description
TicketLogRow

A new instance of the TicketLogRow object.

GetFromCustomSearch(TicketLogRow.CustomSearch)

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

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

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

GetFromIdxTicketLogId(Int32)

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

Declaration
public static TicketLogRow GetFromIdxTicketLogId(int ticketLogId)
Parameters
Type Name Description
Int32 ticketLogId
Returns
Type Description
TicketLogRow

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

GetFromReader(SoDataReader, TicketLogTableInfo)

Create a new instance of the TicketLogRow 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. This table contains log entries for the tickets.

Declaration
public static TicketLogRow GetFromReader(SoDataReader reader, TicketLogTableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.
TicketLogTableInfo tableInfo

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

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

_onLogCodeChange

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

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

_onLogDescriptionChange

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

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

_onLogWhatValue2Change

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

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

_onLogWhenChange

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

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

_onLogWhoChange

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

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

_onTicketIdChange

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

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

OnLogCodeChange

Event raised when LogCode is changing.

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

OnLogDescriptionChange

Event raised when LogDescription is changing.

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

OnLogWhatValue2Change

Event raised when LogWhatValue2 is changing.

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

OnLogWhenChange

Event raised when LogWhen is changing.

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

OnLogWhoChange

Event raised when LogWho is changing.

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

OnTicketIdChange

Event raised when TicketId is changing.

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

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)