Class ActiveUserRows

Currently logged-on users. This table contains encrypted license information. Changing it may disable login for all users and require intervention by SuperOffice support. Recommended use: for determining who is logged on, at what location, etc. Collection of ActiveUserRow. Each element of the collection represents one row in the ActiveUser table.

Inheritance
System.Object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
TableRowsBase
ActiveUserRows
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 ActiveUserRows : 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 ActiveUserRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) ActiveUserRows ActiveUserRows.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(ActiveUserRows.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 ActiveUserRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, ActiveUserTableInfo) 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 ActiveUserRow given its index in the collection.

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

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

Methods

Add(ActiveUserRow)

Add one ActiveUserRow to the collection.

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

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

The index of the added ActiveUserRow.

AddNew()

Add a new instance of ActiveUserRow added to the collection.

Declaration
public ActiveUserRow AddNew()
Returns
Type Description
ActiveUserRow

A new instance of ActiveUserRow added to the collection.

AddRange(IEnumerable<ActiveUserRow>)

Add a range of ActiveUserRow to the collection.

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

The updated ActiveUserRows collection object.

CreateChild()

Create a new instance of ActiveUserRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of ActiveUserRow
Overrides

CreateNew()

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

Declaration
public static ActiveUserRows CreateNew()
Returns
Type Description
ActiveUserRows

A new instance of the ActiveUserRows object.

Find(Predicate<ActiveUserRow>)

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

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

FindAll(Predicate<ActiveUserRow>)

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

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

ForEach(Action<ActiveUserRow>)

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

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

GetFromCustomSearch(ActiveUserRows.CustomSearch)

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

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

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

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

GetFromReader(SoDataReader, ActiveUserTableInfo)

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

SoDataReader positioned to a valid database row.
ActiveUserTableInfo tableInfo

ActiveUserTableInfo 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
ActiveUserRows

Remove(ActiveUserRow)

Removes the given ActiveUserRow from the collection

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

the ActiveUserRow to be removed

ToArray()

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

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)