Class ProjectRows

Projects Collection of ProjectRow. Each element of the collection represents one row in the Project table.

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

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

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

Methods

Add(ProjectRow)

Add one ProjectRow to the collection.

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

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

The index of the added ProjectRow.

AddNew()

Add a new instance of ProjectRow added to the collection.

Declaration
public ProjectRow AddNew()
Returns
Type Description
ProjectRow

A new instance of ProjectRow added to the collection.

AddRange(IEnumerable<ProjectRow>)

Add a range of ProjectRow to the collection.

Declaration
public ProjectRows AddRange(IEnumerable<ProjectRow> rows)
Parameters
Type Name Description
IEnumerable<ProjectRow> rows
Returns
Type Description
ProjectRows

The updated ProjectRows collection object.

CreateChild()

Create a new instance of ProjectRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of ProjectRow
Overrides

CreateNew()

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

Declaration
public static ProjectRows CreateNew()
Returns
Type Description
ProjectRows

A new instance of the ProjectRows object.

Find(Predicate<ProjectRow>)

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

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

FindAll(Predicate<ProjectRow>)

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

Declaration
public ProjectRows FindAll(Predicate<ProjectRow> condition)
Parameters
Type Name Description
Predicate<ProjectRow> condition
Returns
Type Description
ProjectRows

ForEach(Action<ProjectRow>)

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

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

GetFromCustomSearch(ProjectRows.CustomSearch)

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

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

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

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

GetFromIdxDone(Int16)

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

Declaration
public static ProjectRows GetFromIdxDone(short done)
Parameters
Type Name Description
Int16 done
Returns
Type Description
ProjectRows

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

GetFromIdxName(String)

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

Declaration
public static ProjectRows GetFromIdxName(string name)
Parameters
Type Name Description
String name
Returns
Type Description
ProjectRows

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

GetFromIdxProjectNumber(String)

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

Declaration
public static ProjectRows GetFromIdxProjectNumber(string projectNumber)
Parameters
Type Name Description
String projectNumber
Returns
Type Description
ProjectRows

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

GetFromIdxSoundEx(String)

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

Declaration
public static ProjectRows GetFromIdxSoundEx(string soundEx)
Parameters
Type Name Description
String soundEx
Returns
Type Description
ProjectRows

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

GetFromIdxSource(Int16)

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

Declaration
public static ProjectRows GetFromIdxSource(short source)
Parameters
Type Name Description
Int16 source
Returns
Type Description
ProjectRows

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

GetFromIdxUserdef2Id(Int32)

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

Declaration
public static ProjectRows GetFromIdxUserdef2Id(int userdef2Id)
Parameters
Type Name Description
Int32 userdef2Id
Returns
Type Description
ProjectRows

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

GetFromReader(SoDataReader, ProjectTableInfo)

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

SoDataReader positioned to a valid database row.
ProjectTableInfo tableInfo

ProjectTableInfo 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
ProjectRows

Remove(ProjectRow)

Removes the given ProjectRow from the collection

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

the ProjectRow to be removed

ToArray()

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

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)