Class SessionObjectRows

Generic session object, accessible from ejscript etc, typically xml or name=value syntax, may be stored over several rows if big Collection of SessionObjectRow. Each element of the collection represents one row in the SessionObject table.

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

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

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

Methods

Add(SessionObjectRow)

Add one SessionObjectRow to the collection.

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

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

The index of the added SessionObjectRow.

AddNew()

Add a new instance of SessionObjectRow added to the collection.

Declaration
public SessionObjectRow AddNew()
Returns
Type Description
SessionObjectRow

A new instance of SessionObjectRow added to the collection.

AddRange(IEnumerable<SessionObjectRow>)

Add a range of SessionObjectRow to the collection.

Declaration
public SessionObjectRows AddRange(IEnumerable<SessionObjectRow> rows)
Parameters
Type Name Description
IEnumerable<SessionObjectRow> rows
Returns
Type Description
SessionObjectRows

The updated SessionObjectRows collection object.

CreateChild()

Create a new instance of SessionObjectRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of SessionObjectRow
Overrides

CreateNew()

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

Declaration
public static SessionObjectRows CreateNew()
Returns
Type Description
SessionObjectRows

A new instance of the SessionObjectRows object.

Find(Predicate<SessionObjectRow>)

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

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

FindAll(Predicate<SessionObjectRow>)

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

Declaration
public SessionObjectRows FindAll(Predicate<SessionObjectRow> condition)
Parameters
Type Name Description
Predicate<SessionObjectRow> condition
Returns
Type Description
SessionObjectRows

ForEach(Action<SessionObjectRow>)

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

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

GetFromCustomSearch(SessionObjectRows.CustomSearch)

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

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

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

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

GetFromIdxLoginId(Int32)

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

Declaration
public static SessionObjectRows GetFromIdxLoginId(int loginId)
Parameters
Type Name Description
Int32 loginId
Returns
Type Description
SessionObjectRows

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

GetFromIdxName(String)

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

Declaration
public static SessionObjectRows GetFromIdxName(string name)
Parameters
Type Name Description
String name
Returns
Type Description
SessionObjectRows

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

GetFromReader(SoDataReader, SessionObjectTableInfo)

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

SoDataReader positioned to a valid database row.
SessionObjectTableInfo tableInfo

SessionObjectTableInfo 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
SessionObjectRows

Remove(SessionObjectRow)

Removes the given SessionObjectRow from the collection

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

the SessionObjectRow to be removed

ToArray()

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

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)