Class MessageHandlerRows

Presence and heartbeat of a message handler, should be updated once a minute. Older records are stale Collection of MessageHandlerRow. Each element of the collection represents one row in the MessageHandler table.

Inheritance

object

NestedPersist

NestedPersistFacade

NestedCollectionPersist

TableRowsBase

MessageHandlerRows

Implements

INestedPersist

IEnumerable<INestedPersist>

ISoCollection

INotifyCollectionChanged

IBindingList

IList

ICollection

IEnumerable

Inherited Members

TableRowsBase._innerList

TableRowsBase._allHasBeenMarkedForDelete

TableRowsBase._sentries

TableRowsBase._idx

TableRowsBase.OnIndexChanged(IdxBase)

TableRowsBase.Load(IdxBase)

TableRowsBase.RowsLoad()

TableRowsBase.RowsLoad(ITableRowLoadHandlerFactory)

TableRowsBase.Delete()

TableRowsBase.GetEnumerator()

TableRowsBase.Add(TableRowBase)

TableRowsBase.Remove(TableRowBase)

TableRowsBase.Clear()

TableRowsBase.Sort(IComparer)

TableRowsBase.GetPrimaryKeys()

TableRowsBase.OnAdded(object, int)

TableRowsBase.CopyTo(Array, int)

TableRowsBase.IndexOf(object)

TableRowsBase.Contains(object)

TableRowsBase.AddIndex(PropertyDescriptor)

TableRowsBase.ApplySort(PropertyDescriptor, ListSortDirection)

TableRowsBase.Find(PropertyDescriptor, object)

TableRowsBase.RemoveIndex(PropertyDescriptor)

TableRowsBase.RemoveSort()

TableRowsBase.Sentries

TableRowsBase.IsDirty

TableRowsBase.Index

TableRowsBase.Count

TableRowsBase.IsMarkedForDelete

TableRowsBase.IsFixedSize

TableRowsBase.IsReadOnly

TableRowsBase.AllowEdit

TableRowsBase.AllowNew

TableRowsBase.AllowRemove

TableRowsBase.IsSorted

TableRowsBase.SortDirection

TableRowsBase.SortProperty

TableRowsBase.SupportsChangeNotification

TableRowsBase.SupportsSearching

TableRowsBase.SupportsSorting

TableRowsBase._onCollectionChanged

TableRowsBase.CollectionChanged

TableRowsBase.ListChanged

NestedCollectionPersist.GetFacadingItems()

NestedCollectionPersist.IsDeleted

NestedPersistFacade.OnPreIdUpdate()

NestedPersistFacade.OnPrimaryKeyRequest(PKContainer)

NestedPersistFacade.OnPrimaryKeyUpdate(PKContainer)

NestedPersistFacade.OnIdUpdate()

NestedPersistFacade.OnSave(BatchSave)

NestedPersistFacade.OnSaved(bool)

NestedPersist._saveOwner

NestedPersist._isSaving

NestedPersist.SetSaveOwner(INestedPersist)

NestedPersist.Save()

NestedPersist.IsSaving

NestedPersist.OnElementSaved

NestedPersist.OnElementIdUpdate

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: SuperOffice.CRM.Rows

Assembly: SoDataBase.dll

Syntax

public class MessageHandlerRows : TableRowsBase, INestedPersist, IEnumerable<INestedPersist>, ISoCollection, INotifyCollectionChanged, IBindingList, IList, ICollection, IEnumerable

Remarks

Row collections can be created in several ways.

• Use the static CreateNew() method to create a new, empty collection. You can then add objects of type MessageHandlerRow to it, and use methods like Save to operate on the whole collection.
• You can create a (nested) MessageHandlerRows MessageHandlerRows.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(CustomSearch) method to apply the query to the database and obtain the result as a Rows object, with one item for each table row that matched your query.
• For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.

Unique indexes are handled through the MessageHandlerRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, MessageHandlerTableInfo) method to retrieve the results of queries that return more than one row (this method will iterate over the reader to fetch ALL results, so beware of fetching huge result sets).

Properties

this[int]

Get a MessageHandlerRow given its index in the collection.

Declaration

public MessageHandlerRow this[int index] { get; }

Parameters

Type	Name	Description
int	index	Index of the MessageHandlerRow in the collection

Property Value

Type	Description
MessageHandlerRow

Remarks

Row collections can be created in several ways.

• Use the static CreateNew() method to create a new, empty collection. You can then add objects of type MessageHandlerRow to it, and use methods like Save to operate on the whole collection.
• You can create a (nested) MessageHandlerRows MessageHandlerRows.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(CustomSearch) method to apply the query to the database and obtain the result as a Rows object, with one item for each table row that matched your query.
• For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.

Unique indexes are handled through the MessageHandlerRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, MessageHandlerTableInfo) method to retrieve the results of queries that return more than one row (this method will iterate over the reader to fetch ALL results, so beware of fetching huge result sets).

Methods

Add(MessageHandlerRow)

Add one MessageHandlerRow to the collection.

Declaration

public int Add(MessageHandlerRow row)

Parameters

Type	Name	Description
MessageHandlerRow	row	An instance of MessageHandlerRow to be added to the collection.

Returns

Type	Description
int	The index of the added MessageHandlerRow.

Remarks

Row collections can be created in several ways.

• Use the static CreateNew() method to create a new, empty collection. You can then add objects of type MessageHandlerRow to it, and use methods like Save to operate on the whole collection.
• You can create a (nested) MessageHandlerRows MessageHandlerRows.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(CustomSearch) method to apply the query to the database and obtain the result as a Rows object, with one item for each table row that matched your query.
• For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.

Unique indexes are handled through the MessageHandlerRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, MessageHandlerTableInfo) method to retrieve the results of queries that return more than one row (this method will iterate over the reader to fetch ALL results, so beware of fetching huge result sets).

AddNew()

Add a new instance of MessageHandlerRow added to the collection.

Declaration

public MessageHandlerRow AddNew()

Returns

Type	Description
MessageHandlerRow	A new instance of MessageHandlerRow added to the collection.

Remarks

Row collections can be created in several ways.

• Use the static CreateNew() method to create a new, empty collection. You can then add objects of type MessageHandlerRow to it, and use methods like Save to operate on the whole collection.
• You can create a (nested) MessageHandlerRows MessageHandlerRows.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(CustomSearch) method to apply the query to the database and obtain the result as a Rows object, with one item for each table row that matched your query.
• For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.

Unique indexes are handled through the MessageHandlerRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, MessageHandlerTableInfo) method to retrieve the results of queries that return more than one row (this method will iterate over the reader to fetch ALL results, so beware of fetching huge result sets).

AddRange(IEnumerable<MessageHandlerRow>)

Add a range of MessageHandlerRow to the collection.

Declaration

public MessageHandlerRows AddRange(IEnumerable<MessageHandlerRow> rows)

Parameters

Type	Name	Description
IEnumerable<MessageHandlerRow>	rows

Returns

Type	Description
MessageHandlerRows	The updated MessageHandlerRows collection object.

Remarks

Row collections can be created in several ways.

• Use the static CreateNew() method to create a new, empty collection. You can then add objects of type MessageHandlerRow to it, and use methods like Save to operate on the whole collection.
• You can create a (nested) MessageHandlerRows MessageHandlerRows.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(CustomSearch) method to apply the query to the database and obtain the result as a Rows object, with one item for each table row that matched your query.
• For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.

Unique indexes are handled through the MessageHandlerRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, MessageHandlerTableInfo) method to retrieve the results of queries that return more than one row (this method will iterate over the reader to fetch ALL results, so beware of fetching huge result sets).

CreateChild()

Create a new instance of MessageHandlerRow

Declaration

protected override TableRowBase CreateChild()

Returns

Type	Description
TableRowBase	New instance of MessageHandlerRow

Overrides

TableRowsBase.CreateChild()

Remarks

Row collections can be created in several ways.

• Use the static CreateNew() method to create a new, empty collection. You can then add objects of type MessageHandlerRow to it, and use methods like Save to operate on the whole collection.
• You can create a (nested) MessageHandlerRows MessageHandlerRows.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(CustomSearch) method to apply the query to the database and obtain the result as a Rows object, with one item for each table row that matched your query.
• For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.

Unique indexes are handled through the MessageHandlerRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, MessageHandlerTableInfo) method to retrieve the results of queries that return more than one row (this method will iterate over the reader to fetch ALL results, so beware of fetching huge result sets).

CreateNew()

Create a new instance of the MessageHandlerRows object. This collection will contain no rows.

Declaration

public static MessageHandlerRows CreateNew()

Returns

Type	Description
MessageHandlerRows	A new instance of the MessageHandlerRows object.

Remarks

Row collections can be created in several ways.

• Use the static CreateNew() method to create a new, empty collection. You can then add objects of type MessageHandlerRow to it, and use methods like Save to operate on the whole collection.
• You can create a (nested) MessageHandlerRows MessageHandlerRows.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(CustomSearch) method to apply the query to the database and obtain the result as a Rows object, with one item for each table row that matched your query.
• For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.

Unique indexes are handled through the MessageHandlerRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, MessageHandlerTableInfo) method to retrieve the results of queries that return more than one row (this method will iterate over the reader to fetch ALL results, so beware of fetching huge result sets).

Find(Predicate<MessageHandlerRow>)

Apply the predicate to each element of the collection and return the first row that matches; if no match then return null

Declaration

public MessageHandlerRow Find(Predicate<MessageHandlerRow> condition)

Parameters

Type	Name	Description
Predicate<MessageHandlerRow>	condition

Returns

Type	Description
MessageHandlerRow

Remarks

Row collections can be created in several ways.

• Use the static CreateNew() method to create a new, empty collection. You can then add objects of type MessageHandlerRow to it, and use methods like Save to operate on the whole collection.
• You can create a (nested) MessageHandlerRows MessageHandlerRows.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(CustomSearch) method to apply the query to the database and obtain the result as a Rows object, with one item for each table row that matched your query.
• For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.

Unique indexes are handled through the MessageHandlerRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, MessageHandlerTableInfo) method to retrieve the results of queries that return more than one row (this method will iterate over the reader to fetch ALL results, so beware of fetching huge result sets).

FindAll(Predicate<MessageHandlerRow>)

Return a new collection that contains only those elements that match the condition. Elements are shared, not clones! of the original collection

Declaration

public MessageHandlerRows FindAll(Predicate<MessageHandlerRow> condition)

Parameters

Type	Name	Description
Predicate<MessageHandlerRow>	condition

Returns

Type	Description
MessageHandlerRows

Remarks

Row collections can be created in several ways.

• Use the static CreateNew() method to create a new, empty collection. You can then add objects of type MessageHandlerRow to it, and use methods like Save to operate on the whole collection.
• You can create a (nested) MessageHandlerRows MessageHandlerRows.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(CustomSearch) method to apply the query to the database and obtain the result as a Rows object, with one item for each table row that matched your query.
• For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.

Unique indexes are handled through the MessageHandlerRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, MessageHandlerTableInfo) method to retrieve the results of queries that return more than one row (this method will iterate over the reader to fetch ALL results, so beware of fetching huge result sets).

ForEach(Action<MessageHandlerRow>)

Method that iterates over all members and applies the action parameter to each of them

Declaration

public void ForEach(Action<MessageHandlerRow> whatToDo)

Parameters

Type	Name	Description
Action<MessageHandlerRow>	whatToDo

Remarks

Row collections can be created in several ways.

• Use the static CreateNew() method to create a new, empty collection. You can then add objects of type MessageHandlerRow to it, and use methods like Save to operate on the whole collection.
• You can create a (nested) MessageHandlerRows MessageHandlerRows.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(CustomSearch) method to apply the query to the database and obtain the result as a Rows object, with one item for each table row that matched your query.
• For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.

Unique indexes are handled through the MessageHandlerRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, MessageHandlerTableInfo) method to retrieve the results of queries that return more than one row (this method will iterate over the reader to fetch ALL results, so beware of fetching huge result sets).

GetFromCustomSearch(CustomSearch)

Create a new instance of the MessageHandlerRows object, and populate it with data from a custom search. If the search returns no results, an empty collection will be returned; if the result contains rows, a collection of MessageHandlerRow objects representing each row will be returned.

Declaration

public static MessageHandlerRows GetFromCustomSearch(MessageHandlerRows.CustomSearch query)

Parameters

Type	Name	Description
MessageHandlerRows.CustomSearch	query	The custom search to execute against the database

Returns

Type	Description
MessageHandlerRows	A new instance of the MessageHandlerRows object, reflecting the result of the query.

Remarks

Row collections can be created in several ways.

• Use the static CreateNew() method to create a new, empty collection. You can then add objects of type MessageHandlerRow to it, and use methods like Save to operate on the whole collection.
• You can create a (nested) MessageHandlerRows MessageHandlerRows.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(CustomSearch) method to apply the query to the database and obtain the result as a Rows object, with one item for each table row that matched your query.
• For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.

Unique indexes are handled through the MessageHandlerRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, MessageHandlerTableInfo) method to retrieve the results of queries that return more than one row (this method will iterate over the reader to fetch ALL results, so beware of fetching huge result sets).

