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
Implements
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class PersonInterestRows : 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 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(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 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(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(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(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 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(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<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(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 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(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 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(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<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(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<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(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<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(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 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 PersonInterestRows GetFromCustomSearch(PersonInterestRows.CustomSearch query)
Parameters
Type | Name | Description |
---|---|---|
PersonInterestRows.CustomSearch | query | The custom search to execute against the database |
Returns
Type | Description |
---|---|
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(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.
GetFromIdxEndDate(DateTime)
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 PersonInterestRows GetFromIdxEndDate(DateTime endDate)
Parameters
Type | Name | Description |
---|---|---|
DateTime | endDate |
Returns
Type | Description |
---|---|
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.
GetFromIdxPersonId(int)
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 PersonInterestRows GetFromIdxPersonId(int personId)
Parameters
Type | Name | Description |
---|---|---|
int | personId |
Returns
Type | Description |
---|---|
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.
GetFromIdxPinterestIdx(int)
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 PersonInterestRows GetFromIdxPinterestIdx(int pinterestIdx)
Parameters
Type | Name | Description |
---|---|---|
int | pinterestIdx |
Returns
Type | Description |
---|---|
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.
GetFromIdxStartDate(DateTime)
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 PersonInterestRows GetFromIdxStartDate(DateTime startDate)
Parameters
Type | Name | Description |
---|---|---|
DateTime | startDate |
Returns
Type | Description |
---|---|
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.
GetFromReader(SoDataReader, PersonInterestTableInfo)
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 PersonInterestRows GetFromReader(SoDataReader reader, PersonInterestTableInfo tableInfo)
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. |
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(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(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(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()
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(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 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(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.