Class MessageCustomersRows

This table contains all cutomers who are involved in a message Collection of MessageCustomersRow. Each element of the collection represents one row in the MessageCustomers table.

Inheritance
Object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
TableRowsBase
MessageCustomersRows
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class MessageCustomersRows : 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 MessageCustomersRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) MessageCustomersRows MessageCustomersRows.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(MessageCustomersRows.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 MessageCustomersRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, MessageCustomersTableInfo) 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 MessageCustomersRow given its index in the collection.

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

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

Methods

Add(MessageCustomersRow)

Add one MessageCustomersRow to the collection.

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

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

The index of the added MessageCustomersRow.

AddNew()

Add a new instance of MessageCustomersRow added to the collection.

Declaration
public MessageCustomersRow AddNew()
Returns
Type Description
MessageCustomersRow

A new instance of MessageCustomersRow added to the collection.

AddRange(IEnumerable<MessageCustomersRow>)

Add a range of MessageCustomersRow to the collection.

Declaration
public MessageCustomersRows AddRange(IEnumerable<MessageCustomersRow> rows)
Parameters
Type Name Description
IEnumerable<MessageCustomersRow> rows
Returns
Type Description
MessageCustomersRows

The updated MessageCustomersRows collection object.

CreateChild()

Create a new instance of MessageCustomersRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of MessageCustomersRow
Overrides

CreateNew()

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

Declaration
public static MessageCustomersRows CreateNew()
Returns
Type Description
MessageCustomersRows

A new instance of the MessageCustomersRows object.

Find(Predicate<MessageCustomersRow>)

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

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

FindAll(Predicate<MessageCustomersRow>)

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

Declaration
public MessageCustomersRows FindAll(Predicate<MessageCustomersRow> condition)
Parameters
Type Name Description
Predicate<MessageCustomersRow> condition
Returns
Type Description
MessageCustomersRows

ForEach(Action<MessageCustomersRow>)

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

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

GetFromCustomSearch(MessageCustomersRows.CustomSearch)

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

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

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

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

GetFromIdxCustomerId(Int32)

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

Declaration
public static MessageCustomersRows GetFromIdxCustomerId(int customerId)
Parameters
Type Name Description
Int32 customerId
Returns
Type Description
MessageCustomersRows

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

GetFromIdxMessageId(Int32)

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

Declaration
public static MessageCustomersRows GetFromIdxMessageId(int messageId)
Parameters
Type Name Description
Int32 messageId
Returns
Type Description
MessageCustomersRows

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

GetFromReader(SoDataReader, MessageCustomersTableInfo)

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

SoDataReader positioned to a valid database row.
MessageCustomersTableInfo tableInfo

MessageCustomersTableInfo 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
MessageCustomersRows

Remove(MessageCustomersRow)

Removes the given MessageCustomersRow from the collection

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

the MessageCustomersRow to be removed

ToArray()

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

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)