Class UserPreferenceRows

Preference system. If deflevel is set to 5; the user may change the preferences Collection of UserPreferenceRow. Each element of the collection represents one row in the UserPreference table.

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

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

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

Methods

Add(UserPreferenceRow)

Add one UserPreferenceRow to the collection.

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

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

The index of the added UserPreferenceRow.

AddNew()

Add a new instance of UserPreferenceRow added to the collection.

Declaration
public UserPreferenceRow AddNew()
Returns
Type Description
UserPreferenceRow

A new instance of UserPreferenceRow added to the collection.

AddRange(IEnumerable<UserPreferenceRow>)

Add a range of UserPreferenceRow to the collection.

Declaration
public UserPreferenceRows AddRange(IEnumerable<UserPreferenceRow> rows)
Parameters
Type Name Description
IEnumerable<UserPreferenceRow> rows
Returns
Type Description
UserPreferenceRows

The updated UserPreferenceRows collection object.

CreateChild()

Create a new instance of UserPreferenceRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of UserPreferenceRow
Overrides

CreateNew()

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

Declaration
public static UserPreferenceRows CreateNew()
Returns
Type Description
UserPreferenceRows

A new instance of the UserPreferenceRows object.

Find(Predicate<UserPreferenceRow>)

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

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

FindAll(Predicate<UserPreferenceRow>)

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

Declaration
public UserPreferenceRows FindAll(Predicate<UserPreferenceRow> condition)
Parameters
Type Name Description
Predicate<UserPreferenceRow> condition
Returns
Type Description
UserPreferenceRows

ForEach(Action<UserPreferenceRow>)

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

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

GetFromCustomSearch(UserPreferenceRows.CustomSearch)

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

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

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

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

GetFromIdxDeflevel(PreferenceLevel)

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

Declaration
public static UserPreferenceRows GetFromIdxDeflevel(PreferenceLevel deflevel)
Parameters
Type Name Description
PreferenceLevel deflevel
Returns
Type Description
UserPreferenceRows

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

GetFromIdxOwnerId(Int32)

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

Declaration
public static UserPreferenceRows GetFromIdxOwnerId(int ownerId)
Parameters
Type Name Description
Int32 ownerId
Returns
Type Description
UserPreferenceRows

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

GetFromIdxPrefkey(String)

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

Declaration
public static UserPreferenceRows GetFromIdxPrefkey(string prefkey)
Parameters
Type Name Description
String prefkey
Returns
Type Description
UserPreferenceRows

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

GetFromIdxPrefsection(String)

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

Declaration
public static UserPreferenceRows GetFromIdxPrefsection(string prefsection)
Parameters
Type Name Description
String prefsection
Returns
Type Description
UserPreferenceRows

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

GetFromIdxPrefsectionPrefkey(String, String)

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

Declaration
public static UserPreferenceRows GetFromIdxPrefsectionPrefkey(string prefsection, string prefkey)
Parameters
Type Name Description
String prefsection
String prefkey
Returns
Type Description
UserPreferenceRows

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

GetFromIdxPrefsectionPrefkeyDeflevel(String, String, PreferenceLevel)

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

Declaration
public static UserPreferenceRows GetFromIdxPrefsectionPrefkeyDeflevel(string prefsection, string prefkey, PreferenceLevel deflevel)
Parameters
Type Name Description
String prefsection
String prefkey
PreferenceLevel deflevel
Returns
Type Description
UserPreferenceRows

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

GetFromIdxPrefsectionPrefkeyDeflevelOwnerId(String, String, PreferenceLevel, Int32)

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

Declaration
public static UserPreferenceRows GetFromIdxPrefsectionPrefkeyDeflevelOwnerId(string prefsection, string prefkey, PreferenceLevel deflevel, int ownerId)
Parameters
Type Name Description
String prefsection
String prefkey
PreferenceLevel deflevel
Int32 ownerId
Returns
Type Description
UserPreferenceRows

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

GetFromReader(SoDataReader, UserPreferenceTableInfo)

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

SoDataReader positioned to a valid database row.
UserPreferenceTableInfo tableInfo

UserPreferenceTableInfo 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
UserPreferenceRows

Remove(UserPreferenceRow)

Removes the given UserPreferenceRow from the collection

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

the UserPreferenceRow to be removed

ToArray()

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

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)