Class AssociateHistoryRows
Historical information about associates that have been deleted. Most references are NOT declared as foreign keys; this is a historical table that should not be updated when further changes occur in the database Collection of AssociateHistoryRow. Each element of the collection represents one row in the AssociateHistory table.
Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class AssociateHistoryRows : TableRowsBase, INestedPersist, IEnumerable<INestedPersist>, ISoCollection, INotifyCollectionChanged, IBindingList, IList, ICollection, IEnumerable
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 AssociateHistoryRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AssociateHistoryRows AssociateHistoryRows.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(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.
Properties
this[int]
Get a AssociateHistoryRow given its index in the collection.
Declaration
public AssociateHistoryRow this[int index] { get; }
Parameters
Type | Name | Description |
---|---|---|
int | index | Index of the AssociateHistoryRow in the collection |
Property Value
Type | Description |
---|---|
AssociateHistoryRow |
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 AssociateHistoryRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AssociateHistoryRows AssociateHistoryRows.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(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.
Methods
Add(AssociateHistoryRow)
Add one AssociateHistoryRow to the collection.
Declaration
public int Add(AssociateHistoryRow row)
Parameters
Type | Name | Description |
---|---|---|
AssociateHistoryRow | row | An instance of AssociateHistoryRow to be added to the collection. |
Returns
Type | Description |
---|---|
int | The index of the added AssociateHistoryRow. |
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 AssociateHistoryRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AssociateHistoryRows AssociateHistoryRows.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(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.
AddNew()
Add a new instance of AssociateHistoryRow added to the collection.
Declaration
public AssociateHistoryRow AddNew()
Returns
Type | Description |
---|---|
AssociateHistoryRow | A new instance of AssociateHistoryRow added to the collection. |
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 AssociateHistoryRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AssociateHistoryRows AssociateHistoryRows.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(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.
AddRange(IEnumerable<AssociateHistoryRow>)
Add a range of AssociateHistoryRow to the collection.
Declaration
public AssociateHistoryRows AddRange(IEnumerable<AssociateHistoryRow> rows)
Parameters
Type | Name | Description |
---|---|---|
IEnumerable<AssociateHistoryRow> | rows |
Returns
Type | Description |
---|---|
AssociateHistoryRows | The updated AssociateHistoryRows collection object. |
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 AssociateHistoryRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AssociateHistoryRows AssociateHistoryRows.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(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.
CreateChild()
Create a new instance of AssociateHistoryRow
Declaration
protected override TableRowBase CreateChild()
Returns
Type | Description |
---|---|
TableRowBase | New instance of AssociateHistoryRow |
Overrides
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 AssociateHistoryRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AssociateHistoryRows AssociateHistoryRows.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(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.
CreateNew()
Create a new instance of the AssociateHistoryRows object. This collection will contain no rows.
Declaration
public static AssociateHistoryRows CreateNew()
Returns
Type | Description |
---|---|
AssociateHistoryRows | A new instance of the AssociateHistoryRows object. |
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 AssociateHistoryRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AssociateHistoryRows AssociateHistoryRows.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(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.
Find(Predicate<AssociateHistoryRow>)
Apply the predicate to each element of the collection and return the first row that matches; if no match then return null
Declaration
public AssociateHistoryRow Find(Predicate<AssociateHistoryRow> condition)
Parameters
Type | Name | Description |
---|---|---|
Predicate<AssociateHistoryRow> | condition |
Returns
Type | Description |
---|---|
AssociateHistoryRow |
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 AssociateHistoryRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AssociateHistoryRows AssociateHistoryRows.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(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.
FindAll(Predicate<AssociateHistoryRow>)
Return a new collection that contains only those elements that match the condition. Elements are shared, not clones! of the original collection
Declaration
public AssociateHistoryRows FindAll(Predicate<AssociateHistoryRow> condition)
Parameters
Type | Name | Description |
---|---|---|
Predicate<AssociateHistoryRow> | condition |
Returns
Type | Description |
---|---|
AssociateHistoryRows |
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 AssociateHistoryRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AssociateHistoryRows AssociateHistoryRows.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(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.
ForEach(Action<AssociateHistoryRow>)
Method that iterates over all members and applies the action parameter to each of them
Declaration
public void ForEach(Action<AssociateHistoryRow> whatToDo)
Parameters
Type | Name | Description |
---|---|---|
Action<AssociateHistoryRow> | whatToDo |
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 AssociateHistoryRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AssociateHistoryRows AssociateHistoryRows.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(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.
GetFromCustomSearch(CustomSearch)
Create a new instance of the AssociateHistoryRows 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 AssociateHistoryRow objects representing each row will be returned.
Declaration
public static AssociateHistoryRows GetFromCustomSearch(AssociateHistoryRows.CustomSearch query)
Parameters
Type | Name | Description |
---|---|---|
AssociateHistoryRows.CustomSearch | query | The custom search to execute against the database |
Returns
Type | Description |
---|---|
AssociateHistoryRows | A new instance of the AssociateHistoryRows object, reflecting the result of the query. |
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 AssociateHistoryRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AssociateHistoryRows AssociateHistoryRows.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(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.
GetFromReader(SoDataReader, AssociateHistoryTableInfo)
Create a new instance of the AssociateHistoryRows 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 AssociateHistoryRow 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 AssociateHistoryRows GetFromReader(SoDataReader reader, AssociateHistoryTableInfo tableInfo)
Parameters
Type | Name | Description |
---|---|---|
SoDataReader | reader | SoDataReader positioned to a valid database row. |
AssociateHistoryTableInfo | tableInfo | AssociateHistoryTableInfo 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 |
---|---|
AssociateHistoryRows |
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 AssociateHistoryRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AssociateHistoryRows AssociateHistoryRows.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(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.
Remove(AssociateHistoryRow)
Removes the given AssociateHistoryRow from the collection
Declaration
public void Remove(AssociateHistoryRow row)
Parameters
Type | Name | Description |
---|---|---|
AssociateHistoryRow | row | the AssociateHistoryRow to be removed |
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 AssociateHistoryRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AssociateHistoryRows AssociateHistoryRows.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(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.
ToArray()
Historical information about associates that have been deleted. Most references are NOT declared as foreign keys; this is a historical table that should not be updated when further changes occur in the database Collection of AssociateHistoryRow. Each element of the collection represents one row in the AssociateHistory table.
Declaration
public AssociateHistoryRow[] ToArray()
Returns
Type | Description |
---|---|
AssociateHistoryRow[] |
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 AssociateHistoryRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AssociateHistoryRows AssociateHistoryRows.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(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.
ToString()
For debugging: Number of members, and the first (up to) 5 items
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
string |
Overrides
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 AssociateHistoryRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AssociateHistoryRows AssociateHistoryRows.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(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.