Class PersonInterestRows

Note: If you add or remove rows in this table, you will need to update the interestCount field in the person table accordingly. This field should always reflect the number of interest records a person has, to enable the correct setting of the interest indicator on the tab in the person dialog. Replication note: The combination of person_id and pinterest_idx is unique. If a duplicate is made on a replicated database, the system will replace the record in the target database with the one derived from the source database during replication. Therefore, do not assume that a record in this table will retain its ID indefinitely, even if the person keeps the interest. Collection of PersonInterestRow. Each element of the collection represents one row in the PersonInterest table.

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

this[int]

Get a PersonInterestRow given its index in the collection.

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

Index of the PersonInterestRow in the collection
Property Value
Type Description
PersonInterestRow
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 PersonInterestRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) PersonInterestRows PersonInterestRows.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 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 PersonInterestRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.PersonInterestRows.GetFromReader 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).

Methods

Add(PersonInterestRow)

Add one PersonInterestRow to the collection.

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

An instance of PersonInterestRow to be added to the collection.
Returns
Type Description
int

The index of the added PersonInterestRow.
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 PersonInterestRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) PersonInterestRows PersonInterestRows.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 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 PersonInterestRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.PersonInterestRows.GetFromReader 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).

AddNew()

Add a new instance of PersonInterestRow added to the collection.

Declaration
public PersonInterestRow AddNew()
Returns
Type Description
PersonInterestRow

A new instance of PersonInterestRow 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 PersonInterestRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) PersonInterestRows PersonInterestRows.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 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 PersonInterestRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.PersonInterestRows.GetFromReader 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).

AddRange(IEnumerable<PersonInterestRow>)

Add a range of PersonInterestRow to the collection.

Declaration
public PersonInterestRows AddRange(IEnumerable<PersonInterestRow> rows)
Parameters
Type Name Description
IEnumerable<PersonInterestRow> rows
Returns
Type Description
PersonInterestRows

The updated PersonInterestRows 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 PersonInterestRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) PersonInterestRows PersonInterestRows.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 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 PersonInterestRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.PersonInterestRows.GetFromReader 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).

CreateChild()

Create a new instance of PersonInterestRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of PersonInterestRow
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 PersonInterestRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) PersonInterestRows PersonInterestRows.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 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 PersonInterestRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.PersonInterestRows.GetFromReader 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).

CreateNew()

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

Declaration
public static PersonInterestRows CreateNew()
Returns
Type Description
PersonInterestRows

A new instance of the PersonInterestRows 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 PersonInterestRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) PersonInterestRows PersonInterestRows.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 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 PersonInterestRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.PersonInterestRows.GetFromReader 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).

Find(Predicate<PersonInterestRow>)

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

Declaration
public PersonInterestRow Find(Predicate<PersonInterestRow> condition)
Parameters
Type Name Description
Predicate<PersonInterestRow> condition
Returns
Type Description
PersonInterestRow
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 PersonInterestRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) PersonInterestRows PersonInterestRows.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 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 PersonInterestRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.PersonInterestRows.GetFromReader 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).

FindAll(Predicate<PersonInterestRow>)

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

Declaration
public PersonInterestRows FindAll(Predicate<PersonInterestRow> condition)
Parameters
Type Name Description
Predicate<PersonInterestRow> condition
Returns
Type Description
PersonInterestRows
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 PersonInterestRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) PersonInterestRows PersonInterestRows.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 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 PersonInterestRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.PersonInterestRows.GetFromReader 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).

ForEach(Action<PersonInterestRow>)

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

Declaration
public void ForEach(Action<PersonInterestRow> whatToDo)
Parameters
Type Name Description
Action<PersonInterestRow> 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 PersonInterestRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) PersonInterestRows PersonInterestRows.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 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 PersonInterestRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.PersonInterestRows.GetFromReader 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).

GetFromCustomSearchAsync(CustomSearch, CancellationToken)

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

Declaration
public static Task<PersonInterestRows> GetFromCustomSearchAsync(PersonInterestRows.CustomSearch query, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PersonInterestRows.CustomSearch query

The custom search to execute against the database
CancellationToken cancellationToken
Returns
Type Description
Task<PersonInterestRows>

A new instance of the PersonInterestRows 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 PersonInterestRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) PersonInterestRows PersonInterestRows.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 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 PersonInterestRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.PersonInterestRows.GetFromReader 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).

