Class AccessScriptRows

Scripts to implement row-based access rules (sentry light) Collection of AccessScriptRow. Each element of the collection represents one row in the AccessScript table.

Inheritance
System.Object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
TableRowsBase
AccessScriptRows
Implements
System.Collections.Generic.IEnumerable<INestedPersist>
System.Collections.IEnumerable
System.Collections.IList
System.Collections.ICollection
System.Collections.Specialized.INotifyCollectionChanged
System.ComponentModel.IBindingList
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class AccessScriptRows : TableRowsBase, INestedPersist, IEnumerable<INestedPersist>, ISoCollection, IEnumerable, IList, ICollection, 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 AccessScriptRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) AccessScriptRows AccessScriptRows.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(AccessScriptRows.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 AccessScriptRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, AccessScriptTableInfo) 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 AccessScriptRow given its index in the collection.

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

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

Methods

Add(AccessScriptRow)

Add one AccessScriptRow to the collection.

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

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

The index of the added AccessScriptRow.

AddNew()

Add a new instance of AccessScriptRow added to the collection.

Declaration
public AccessScriptRow AddNew()
Returns
Type Description
AccessScriptRow

A new instance of AccessScriptRow added to the collection.

AddRange(IEnumerable<AccessScriptRow>)

Add a range of AccessScriptRow to the collection.

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

The updated AccessScriptRows collection object.

CreateChild()

Create a new instance of AccessScriptRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of AccessScriptRow
Overrides

CreateNew()

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

Declaration
public static AccessScriptRows CreateNew()
Returns
Type Description
AccessScriptRows

A new instance of the AccessScriptRows object.

Find(Predicate<AccessScriptRow>)

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

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

FindAll(Predicate<AccessScriptRow>)

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

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

ForEach(Action<AccessScriptRow>)

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

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

GetFromCustomSearch(AccessScriptRows.CustomSearch)

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

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

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

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

GetFromReader(SoDataReader, AccessScriptTableInfo)

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

SoDataReader positioned to a valid database row.
AccessScriptTableInfo tableInfo

AccessScriptTableInfo 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
AccessScriptRows

Remove(AccessScriptRow)

Removes the given AccessScriptRow from the collection

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

the AccessScriptRow to be removed

ToArray()

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

ToString()

For debugging: Number of members, and the first (up to) 5 items

Declaration
public override string ToString()
Returns
Type Description
System.String

Implements

System.Collections.Generic.IEnumerable<>
System.Collections.IEnumerable
System.Collections.IList
System.Collections.ICollection
System.Collections.Specialized.INotifyCollectionChanged
System.ComponentModel.IBindingList

Extension Methods

EnumUtil.MapEnums<From, To>(From)