Class MessageRows

Definition of a message, corresponding to the header of a protocol Collection of MessageRow. Each element of the collection represents one row in the Message table.

Inheritance
Object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
TableRowsBase
MessageRows
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class MessageRows : TableRowsBase, INestedPersist, IEnumerable<INestedPersist>, ISoCollection, IList, ICollection, IEnumerable, INotifyCollectionChanged, IBindingList
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 MessageRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) MessageRows MessageRows.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(MessageRows.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 MessageRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, MessageTableInfo) 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

Item[Int32]

Get a MessageRow given its index in the collection.

Declaration
public MessageRow this[int index] { get; }
Parameters
Type Name Description
Int32 index

Index of the MessageRow in the collection
Property Value
Type Description
MessageRow

Methods

Add(MessageRow)

Add one MessageRow to the collection.

Declaration
public int Add(MessageRow row)
Parameters
Type Name Description
MessageRow row

An instance of MessageRow to be added to the collection.
Returns
Type Description
Int32

The index of the added MessageRow.

AddNew()

Add a new instance of MessageRow added to the collection.

Declaration
public MessageRow AddNew()
Returns
Type Description
MessageRow

A new instance of MessageRow added to the collection.

AddRange(IEnumerable<MessageRow>)

Add a range of MessageRow to the collection.

Declaration
public MessageRows AddRange(IEnumerable<MessageRow> rows)
Parameters
Type Name Description
IEnumerable<MessageRow> rows
Returns
Type Description
MessageRows

The updated MessageRows collection object.

CreateChild()

Create a new instance of MessageRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of MessageRow
Overrides

CreateNew()

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

Declaration
public static MessageRows CreateNew()
Returns
Type Description
MessageRows

A new instance of the MessageRows object.

Find(Predicate<MessageRow>)

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

Declaration
public MessageRow Find(Predicate<MessageRow> condition)
Parameters
Type Name Description
Predicate<MessageRow> condition
Returns
Type Description
MessageRow

FindAll(Predicate<MessageRow>)

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

Declaration
public MessageRows FindAll(Predicate<MessageRow> condition)
Parameters
Type Name Description
Predicate<MessageRow> condition
Returns
Type Description
MessageRows

ForEach(Action<MessageRow>)

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

Declaration
public void ForEach(Action<MessageRow> whatToDo)
Parameters
Type Name Description
Action<MessageRow> whatToDo

GetFromCustomSearch(MessageRows.CustomSearch)

Create a new instance of the MessageRows 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 MessageRow objects representing each row will be returned.

Declaration
public static MessageRows GetFromCustomSearch(MessageRows.CustomSearch query)
Parameters
Type Name Description
MessageRows.CustomSearch query

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

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

GetFromIdxMotherId(Int32)

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

Declaration
public static MessageRows GetFromIdxMotherId(int motherId)
Parameters
Type Name Description
Int32 motherId
Returns
Type Description
MessageRows

Row object that represents the result of the search. 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 Message table. Non-unique indexes have corresponding inner classes and methods in the MessageRows collection, since they may return more than one row.

GetFromIdxSourceHandler(Int32)

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

Declaration
public static MessageRows GetFromIdxSourceHandler(int sourceHandler)
Parameters
Type Name Description
Int32 sourceHandler
Returns
Type Description
MessageRows

Row object that represents the result of the search. 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 Message table. Non-unique indexes have corresponding inner classes and methods in the MessageRows collection, since they may return more than one row.

GetFromIdxTargetHandler(Int32)

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

Declaration
public static MessageRows GetFromIdxTargetHandler(int targetHandler)
Parameters
Type Name Description
Int32 targetHandler
Returns
Type Description
MessageRows

Row object that represents the result of the search. 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 Message table. Non-unique indexes have corresponding inner classes and methods in the MessageRows collection, since they may return more than one row.

GetFromReader(SoDataReader, MessageTableInfo)

Create a new instance of the MessageRows 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 MessageRow 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 MessageRows GetFromReader(SoDataReader reader, MessageTableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.
MessageTableInfo tableInfo

MessageTableInfo 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
MessageRows

Remove(MessageRow)

Removes the given MessageRow from the collection

Declaration
public void Remove(MessageRow row)
Parameters
Type Name Description
MessageRow row

the MessageRow to be removed

ToArray()

Declaration
public MessageRow[] ToArray()
Returns
Type Description
MessageRow[]

ToString()

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

Declaration
public override string ToString()
Returns
Type Description
String
Overrides

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)