Class NotifyRow

This table contains the pop-up messages displayed for users for various events, such as 'new ticket', etc.
Row Object for table 'notify'. 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
NotifyRow
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class NotifyRow : 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) NotifyRow NotifyRow.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(NotifyRow.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 NotifyTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, NotifyTableInfo) 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 NotifyRows collection, which has nested classes and GetFromIdx methods for each non-unique index. Similarly, there is a GetFromReader(SoDataReader, NotifyTableInfo) method to retrieve the results of queries that return more than one row.

Unique indexes on table Notify are:

Index fieldsNested index class name

Constructors

NotifyRow(NotifyRow.NotifyRowIdxBase)

Constructor for the class taking an index as argument. This table contains the pop-up messages displayed for users for various events, such as 'new ticket', etc.

Declaration
protected NotifyRow(NotifyRow.NotifyRowIdxBase idx)
Parameters
Type Name Description
NotifyRow.NotifyRowIdxBase idx

The index representing a SELECT command to the database.

Fields

_currentCategoryId

Current value, see property CategoryId.

Declaration
protected int _currentCategoryId
Field Value
Type Description
Int32

_currentChatNickName

Current value, see property ChatNickName.

Declaration
protected string _currentChatNickName
Field Value
Type Description
String

_currentChatTopicId

Current value, see property ChatTopicId.

Declaration
protected int _currentChatTopicId
Field Value
Type Description
Int32

_currentCustomMessage

Current value, see property CustomMessage.

Declaration
protected string _currentCustomMessage
Field Value
Type Description
String

_currentExpires

Current value, see property Expires.

Declaration
protected DateTime _currentExpires
Field Value
Type Description
DateTime

_currentNotifyId

Current value, see property NotifyId.

Declaration
protected int _currentNotifyId
Field Value
Type Description
Int32

_currentOwnerId

Current value, see property OwnerId.

Declaration
protected int _currentOwnerId
Field Value
Type Description
Int32

_currentTicketAlertId

Current value, see property TicketAlertId.

Declaration
protected int _currentTicketAlertId
Field Value
Type Description
Int32

_currentTicketId

Current value, see property TicketId.

Declaration
protected int _currentTicketId
Field Value
Type Description
Int32

_currentType

Current value, see property Type.

Declaration
protected int _currentType
Field Value
Type Description
Int32

_currentUser2Id

Current value, see property User2Id.

Declaration
protected int _currentUser2Id
Field Value
Type Description
Int32

_currentUserId

Current value, see property UserId.

Declaration
protected int _currentUserId
Field Value
Type Description
Int32

_persistedCategoryId

Persisted value, see property CategoryId.

Declaration
protected int _persistedCategoryId
Field Value
Type Description
Int32

_persistedChatNickName

Persisted value, see property ChatNickName.

Declaration
protected string _persistedChatNickName
Field Value
Type Description
String

_persistedChatTopicId

Persisted value, see property ChatTopicId.

Declaration
protected int _persistedChatTopicId
Field Value
Type Description
Int32

_persistedCustomMessage

Persisted value, see property CustomMessage.

Declaration
protected string _persistedCustomMessage
Field Value
Type Description
String

_persistedExpires

Persisted value, see property Expires.

Declaration
protected DateTime _persistedExpires
Field Value
Type Description
DateTime

_persistedNotifyId

Persisted value, see property NotifyId.

Declaration
protected int _persistedNotifyId
Field Value
Type Description
Int32

_persistedOwnerId

Persisted value, see property OwnerId.

Declaration
protected int _persistedOwnerId
Field Value
Type Description
Int32

_persistedTicketAlertId

Persisted value, see property TicketAlertId.

Declaration
protected int _persistedTicketAlertId
Field Value
Type Description
Int32

_persistedTicketId

Persisted value, see property TicketId.

Declaration
protected int _persistedTicketId
Field Value
Type Description
Int32

_persistedType

Persisted value, see property Type.

Declaration
protected int _persistedType
Field Value
Type Description
Int32

_persistedUser2Id

Persisted value, see property User2Id.

Declaration
protected int _persistedUser2Id
Field Value
Type Description
Int32

_persistedUserId

Persisted value, see property UserId.

Declaration
protected int _persistedUserId
Field Value
Type Description
Int32

Properties

CategoryId

.NET type: int. The category involed in this notification

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

ChatNickName

.NET type: string. Chat customer nick name in this notification

Declaration
public virtual string ChatNickName { 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

ChatTopicId

.NET type: int. Chat topic involed in this notification

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

CustomMessage

.NET type: string. Text for custom notify messages

Declaration
public virtual string CustomMessage { 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

Expires

.NET type: DateTime. When the notification expires, if it has not yet been displayed.

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

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.

NotifyId

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

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

NotifyTableInfo

Get the NotifyTableInfo object associated with the row.

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

OwnerId

.NET type: int. The id of the user who is the original owner of this notification.

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

TicketAlertId

.NET type: int. Ticket alert used when tickets are escalated

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

TicketId

.NET type: int. The id of the ticket this notification message affects.

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

Type

.NET type: int. A number (enum) indicating the type of the notification.

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

User2Id

.NET type: int. A second user involved in this notification

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

UserId

.NET type: int. The id of the user who should be notified.

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 NotifyRow object. This table contains the pop-up messages displayed for users for various events, such as 'new ticket', etc.

Declaration
public static NotifyRow CreateNew()
Returns
Type Description
NotifyRow

A new instance of the NotifyRow object.

GetFromCustomSearch(NotifyRow.CustomSearch)

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

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

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

GetFromIdxNotifyId(Int32)

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

Declaration
public static NotifyRow GetFromIdxNotifyId(int notifyId)
Parameters
Type Name Description
Int32 notifyId
Returns
Type Description
NotifyRow

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

GetFromReader(SoDataReader, NotifyTableInfo)

Create a new instance of the NotifyRow 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 the pop-up messages displayed for users for various events, such as 'new ticket', etc.

Declaration
public static NotifyRow GetFromReader(SoDataReader reader, NotifyTableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.
NotifyTableInfo tableInfo

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

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

_onCategoryIdChange

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

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

_onChatNickNameChange

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

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

_onChatTopicIdChange

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

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

_onCustomMessageChange

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

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

_onExpiresChange

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

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

_onOwnerIdChange

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

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

_onTicketAlertIdChange

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

Declaration
protected event OnFieldChange<int> _onTicketAlertIdChange
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>

_onTypeChange

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

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

_onUser2IdChange

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

Declaration
protected event OnFieldChange<int> _onUser2IdChange
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>

OnCategoryIdChange

Event raised when CategoryId is changing.

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

OnChatNickNameChange

Event raised when ChatNickName is changing.

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

OnChatTopicIdChange

Event raised when ChatTopicId is changing.

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

OnCustomMessageChange

Event raised when CustomMessage is changing.

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

OnExpiresChange

Event raised when Expires is changing.

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

OnOwnerIdChange

Event raised when OwnerId is changing.

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

OnTicketAlertIdChange

Event raised when TicketAlertId is changing.

Declaration
public event OnFieldChange<int> OnTicketAlertIdChange
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>

OnTypeChange

Event raised when Type is changing.

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

OnUser2IdChange

Event raised when User2Id is changing.

Declaration
public event OnFieldChange<int> OnUser2IdChange
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>

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)