Class SmsRows

This table will hold outgoing sms messages when transmitted with WebServices Collection of SmsRow. Each element of the collection represents one row in the Sms table.

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

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

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

Methods

Add(SmsRow)

Add one SmsRow to the collection.

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

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

The index of the added SmsRow.

AddNew()

Add a new instance of SmsRow added to the collection.

Declaration
public SmsRow AddNew()
Returns
Type Description
SmsRow

A new instance of SmsRow added to the collection.

AddRange(IEnumerable<SmsRow>)

Add a range of SmsRow to the collection.

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

The updated SmsRows collection object.

CreateChild()

Create a new instance of SmsRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of SmsRow
Overrides

CreateNew()

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

Declaration
public static SmsRows CreateNew()
Returns
Type Description
SmsRows

A new instance of the SmsRows object.

Find(Predicate<SmsRow>)

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

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

FindAll(Predicate<SmsRow>)

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

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

ForEach(Action<SmsRow>)

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

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

GetFromCustomSearch(SmsRows.CustomSearch)

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

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

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

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

GetFromIdxCustomerId(Int32)

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

Declaration
public static SmsRows GetFromIdxCustomerId(int customerId)
Parameters
Type Name Description
System.Int32 customerId
Returns
Type Description
SmsRows

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

GetFromIdxMessageId(Int32)

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

Declaration
public static SmsRows GetFromIdxMessageId(int messageId)
Parameters
Type Name Description
System.Int32 messageId
Returns
Type Description
SmsRows

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

GetFromIdxOutboxId(Int32)

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

Declaration
public static SmsRows GetFromIdxOutboxId(int outboxId)
Parameters
Type Name Description
System.Int32 outboxId
Returns
Type Description
SmsRows

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

GetFromIdxOutgoingMessageId(Int32)

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

Declaration
public static SmsRows GetFromIdxOutgoingMessageId(int outgoingMessageId)
Parameters
Type Name Description
System.Int32 outgoingMessageId
Returns
Type Description
SmsRows

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

GetFromIdxReferenceKey(String)

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

Declaration
public static SmsRows GetFromIdxReferenceKey(string referenceKey)
Parameters
Type Name Description
System.String referenceKey
Returns
Type Description
SmsRows

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

GetFromIdxSessionKey(String)

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

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

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

GetFromIdxShipmentId(Int32)

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

Declaration
public static SmsRows GetFromIdxShipmentId(int shipmentId)
Parameters
Type Name Description
System.Int32 shipmentId
Returns
Type Description
SmsRows

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

GetFromReader(SoDataReader, SmsTableInfo)

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

SoDataReader positioned to a valid database row.
SmsTableInfo tableInfo

SmsTableInfo 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
SmsRows

Remove(SmsRow)

Removes the given SmsRow from the collection

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

the SmsRow to be removed

ToArray()

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

ToString()

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

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

Implements

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

Extension Methods

EnumUtil.MapEnums<From, To>(From)