Class TicketLogActionRow
This table contains actions for the tickets.
Row Object for table 'ticket_log_action'. 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 TicketLogActionRow : 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) TicketLogActionRow TicketLogActionRow.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(TicketLogActionRow.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 TicketLogActionTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, TicketLogActionTableInfo) 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 TicketLogAction are:
Index fields | Nested index class name |
---|
Constructors
TicketLogActionRow(TicketLogActionRow.TicketLogActionRowIdxBase)
Constructor for the class taking an index as argument. This table contains actions for the tickets.
Declaration
protected TicketLogActionRow(TicketLogActionRow.TicketLogActionRowIdxBase idx)
Parameters
Type | Name | Description |
---|---|---|
TicketLogActionRow.TicketLogActionRowIdxBase | idx | The index representing a SELECT command to the database. |
Fields
_currentCustomerId
Current value, see property CustomerId.
Declaration
protected int _currentCustomerId
Field Value
Type | Description |
---|---|
Int32 |
_currentDescription
Current value, see property Description.
Declaration
protected string _currentDescription
Field Value
Type | Description |
---|---|
String |
_currentDetails
Current value, see property Details.
Declaration
protected string _currentDetails
Field Value
Type | Description |
---|---|
String |
_currentLogAction
Current value, see property LogAction.
Declaration
protected int _currentLogAction
Field Value
Type | Description |
---|---|
Int32 |
_currentLogWhen
Current value, see property LogWhen.
Declaration
protected DateTime _currentLogWhen
Field Value
Type | Description |
---|---|
DateTime |
_currentMessageId
Current value, see property MessageId.
Declaration
protected int _currentMessageId
Field Value
Type | Description |
---|---|
Int32 |
_currentOrgTicketId
Current value, see property OrgTicketId.
Declaration
protected int _currentOrgTicketId
Field Value
Type | Description |
---|---|
Int32 |
_currentTicketId
Current value, see property TicketId.
Declaration
protected int _currentTicketId
Field Value
Type | Description |
---|---|
Int32 |
_currentTicketLogActionId
Current value, see property TicketLogActionId.
Declaration
protected int _currentTicketLogActionId
Field Value
Type | Description |
---|---|
Int32 |
_currentUserId
Current value, see property UserId.
Declaration
protected int _currentUserId
Field Value
Type | Description |
---|---|
Int32 |
_persistedCustomerId
Persisted value, see property CustomerId.
Declaration
protected int _persistedCustomerId
Field Value
Type | Description |
---|---|
Int32 |
_persistedDescription
Persisted value, see property Description.
Declaration
protected string _persistedDescription
Field Value
Type | Description |
---|---|
String |
_persistedDetails
Persisted value, see property Details.
Declaration
protected string _persistedDetails
Field Value
Type | Description |
---|---|
String |
_persistedLogAction
Persisted value, see property LogAction.
Declaration
protected int _persistedLogAction
Field Value
Type | Description |
---|---|
Int32 |
_persistedLogWhen
Persisted value, see property LogWhen.
Declaration
protected DateTime _persistedLogWhen
Field Value
Type | Description |
---|---|
DateTime |
_persistedMessageId
Persisted value, see property MessageId.
Declaration
protected int _persistedMessageId
Field Value
Type | Description |
---|---|
Int32 |
_persistedOrgTicketId
Persisted value, see property OrgTicketId.
Declaration
protected int _persistedOrgTicketId
Field Value
Type | Description |
---|---|
Int32 |
_persistedTicketId
Persisted value, see property TicketId.
Declaration
protected int _persistedTicketId
Field Value
Type | Description |
---|---|
Int32 |
_persistedTicketLogActionId
Persisted value, see property TicketLogActionId.
Declaration
protected int _persistedTicketLogActionId
Field Value
Type | Description |
---|---|
Int32 |
_persistedUserId
Persisted value, see property UserId.
Declaration
protected int _persistedUserId
Field Value
Type | Description |
---|---|
Int32 |
Properties
CustomerId
.NET type: int. The id of the customer this entry is connected to.
Declaration
public virtual int CustomerId { 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
Description
.NET type: string. Action description, only used by customer actions like ejscript
Declaration
public virtual string Description { 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
Details
.NET type: string. Field for storing details of the log action as e.g. JSON
Declaration
public virtual string Details { 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
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. |
LogAction
.NET type: int. An enum indicating what kind of log-entry this is.
Declaration
public virtual int LogAction { 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
MessageId
.NET type: int. If this entry is connected to a message, then this is a message change log entry.
Declaration
public virtual int MessageId { 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
OrgTicketId
.NET type: int. The id of the orignal ticket this entry was connected to.
Declaration
public virtual int OrgTicketId { 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
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
TicketLogActionId
.NET type: int. The primary key (auto-incremented)
Declaration
public virtual int TicketLogActionId { 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
TicketLogActionTableInfo
Get the TicketLogActionTableInfo object associated with the row.
Declaration
public TicketLogActionTableInfo TicketLogActionTableInfo { get; }
Property Value
Type | Description |
---|---|
TicketLogActionTableInfo |
UserId
.NET type: int. The id of the user this entry is connected to.
Declaration
public virtual int UserId { 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
Methods
CreateNew()
Create a new instance of the TicketLogActionRow object. This table contains actions for the tickets.
Declaration
public static TicketLogActionRow CreateNew()
Returns
Type | Description |
---|---|
TicketLogActionRow | A new instance of the TicketLogActionRow object. |
GetFromCustomSearch(TicketLogActionRow.CustomSearch)
Create a new instance of the TicketLogActionRow 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 TicketLogActionRow GetFromCustomSearch(TicketLogActionRow.CustomSearch query)
Parameters
Type | Name | Description |
---|---|---|
TicketLogActionRow.CustomSearch | query | The custom search to execute against the database |
Returns
Type | Description |
---|---|
TicketLogActionRow | A new instance of the TicketLogActionRow object, reflecting the result of the query. |
GetFromIdxTicketLogActionId(Int32)
Create a new instance of the TicketLogActionRow object, by querying the database table via the index 'IDXTicket_log_actionId'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static TicketLogActionRow GetFromIdxTicketLogActionId(int ticketLogActionId)
Parameters
Type | Name | Description |
---|---|---|
Int32 | ticketLogActionId |
Returns
Type | Description |
---|---|
TicketLogActionRow | 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 TicketLogAction table. Non-unique indexes have corresponding inner classes and methods in the TicketLogActionRows collection, since they may return more than one row.
GetFromReader(SoDataReader, TicketLogActionTableInfo)
Create a new instance of the TicketLogActionRow 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 actions for the tickets.
Declaration
public static TicketLogActionRow GetFromReader(SoDataReader reader, TicketLogActionTableInfo tableInfo)
Parameters
Type | Name | Description |
---|---|---|
SoDataReader | reader | SoDataReader positioned to a valid database row. |
TicketLogActionTableInfo | tableInfo | TicketLogActionTableInfo 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 |
---|---|
TicketLogActionRow | A new instance of the TicketLogActionRow 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
_onCustomerIdChange
Change envent for property CustomerId; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onCustomerIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
_onDescriptionChange
Change envent for property Description; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onDescriptionChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
_onDetailsChange
Change envent for property Details; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onDetailsChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
_onLogActionChange
Change envent for property LogAction; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onLogActionChange
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> |
_onMessageIdChange
Change envent for property MessageId; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onMessageIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
_onOrgTicketIdChange
Change envent for property OrgTicketId; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onOrgTicketIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
_onTicketIdChange
Change envent for property TicketId; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onTicketIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
_onUserIdChange
Change envent for property UserId; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onUserIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
OnCustomerIdChange
Event raised when CustomerId is changing.
Declaration
public event OnFieldChange<int> OnCustomerIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
OnDescriptionChange
Event raised when Description is changing.
Declaration
public event OnFieldChange<string> OnDescriptionChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
OnDetailsChange
Event raised when Details is changing.
Declaration
public event OnFieldChange<string> OnDetailsChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
OnLogActionChange
Event raised when LogAction is changing.
Declaration
public event OnFieldChange<int> OnLogActionChange
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> |
OnMessageIdChange
Event raised when MessageId is changing.
Declaration
public event OnFieldChange<int> OnMessageIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
OnOrgTicketIdChange
Event raised when OrgTicketId is changing.
Declaration
public event OnFieldChange<int> OnOrgTicketIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
OnTicketIdChange
Event raised when TicketId is changing.
Declaration
public event OnFieldChange<int> OnTicketIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
OnUserIdChange
Event raised when UserId is changing.
Declaration
public event OnFieldChange<int> OnUserIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |