Class EjuserRows

This table contains entries for the users of the system. Collection of EjuserRow. Each element of the collection represents one row in the Ejuser table.

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

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

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

Methods

Add(EjuserRow)

Add one EjuserRow to the collection.

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

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

The index of the added EjuserRow.

AddNew()

Add a new instance of EjuserRow added to the collection.

Declaration
public EjuserRow AddNew()
Returns
Type Description
EjuserRow

A new instance of EjuserRow added to the collection.

AddRange(IEnumerable<EjuserRow>)

Add a range of EjuserRow to the collection.

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

The updated EjuserRows collection object.

CreateChild()

Create a new instance of EjuserRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of EjuserRow
Overrides

CreateNew()

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

Declaration
public static EjuserRows CreateNew()
Returns
Type Description
EjuserRows

A new instance of the EjuserRows object.

Find(Predicate<EjuserRow>)

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

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

FindAll(Predicate<EjuserRow>)

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

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

ForEach(Action<EjuserRow>)

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

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

GetFromCustomSearch(EjuserRows.CustomSearch)

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

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

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

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

GetFromIdxDbiAgentId(Int32)

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

Declaration
public static EjuserRows GetFromIdxDbiAgentId(int dbiAgentId)
Parameters
Type Name Description
System.Int32 dbiAgentId
Returns
Type Description
EjuserRows

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

GetFromIdxDbiKey(String)

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

Declaration
public static EjuserRows GetFromIdxDbiKey(string dbiKey)
Parameters
Type Name Description
System.String dbiKey
Returns
Type Description
EjuserRows

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

GetFromIdxDbiLastModified(DateTime)

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

Declaration
public static EjuserRows GetFromIdxDbiLastModified(DateTime dbiLastModified)
Parameters
Type Name Description
System.DateTime dbiLastModified
Returns
Type Description
EjuserRows

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

GetFromIdxDbiLastSyncronized(DateTime)

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

Declaration
public static EjuserRows GetFromIdxDbiLastSyncronized(DateTime dbiLastSyncronized)
Parameters
Type Name Description
System.DateTime dbiLastSyncronized
Returns
Type Description
EjuserRows

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

GetFromIdxDefaultCategory(Int32)

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

Declaration
public static EjuserRows GetFromIdxDefaultCategory(int defaultCategory)
Parameters
Type Name Description
System.Int32 defaultCategory
Returns
Type Description
EjuserRows

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

GetFromIdxDefaultStatusAddMessage(Int32)

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

Declaration
public static EjuserRows GetFromIdxDefaultStatusAddMessage(int defaultStatusAddMessage)
Parameters
Type Name Description
System.Int32 defaultStatusAddMessage
Returns
Type Description
EjuserRows

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

GetFromIdxDefaultStatusNewTicket(Int32)

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

Declaration
public static EjuserRows GetFromIdxDefaultStatusNewTicket(int defaultStatusNewTicket)
Parameters
Type Name Description
System.Int32 defaultStatusNewTicket
Returns
Type Description
EjuserRows

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

GetFromIdxEmail(String)

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

Declaration
public static EjuserRows GetFromIdxEmail(string email)
Parameters
Type Name Description
System.String email
Returns
Type Description
EjuserRows

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

GetFromIdxLastCategory(Int32)

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

Declaration
public static EjuserRows GetFromIdxLastCategory(int lastCategory)
Parameters
Type Name Description
System.Int32 lastCategory
Returns
Type Description
EjuserRows

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

GetFromIdxLoginname(String)

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

Declaration
public static EjuserRows GetFromIdxLoginname(string loginname)
Parameters
Type Name Description
System.String loginname
Returns
Type Description
EjuserRows

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

GetFromIdxPictureId(Int32)

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

Declaration
public static EjuserRows GetFromIdxPictureId(int pictureId)
Parameters
Type Name Description
System.Int32 pictureId
Returns
Type Description
EjuserRows

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

GetFromIdxProfileId(Int32)

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

Declaration
public static EjuserRows GetFromIdxProfileId(int profileId)
Parameters
Type Name Description
System.Int32 profileId
Returns
Type Description
EjuserRows

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

GetFromIdxUsergroup(Int32)

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

Declaration
public static EjuserRows GetFromIdxUsergroup(int usergroup)
Parameters
Type Name Description
System.Int32 usergroup
Returns
Type Description
EjuserRows

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

GetFromIdxUsername(String)

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

Declaration
public static EjuserRows GetFromIdxUsername(string username)
Parameters
Type Name Description
System.String username
Returns
Type Description
EjuserRows

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

GetFromReader(SoDataReader, EjuserTableInfo)

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

SoDataReader positioned to a valid database row.
EjuserTableInfo tableInfo

EjuserTableInfo 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
EjuserRows

Remove(EjuserRow)

Removes the given EjuserRow from the collection

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

the EjuserRow to be removed

ToArray()

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

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)