Class OutgoingMessageRows

Delivery of outgoing messages to messageplugins, updated with status asynchroneously Collection of OutgoingMessageRow. Each element of the collection represents one row in the OutgoingMessage table.

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

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

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

Methods

Add(OutgoingMessageRow)

Add one OutgoingMessageRow to the collection.

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

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

The index of the added OutgoingMessageRow.

AddNew()

Add a new instance of OutgoingMessageRow added to the collection.

Declaration
public OutgoingMessageRow AddNew()
Returns
Type Description
OutgoingMessageRow

A new instance of OutgoingMessageRow added to the collection.

AddRange(IEnumerable<OutgoingMessageRow>)

Add a range of OutgoingMessageRow to the collection.

Declaration
public OutgoingMessageRows AddRange(IEnumerable<OutgoingMessageRow> rows)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<OutgoingMessageRow> rows
Returns
Type Description
OutgoingMessageRows

The updated OutgoingMessageRows collection object.

CreateChild()

Create a new instance of OutgoingMessageRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of OutgoingMessageRow
Overrides

CreateNew()

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

Declaration
public static OutgoingMessageRows CreateNew()
Returns
Type Description
OutgoingMessageRows

A new instance of the OutgoingMessageRows object.

Find(Predicate<OutgoingMessageRow>)

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

Declaration
public OutgoingMessageRow Find(Predicate<OutgoingMessageRow> condition)
Parameters
Type Name Description
System.Predicate<OutgoingMessageRow> condition
Returns
Type Description
OutgoingMessageRow

FindAll(Predicate<OutgoingMessageRow>)

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

Declaration
public OutgoingMessageRows FindAll(Predicate<OutgoingMessageRow> condition)
Parameters
Type Name Description
System.Predicate<OutgoingMessageRow> condition
Returns
Type Description
OutgoingMessageRows

ForEach(Action<OutgoingMessageRow>)

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

Declaration
public void ForEach(Action<OutgoingMessageRow> whatToDo)
Parameters
Type Name Description
System.Action<OutgoingMessageRow> whatToDo

GetFromCustomSearch(OutgoingMessageRows.CustomSearch)

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

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

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

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

GetFromIdxExternalMessageId(String)

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

Declaration
public static OutgoingMessageRows GetFromIdxExternalMessageId(string externalMessageId)
Parameters
Type Name Description
System.String externalMessageId
Returns
Type Description
OutgoingMessageRows

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

GetFromIdxRegisteredAssociateId(Int32)

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

Declaration
public static OutgoingMessageRows GetFromIdxRegisteredAssociateId(int registeredAssociateId)
Parameters
Type Name Description
System.Int32 registeredAssociateId
Returns
Type Description
OutgoingMessageRows

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

GetFromIdxSessionKey(String)

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

Declaration
public static OutgoingMessageRows GetFromIdxSessionKey(string sessionKey)
Parameters
Type Name Description
System.String sessionKey
Returns
Type Description
OutgoingMessageRows

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

GetFromIdxUpdatedAssociateId(Int32)

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

Declaration
public static OutgoingMessageRows GetFromIdxUpdatedAssociateId(int updatedAssociateId)
Parameters
Type Name Description
System.Int32 updatedAssociateId
Returns
Type Description
OutgoingMessageRows

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 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 OutgoingMessageRows 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 OutgoingMessageRow 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 OutgoingMessageRows 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
OutgoingMessageRows

Remove(OutgoingMessageRow)

Removes the given OutgoingMessageRow from the collection

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

the OutgoingMessageRow to be removed

ToArray()

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

ToString()

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

Declaration
public override string ToString()
Returns
Type Description
System.String

Implements

System.Collections.Generic.IEnumerable<>
System.Collections.IEnumerable
System.Collections.IList
System.Collections.ICollection
System.Collections.Specialized.INotifyCollectionChanged
System.ComponentModel.IBindingList

Extension Methods

EnumUtil.MapEnums<From, To>(From)