Class OutgoingMessageRow
Delivery of outgoing messages to messageplugins, updated with status asynchroneously
Row Object for table 'outgoing_message'. 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 OutgoingMessageRow : 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) OutgoingMessageRow OutgoingMessageRow.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(OutgoingMessageRow.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 OutgoingMessageTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, OutgoingMessageTableInfo) 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 OutgoingMessage are:
Index fields | Nested index class name |
---|
Constructors
OutgoingMessageRow(OutgoingMessageRow.OutgoingMessageRowIdxBase)
Constructor for the class taking an index as argument. Delivery of outgoing messages to messageplugins, updated with status asynchroneously
Declaration
protected OutgoingMessageRow(OutgoingMessageRow.OutgoingMessageRowIdxBase idx)
Parameters
Type | Name | Description |
---|---|---|
OutgoingMessageRow.OutgoingMessageRowIdxBase | idx | The index representing a SELECT command to the database. |
Fields
_currentExternalMessageId
Current value, see property ExternalMessageId.
Declaration
protected string _currentExternalMessageId
Field Value
Type | Description |
---|---|
System.String |
_currentOutgoingMessageId
Current value, see property OutgoingMessageId.
Declaration
protected int _currentOutgoingMessageId
Field Value
Type | Description |
---|---|
System.Int32 |
_currentPlugin
Current value, see property Plugin.
Declaration
protected string _currentPlugin
Field Value
Type | Description |
---|---|
System.String |
_currentRegistered
Current value, see property Registered.
Declaration
protected DateTime _currentRegistered
Field Value
Type | Description |
---|---|
System.DateTime |
_currentRegisteredAssociateId
Current value, see property RegisteredAssociateId.
Declaration
protected int _currentRegisteredAssociateId
Field Value
Type | Description |
---|---|
System.Int32 |
_currentSessionKey
Current value, see property SessionKey.
Declaration
protected string _currentSessionKey
Field Value
Type | Description |
---|---|
System.String |
_currentStatus
Current value, see property Status.
Declaration
protected int _currentStatus
Field Value
Type | Description |
---|---|
System.Int32 |
_currentStatusDescription
Current value, see property StatusDescription.
Declaration
protected string _currentStatusDescription
Field Value
Type | Description |
---|---|
System.String |
_currentUpdated
Current value, see property Updated.
Declaration
protected DateTime _currentUpdated
Field Value
Type | Description |
---|---|
System.DateTime |
_currentUpdatedAssociateId
Current value, see property UpdatedAssociateId.
Declaration
protected int _currentUpdatedAssociateId
Field Value
Type | Description |
---|---|
System.Int32 |
_persistedExternalMessageId
Persisted value, see property ExternalMessageId.
Declaration
protected string _persistedExternalMessageId
Field Value
Type | Description |
---|---|
System.String |
_persistedOutgoingMessageId
Persisted value, see property OutgoingMessageId.
Declaration
protected int _persistedOutgoingMessageId
Field Value
Type | Description |
---|---|
System.Int32 |
_persistedPlugin
Persisted value, see property Plugin.
Declaration
protected string _persistedPlugin
Field Value
Type | Description |
---|---|
System.String |
_persistedRegistered
Persisted value, see property Registered.
Declaration
protected DateTime _persistedRegistered
Field Value
Type | Description |
---|---|
System.DateTime |
_persistedRegisteredAssociateId
Persisted value, see property RegisteredAssociateId.
Declaration
protected int _persistedRegisteredAssociateId
Field Value
Type | Description |
---|---|
System.Int32 |
_persistedSessionKey
Persisted value, see property SessionKey.
Declaration
protected string _persistedSessionKey
Field Value
Type | Description |
---|---|
System.String |
_persistedStatus
Persisted value, see property Status.
Declaration
protected int _persistedStatus
Field Value
Type | Description |
---|---|
System.Int32 |
_persistedStatusDescription
Persisted value, see property StatusDescription.
Declaration
protected string _persistedStatusDescription
Field Value
Type | Description |
---|---|
System.String |
_persistedUpdated
Persisted value, see property Updated.
Declaration
protected DateTime _persistedUpdated
Field Value
Type | Description |
---|---|
System.DateTime |
_persistedUpdatedAssociateId
Persisted value, see property UpdatedAssociateId.
Declaration
protected int _persistedUpdatedAssociateId
Field Value
Type | Description |
---|---|
System.Int32 |
Properties
ExternalMessageId
.NET type: string. Session key used for threading.
Declaration
public virtual string ExternalMessageId { get; set; }
Property Value
Type | Description |
---|---|
System.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
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 |
---|---|---|
System.String | fieldName | Name of the field in the database |
Property Value
Type | Description |
---|---|
System.Object | Value of the field. |
Overrides
Exceptions
Type | Condition |
---|---|
ArgumentException | Thrown if the field is not known. |
OutgoingMessageId
.NET type: int. The primary key (auto-incremented)
Declaration
public virtual int OutgoingMessageId { get; }
Property Value
Type | Description |
---|---|
System.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
OutgoingMessageTableInfo
Get the OutgoingMessageTableInfo object associated with the row.
Declaration
public OutgoingMessageTableInfo OutgoingMessageTableInfo { get; }
Property Value
Type | Description |
---|---|
OutgoingMessageTableInfo |
Plugin
.NET type: string. Name of plugin
Declaration
public virtual string Plugin { get; set; }
Property Value
Type | Description |
---|---|
System.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
Registered
.NET type: DateTime. Registered when in UTC
Declaration
public virtual DateTime Registered { get; set; }
Property Value
Type | Description |
---|---|
System.DateTime |
Remarks
Original type in dictionary: UtcDateTime.
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
RegisteredAssociateId
.NET type: int. Registered by whom
Declaration
public virtual int RegisteredAssociateId { get; set; }
Property Value
Type | Description |
---|---|
System.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
SessionKey
.NET type: string. Session key used for threading.
Declaration
public virtual string SessionKey { get; set; }
Property Value
Type | Description |
---|---|
System.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
Status
.NET type: int. Current status of outgoing message
Declaration
public virtual int Status { get; set; }
Property Value
Type | Description |
---|---|
System.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
StatusDescription
.NET type: string. Description of current status
Declaration
public virtual string StatusDescription { get; set; }
Property Value
Type | Description |
---|---|
System.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
Updated
.NET type: DateTime. Last updated when in UTC
Declaration
public virtual DateTime Updated { get; set; }
Property Value
Type | Description |
---|---|
System.DateTime |
Remarks
Original type in dictionary: UtcDateTime.
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
UpdatedAssociateId
.NET type: int. Last updated by whom
Declaration
public virtual int UpdatedAssociateId { get; set; }
Property Value
Type | Description |
---|---|
System.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 OutgoingMessageRow object. Delivery of outgoing messages to messageplugins, updated with status asynchroneously
Declaration
public static OutgoingMessageRow CreateNew()
Returns
Type | Description |
---|---|
OutgoingMessageRow | A new instance of the OutgoingMessageRow object. |
GetFromCustomSearch(OutgoingMessageRow.CustomSearch)
Create a new instance of the OutgoingMessageRow 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 OutgoingMessageRow GetFromCustomSearch(OutgoingMessageRow.CustomSearch query)
Parameters
Type | Name | Description |
---|---|---|
OutgoingMessageRow.CustomSearch | query | The custom search to execute against the database |
Returns
Type | Description |
---|---|
OutgoingMessageRow | A new instance of the OutgoingMessageRow object, reflecting the result of the query. |
GetFromIdxOutgoingMessageId(Int32)
Create a new instance of the OutgoingMessageRow object, by querying the database table via the index 'IDXOutgoing_messageId'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static OutgoingMessageRow GetFromIdxOutgoingMessageId(int outgoingMessageId)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | outgoingMessageId |
Returns
Type | Description |
---|---|
OutgoingMessageRow | 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 OutgoingMessage table. Non-unique indexes have corresponding inner classes and methods in the OutgoingMessageRows collection, since they may return more than one row.
GetFromReader(SoDataReader, OutgoingMessageTableInfo)
Create a new instance of the OutgoingMessageRow 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. Delivery of outgoing messages to messageplugins, updated with status asynchroneously
Declaration
public static OutgoingMessageRow GetFromReader(SoDataReader reader, OutgoingMessageTableInfo tableInfo)
Parameters
Type | Name | Description |
---|---|---|
SoDataReader | reader | SoDataReader positioned to a valid database row. |
OutgoingMessageTableInfo | tableInfo | OutgoingMessageTableInfo 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 |
---|---|
OutgoingMessageRow | A new instance of the OutgoingMessageRow 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 |
---|---|
System.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 |
---|---|---|
System.String | fieldName | |
System.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 |
---|---|---|
System.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 |
---|---|
System.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
_onExternalMessageIdChange
Change envent for property ExternalMessageId; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onExternalMessageIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<System.String> |
_onPluginChange
Change envent for property Plugin; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onPluginChange
Event Type
Type | Description |
---|---|
OnFieldChange<System.String> |
_onRegisteredAssociateIdChange
Change envent for property RegisteredAssociateId; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onRegisteredAssociateIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<System.Int32> |
_onRegisteredChange
Change envent for property Registered; field is of .NET type DateTime.
Declaration
protected event OnFieldChange<DateTime> _onRegisteredChange
Event Type
Type | Description |
---|---|
OnFieldChange<System.DateTime> |
_onSessionKeyChange
Change envent for property SessionKey; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onSessionKeyChange
Event Type
Type | Description |
---|---|
OnFieldChange<System.String> |
_onStatusChange
Change envent for property Status; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onStatusChange
Event Type
Type | Description |
---|---|
OnFieldChange<System.Int32> |
_onStatusDescriptionChange
Change envent for property StatusDescription; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onStatusDescriptionChange
Event Type
Type | Description |
---|---|
OnFieldChange<System.String> |
_onUpdatedAssociateIdChange
Change envent for property UpdatedAssociateId; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onUpdatedAssociateIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<System.Int32> |
_onUpdatedChange
Change envent for property Updated; field is of .NET type DateTime.
Declaration
protected event OnFieldChange<DateTime> _onUpdatedChange
Event Type
Type | Description |
---|---|
OnFieldChange<System.DateTime> |
OnExternalMessageIdChange
Event raised when ExternalMessageId is changing.
Declaration
public event OnFieldChange<string> OnExternalMessageIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<System.String> |
OnPluginChange
Event raised when Plugin is changing.
Declaration
public event OnFieldChange<string> OnPluginChange
Event Type
Type | Description |
---|---|
OnFieldChange<System.String> |
OnRegisteredAssociateIdChange
Event raised when RegisteredAssociateId is changing.
Declaration
public event OnFieldChange<int> OnRegisteredAssociateIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<System.Int32> |
OnRegisteredChange
Event raised when Registered is changing.
Declaration
public event OnFieldChange<DateTime> OnRegisteredChange
Event Type
Type | Description |
---|---|
OnFieldChange<System.DateTime> |
OnSessionKeyChange
Event raised when SessionKey is changing.
Declaration
public event OnFieldChange<string> OnSessionKeyChange
Event Type
Type | Description |
---|---|
OnFieldChange<System.String> |
OnStatusChange
Event raised when Status is changing.
Declaration
public event OnFieldChange<int> OnStatusChange
Event Type
Type | Description |
---|---|
OnFieldChange<System.Int32> |
OnStatusDescriptionChange
Event raised when StatusDescription is changing.
Declaration
public event OnFieldChange<string> OnStatusDescriptionChange
Event Type
Type | Description |
---|---|
OnFieldChange<System.String> |
OnUpdatedAssociateIdChange
Event raised when UpdatedAssociateId is changing.
Declaration
public event OnFieldChange<int> OnUpdatedAssociateIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<System.Int32> |
OnUpdatedChange
Event raised when Updated is changing.
Declaration
public event OnFieldChange<DateTime> OnUpdatedChange
Event Type
Type | Description |
---|---|
OnFieldChange<System.DateTime> |