Class UserAttributeRows

This table is used for storing various attributes for users. Collection of UserAttributeRow. Each element of the collection represents one row in the UserAttribute table.

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

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

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

Methods

Add(UserAttributeRow)

Add one UserAttributeRow to the collection.

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

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

The index of the added UserAttributeRow.

AddNew()

Add a new instance of UserAttributeRow added to the collection.

Declaration
public UserAttributeRow AddNew()
Returns
Type Description
UserAttributeRow

A new instance of UserAttributeRow added to the collection.

AddRange(IEnumerable<UserAttributeRow>)

Add a range of UserAttributeRow to the collection.

Declaration
public UserAttributeRows AddRange(IEnumerable<UserAttributeRow> rows)
Parameters
Type Name Description
IEnumerable<UserAttributeRow> rows
Returns
Type Description
UserAttributeRows

The updated UserAttributeRows collection object.

CreateChild()

Create a new instance of UserAttributeRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of UserAttributeRow
Overrides

CreateNew()

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

Declaration
public static UserAttributeRows CreateNew()
Returns
Type Description
UserAttributeRows

A new instance of the UserAttributeRows object.

Find(Predicate<UserAttributeRow>)

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

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

FindAll(Predicate<UserAttributeRow>)

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

Declaration
public UserAttributeRows FindAll(Predicate<UserAttributeRow> condition)
Parameters
Type Name Description
Predicate<UserAttributeRow> condition
Returns
Type Description
UserAttributeRows

ForEach(Action<UserAttributeRow>)

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

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

GetFromCustomSearch(UserAttributeRows.CustomSearch)

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

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

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

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

GetFromIdxAttKey(String)

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

Declaration
public static UserAttributeRows GetFromIdxAttKey(string attKey)
Parameters
Type Name Description
String attKey
Returns
Type Description
UserAttributeRows

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

GetFromIdxUserId(Int32)

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

Declaration
public static UserAttributeRows GetFromIdxUserId(int userId)
Parameters
Type Name Description
Int32 userId
Returns
Type Description
UserAttributeRows

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

GetFromReader(SoDataReader, UserAttributeTableInfo)

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

SoDataReader positioned to a valid database row.
UserAttributeTableInfo tableInfo

UserAttributeTableInfo 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
UserAttributeRows

Remove(UserAttributeRow)

Removes the given UserAttributeRow from the collection

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

the UserAttributeRow to be removed

ToArray()

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

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)