Class RelationDefinitionRows

Definition of a relation. This table defines the relations that can exist in the database. Each relation has an active text and a passive text. The table RelationTarget specifies which pairs of tables this relation can connect. Use of the active and passive texts is dependent on which direction the relation is viewed in, e.g., active text = "Owns" and passive text = "Is owned by". Collection of RelationDefinitionRow. Each element of the collection represents one row in the RelationDefinition table.

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

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

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

Methods

Add(RelationDefinitionRow)

Add one RelationDefinitionRow to the collection.

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

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

The index of the added RelationDefinitionRow.

AddNew()

Add a new instance of RelationDefinitionRow added to the collection.

Declaration
public RelationDefinitionRow AddNew()
Returns
Type Description
RelationDefinitionRow

A new instance of RelationDefinitionRow added to the collection.

AddRange(IEnumerable<RelationDefinitionRow>)

Add a range of RelationDefinitionRow to the collection.

Declaration
public RelationDefinitionRows AddRange(IEnumerable<RelationDefinitionRow> rows)
Parameters
Type Name Description
IEnumerable<RelationDefinitionRow> rows
Returns
Type Description
RelationDefinitionRows

The updated RelationDefinitionRows collection object.

CreateChild()

Create a new instance of RelationDefinitionRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of RelationDefinitionRow
Overrides

CreateNew()

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

Declaration
public static RelationDefinitionRows CreateNew()
Returns
Type Description
RelationDefinitionRows

A new instance of the RelationDefinitionRows object.

Find(Predicate<RelationDefinitionRow>)

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

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

FindAll(Predicate<RelationDefinitionRow>)

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

Declaration
public RelationDefinitionRows FindAll(Predicate<RelationDefinitionRow> condition)
Parameters
Type Name Description
Predicate<RelationDefinitionRow> condition
Returns
Type Description
RelationDefinitionRows

ForEach(Action<RelationDefinitionRow>)

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

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

GetFromCustomSearch(RelationDefinitionRows.CustomSearch)

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

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

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

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

GetFromReader(SoDataReader, RelationDefinitionTableInfo)

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

SoDataReader positioned to a valid database row.
RelationDefinitionTableInfo tableInfo

RelationDefinitionTableInfo 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
RelationDefinitionRows

Remove(RelationDefinitionRow)

Removes the given RelationDefinitionRow from the collection

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

the RelationDefinitionRow to be removed

ToArray()

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

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)