GetFromIdxMachine(string)

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

Declaration

public static MessageHandlerRows GetFromIdxMachine(string machine)

Parameters

Type	Name	Description
string	machine

Returns

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

GetFromReader(SoDataReader, MessageHandlerTableInfo)

Create a new instance of the MessageHandlerRows object, and populate it with data from a reader. If the search returns no results, an empty collection will be returned; if the result contains rows, a collection of MessageHandlerRow objects representing each row will be returned.

Note that the internal logic starts by calling reader.Read(), which is correct if you hand the method the result of an ExecuteReader(), but if the reader has already been advanced one or more rows, the current row will be skipped and collection population will start with the next row.

Declaration

public static MessageHandlerRows GetFromReader(SoDataReader reader, MessageHandlerTableInfo tableInfo)

Parameters

Type	Name	Description
SoDataReader	reader	SoDataReader positioned to a valid database row.
MessageHandlerTableInfo	tableInfo	MessageHandlerTableInfo 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
MessageHandlerRows

Remarks

Row collections can be created in several ways.

• Use the static CreateNew() method to create a new, empty collection. You can then add objects of type MessageHandlerRow to it, and use methods like Save to operate on the whole collection.
• You can create a (nested) MessageHandlerRows MessageHandlerRows.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(CustomSearch) method to apply the query to the database and obtain the result as a Rows object, with one item for each table row that matched your query.
• For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.

Unique indexes are handled through the MessageHandlerRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, MessageHandlerTableInfo) method to retrieve the results of queries that return more than one row (this method will iterate over the reader to fetch ALL results, so beware of fetching huge result sets).

Remove(MessageHandlerRow)

Removes the given MessageHandlerRow from the collection

Declaration

public void Remove(MessageHandlerRow row)

Parameters

Type	Name	Description
MessageHandlerRow	row	the MessageHandlerRow to be removed

Remarks

Row collections can be created in several ways.

• Use the static CreateNew() method to create a new, empty collection. You can then add objects of type MessageHandlerRow to it, and use methods like Save to operate on the whole collection.
• You can create a (nested) MessageHandlerRows MessageHandlerRows.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(CustomSearch) method to apply the query to the database and obtain the result as a Rows object, with one item for each table row that matched your query.
• For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.

Unique indexes are handled through the MessageHandlerRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, MessageHandlerTableInfo) method to retrieve the results of queries that return more than one row (this method will iterate over the reader to fetch ALL results, so beware of fetching huge result sets).

ToArray()

Presence and heartbeat of a message handler, should be updated once a minute. Older records are stale Collection of MessageHandlerRow. Each element of the collection represents one row in the MessageHandler table.

Declaration

public MessageHandlerRow[] ToArray()

Returns

Type	Description
MessageHandlerRow[]

Remarks

Row collections can be created in several ways.

• Use the static CreateNew() method to create a new, empty collection. You can then add objects of type MessageHandlerRow to it, and use methods like Save to operate on the whole collection.
• You can create a (nested) MessageHandlerRows MessageHandlerRows.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(CustomSearch) method to apply the query to the database and obtain the result as a Rows object, with one item for each table row that matched your query.
• For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.

Unique indexes are handled through the MessageHandlerRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, MessageHandlerTableInfo) method to retrieve the results of queries that return more than one row (this method will iterate over the reader to fetch ALL results, so beware of fetching huge result sets).

ToString()

For debugging: Number of members, and the first (up to) 5 items

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

object.ToString()

Remarks

Row collections can be created in several ways.

• Use the static CreateNew() method to create a new, empty collection. You can then add objects of type MessageHandlerRow to it, and use methods like Save to operate on the whole collection.
• You can create a (nested) MessageHandlerRows MessageHandlerRows.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(CustomSearch) method to apply the query to the database and obtain the result as a Rows object, with one item for each table row that matched your query.
• For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.

Unique indexes are handled through the MessageHandlerRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, MessageHandlerTableInfo) method to retrieve the results of queries that return more than one row (this method will iterate over the reader to fetch ALL results, so beware of fetching huge result sets).

Implements

INestedPersist

IEnumerable<T>

ISoCollection

INotifyCollectionChanged

IBindingList

System.Collections.IList

ICollection

IEnumerable

Extension Methods

EnumUtil.MapEnums<From, To>(From)

Converters.MapEnums<From, To>(From)