Class LicenseAssocLinkRows

Link between ModuleLicense and Associate, for per-assoc licenses; this is how licenses are assigned/consumed Collection of LicenseAssocLinkRow. Each element of the collection represents one row in the LicenseAssocLink table.

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

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

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

Methods

Add(LicenseAssocLinkRow)

Add one LicenseAssocLinkRow to the collection.

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

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

The index of the added LicenseAssocLinkRow.

AddNew()

Add a new instance of LicenseAssocLinkRow added to the collection.

Declaration
public LicenseAssocLinkRow AddNew()
Returns
Type Description
LicenseAssocLinkRow

A new instance of LicenseAssocLinkRow added to the collection.

AddRange(IEnumerable<LicenseAssocLinkRow>)

Add a range of LicenseAssocLinkRow to the collection.

Declaration
public LicenseAssocLinkRows AddRange(IEnumerable<LicenseAssocLinkRow> rows)
Parameters
Type Name Description
IEnumerable<LicenseAssocLinkRow> rows
Returns
Type Description
LicenseAssocLinkRows

The updated LicenseAssocLinkRows collection object.

CreateChild()

Create a new instance of LicenseAssocLinkRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of LicenseAssocLinkRow
Overrides

CreateNew()

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

Declaration
public static LicenseAssocLinkRows CreateNew()
Returns
Type Description
LicenseAssocLinkRows

A new instance of the LicenseAssocLinkRows object.

Find(Predicate<LicenseAssocLinkRow>)

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

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

FindAll(Predicate<LicenseAssocLinkRow>)

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

Declaration
public LicenseAssocLinkRows FindAll(Predicate<LicenseAssocLinkRow> condition)
Parameters
Type Name Description
Predicate<LicenseAssocLinkRow> condition
Returns
Type Description
LicenseAssocLinkRows

ForEach(Action<LicenseAssocLinkRow>)

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

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

GetFromCustomSearch(LicenseAssocLinkRows.CustomSearch)

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

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

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

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

GetFromIdxModuleLicenseId(Int32)

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

Declaration
public static LicenseAssocLinkRows GetFromIdxModuleLicenseId(int moduleLicenseId)
Parameters
Type Name Description
Int32 moduleLicenseId
Returns
Type Description
LicenseAssocLinkRows

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

GetFromReader(SoDataReader, LicenseAssocLinkTableInfo)

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

SoDataReader positioned to a valid database row.
LicenseAssocLinkTableInfo tableInfo

LicenseAssocLinkTableInfo 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
LicenseAssocLinkRows

Remove(LicenseAssocLinkRow)

Removes the given LicenseAssocLinkRow from the collection

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

the LicenseAssocLinkRow to be removed

ToArray()

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

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)