Class LoginCustomerRows

This table contains entries for customer sessions. At first only used for Soap logins, but will later also be used for web logins Collection of LoginCustomerRow. Each element of the collection represents one row in the LoginCustomer table.

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

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

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

Methods

Add(LoginCustomerRow)

Add one LoginCustomerRow to the collection.

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

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

The index of the added LoginCustomerRow.

AddNew()

Add a new instance of LoginCustomerRow added to the collection.

Declaration
public LoginCustomerRow AddNew()
Returns
Type Description
LoginCustomerRow

A new instance of LoginCustomerRow added to the collection.

AddRange(IEnumerable<LoginCustomerRow>)

Add a range of LoginCustomerRow to the collection.

Declaration
public LoginCustomerRows AddRange(IEnumerable<LoginCustomerRow> rows)
Parameters
Type Name Description
IEnumerable<LoginCustomerRow> rows
Returns
Type Description
LoginCustomerRows

The updated LoginCustomerRows collection object.

CreateChild()

Create a new instance of LoginCustomerRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of LoginCustomerRow
Overrides

CreateNew()

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

Declaration
public static LoginCustomerRows CreateNew()
Returns
Type Description
LoginCustomerRows

A new instance of the LoginCustomerRows object.

Find(Predicate<LoginCustomerRow>)

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

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

FindAll(Predicate<LoginCustomerRow>)

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

Declaration
public LoginCustomerRows FindAll(Predicate<LoginCustomerRow> condition)
Parameters
Type Name Description
Predicate<LoginCustomerRow> condition
Returns
Type Description
LoginCustomerRows

ForEach(Action<LoginCustomerRow>)

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

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

GetFromCustomSearch(LoginCustomerRows.CustomSearch)

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

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

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

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

GetFromIdxCustomerId(Int32)

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

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

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

GetFromIdxLoginOrigin(Int32)

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

Declaration
public static LoginCustomerRows GetFromIdxLoginOrigin(int loginOrigin)
Parameters
Type Name Description
Int32 loginOrigin
Returns
Type Description
LoginCustomerRows

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

GetFromIdxSessionKey(String)

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

Declaration
public static LoginCustomerRows GetFromIdxSessionKey(string sessionKey)
Parameters
Type Name Description
String sessionKey
Returns
Type Description
LoginCustomerRows

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

GetFromReader(SoDataReader, LoginCustomerTableInfo)

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

SoDataReader positioned to a valid database row.
LoginCustomerTableInfo tableInfo

LoginCustomerTableInfo 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
LoginCustomerRows

Remove(LoginCustomerRow)

Removes the given LoginCustomerRow from the collection

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

the LoginCustomerRow to be removed

ToArray()

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

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)