GetFromIdxEndDateAsync(DateTime, CancellationToken)

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

Declaration
public static Task<PersonInterestRows> GetFromIdxEndDateAsync(DateTime endDate, CancellationToken cancellationToken = default)
Parameters
Type Name Description
DateTime endDate
CancellationToken cancellationToken
Returns
Type Description
Task<PersonInterestRows>

Row object that represents the result of the search. IsNew 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 PersonInterest table. Non-unique indexes have corresponding inner classes and methods in the PersonInterestRows collection, since they may return more than one row.

GetFromIdxPersonIdAsync(int, CancellationToken)

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

Declaration
public static Task<PersonInterestRows> GetFromIdxPersonIdAsync(int personId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int personId
CancellationToken cancellationToken
Returns
Type Description
Task<PersonInterestRows>

Row object that represents the result of the search. IsNew 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 PersonInterest table. Non-unique indexes have corresponding inner classes and methods in the PersonInterestRows collection, since they may return more than one row.

GetFromIdxPinterestIdxAsync(int, CancellationToken)

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

Declaration
public static Task<PersonInterestRows> GetFromIdxPinterestIdxAsync(int pinterestIdx, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int pinterestIdx
CancellationToken cancellationToken
Returns
Type Description
Task<PersonInterestRows>

Row object that represents the result of the search. IsNew 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 PersonInterest table. Non-unique indexes have corresponding inner classes and methods in the PersonInterestRows collection, since they may return more than one row.

GetFromIdxStartDateAsync(DateTime, CancellationToken)

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

Declaration
public static Task<PersonInterestRows> GetFromIdxStartDateAsync(DateTime startDate, CancellationToken cancellationToken = default)
Parameters
Type Name Description
DateTime startDate
CancellationToken cancellationToken
Returns
Type Description
Task<PersonInterestRows>

Row object that represents the result of the search. IsNew 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 PersonInterest table. Non-unique indexes have corresponding inner classes and methods in the PersonInterestRows collection, since they may return more than one row.

GetFromReaderAsync(SoDataReader, PersonInterestTableInfo, CancellationToken)

Create a new instance of the PersonInterestRows 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 PersonInterestRow 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 Task<PersonInterestRows> GetFromReaderAsync(SoDataReader reader, PersonInterestTableInfo tableInfo, CancellationToken cancellationToken = default)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.
PersonInterestTableInfo tableInfo

PersonInterestTableInfo 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.
CancellationToken cancellationToken
Returns
Type Description
Task<PersonInterestRows>
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 PersonInterestRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) PersonInterestRows PersonInterestRows.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 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 PersonInterestRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.PersonInterestRows.GetFromReader 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).

Remove(PersonInterestRow)

Removes the given PersonInterestRow from the collection

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

the PersonInterestRow 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 PersonInterestRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) PersonInterestRows PersonInterestRows.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 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 PersonInterestRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.PersonInterestRows.GetFromReader 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).

ToArray()

Note: If you add or remove rows in this table, you will need to update the interestCount field in the person table accordingly. This field should always reflect the number of interest records a person has, to enable the correct setting of the interest indicator on the tab in the person dialog. Replication note: The combination of person_id and pinterest_idx is unique. If a duplicate is made on a replicated database, the system will replace the record in the target database with the one derived from the source database during replication. Therefore, do not assume that a record in this table will retain its ID indefinitely, even if the person keeps the interest. Collection of PersonInterestRow. Each element of the collection represents one row in the PersonInterest table.

Declaration
public PersonInterestRow[] ToArray()
Returns
Type Description
PersonInterestRow[]
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 PersonInterestRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) PersonInterestRows PersonInterestRows.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 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 PersonInterestRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.PersonInterestRows.GetFromReader 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).

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 PersonInterestRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) PersonInterestRows PersonInterestRows.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 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 PersonInterestRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.PersonInterestRows.GetFromReader 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).

Implements

Extension Methods