Class StatusValueRows

Values for statuses Collection of StatusValueRow. Each element of the collection represents one row in the StatusValue table.

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

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

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

Add one StatusValueRow to the collection.

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

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

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

Declaration
public StatusValueRow AddNew()
Returns
Type Description
StatusValueRow

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

Add a range of StatusValueRow to the collection.

Declaration
public StatusValueRows AddRange(IEnumerable<StatusValueRow> rows)
Parameters
Type Name Description
IEnumerable<StatusValueRow> rows
Returns
Type Description
StatusValueRows

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

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

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

Declaration
public static StatusValueRows CreateNew()
Returns
Type Description
StatusValueRows

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

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

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

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

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

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

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

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

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

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

GetFromIdxContactIdAsync(int, CancellationToken)

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

Declaration
public static Task<StatusValueRows> GetFromIdxContactIdAsync(int contactId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int contactId
CancellationToken cancellationToken
Returns
Type Description
Task<StatusValueRows>

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

GetFromIdxContactIdIsSignalledAsync(int, short, CancellationToken)

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

Declaration
public static Task<StatusValueRows> GetFromIdxContactIdIsSignalledAsync(int contactId, short isSignalled, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int contactId
short isSignalled
CancellationToken cancellationToken
Returns
Type Description
Task<StatusValueRows>

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

GetFromIdxContactIdIsSignalledStatusDefIdAsync(int, short, int, CancellationToken)

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

Declaration
public static Task<StatusValueRows> GetFromIdxContactIdIsSignalledStatusDefIdAsync(int contactId, short isSignalled, int statusDefId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int contactId
short isSignalled
int statusDefId
CancellationToken cancellationToken
Returns
Type Description
Task<StatusValueRows>

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

GetFromIdxExtra1IdAsync(int, CancellationToken)

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

Declaration
public static Task<StatusValueRows> GetFromIdxExtra1IdAsync(int extra1Id, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int extra1Id
CancellationToken cancellationToken
Returns
Type Description
Task<StatusValueRows>

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

GetFromIdxExtra1IdIsSignalledAsync(int, short, CancellationToken)

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

Declaration
public static Task<StatusValueRows> GetFromIdxExtra1IdIsSignalledAsync(int extra1Id, short isSignalled, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int extra1Id
short isSignalled
CancellationToken cancellationToken
Returns
Type Description
Task<StatusValueRows>

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

GetFromIdxExtra1IdIsSignalledStatusDefIdAsync(int, short, int, CancellationToken)

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

Declaration
public static Task<StatusValueRows> GetFromIdxExtra1IdIsSignalledStatusDefIdAsync(int extra1Id, short isSignalled, int statusDefId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int extra1Id
short isSignalled
int statusDefId
CancellationToken cancellationToken
Returns
Type Description
Task<StatusValueRows>

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

GetFromIdxExtra2IdAsync(int, CancellationToken)

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

Declaration
public static Task<StatusValueRows> GetFromIdxExtra2IdAsync(int extra2Id, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int extra2Id
CancellationToken cancellationToken
Returns
Type Description
Task<StatusValueRows>

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

GetFromIdxExtra2IdIsSignalledAsync(int, short, CancellationToken)

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

Declaration
public static Task<StatusValueRows> GetFromIdxExtra2IdIsSignalledAsync(int extra2Id, short isSignalled, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int extra2Id
short isSignalled
CancellationToken cancellationToken
Returns
Type Description
Task<StatusValueRows>

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

GetFromIdxExtra2IdIsSignalledStatusDefIdAsync(int, short, int, CancellationToken)

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

Declaration
public static Task<StatusValueRows> GetFromIdxExtra2IdIsSignalledStatusDefIdAsync(int extra2Id, short isSignalled, int statusDefId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int extra2Id
short isSignalled
int statusDefId
CancellationToken cancellationToken
Returns
Type Description
Task<StatusValueRows>

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

GetFromIdxIsSignalledAsync(short, CancellationToken)

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

Declaration
public static Task<StatusValueRows> GetFromIdxIsSignalledAsync(short isSignalled, CancellationToken cancellationToken = default)
Parameters
Type Name Description
short isSignalled
CancellationToken cancellationToken
Returns
Type Description
Task<StatusValueRows>

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

GetFromIdxPersonIdAsync(int, CancellationToken)

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

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

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

GetFromIdxPersonIdIsSignalledAsync(int, short, CancellationToken)

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

Declaration
public static Task<StatusValueRows> GetFromIdxPersonIdIsSignalledAsync(int personId, short isSignalled, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int personId
short isSignalled
CancellationToken cancellationToken
Returns
Type Description
Task<StatusValueRows>

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

GetFromIdxPersonIdIsSignalledStatusDefIdAsync(int, short, int, CancellationToken)

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

Declaration
public static Task<StatusValueRows> GetFromIdxPersonIdIsSignalledStatusDefIdAsync(int personId, short isSignalled, int statusDefId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int personId
short isSignalled
int statusDefId
CancellationToken cancellationToken
Returns
Type Description
Task<StatusValueRows>

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

GetFromIdxProjectIdAsync(int, CancellationToken)

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

Declaration
public static Task<StatusValueRows> GetFromIdxProjectIdAsync(int projectId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int projectId
CancellationToken cancellationToken
Returns
Type Description
Task<StatusValueRows>

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

GetFromIdxProjectIdIsSignalledAsync(int, short, CancellationToken)

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

Declaration
public static Task<StatusValueRows> GetFromIdxProjectIdIsSignalledAsync(int projectId, short isSignalled, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int projectId
short isSignalled
CancellationToken cancellationToken
Returns
Type Description
Task<StatusValueRows>

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

GetFromIdxProjectIdIsSignalledStatusDefIdAsync(int, short, int, CancellationToken)

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

Declaration
public static Task<StatusValueRows> GetFromIdxProjectIdIsSignalledStatusDefIdAsync(int projectId, short isSignalled, int statusDefId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int projectId
short isSignalled
int statusDefId
CancellationToken cancellationToken
Returns
Type Description
Task<StatusValueRows>

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

GetFromIdxStatusDefIdAsync(int, CancellationToken)

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

Declaration
public static Task<StatusValueRows> GetFromIdxStatusDefIdAsync(int statusDefId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int statusDefId
CancellationToken cancellationToken
Returns
Type Description
Task<StatusValueRows>

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

GetFromReaderAsync(SoDataReader, StatusValueTableInfo, CancellationToken)

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

SoDataReader positioned to a valid database row.
StatusValueTableInfo tableInfo

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

Removes the given StatusValueRow from the collection

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

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

Values for statuses Collection of StatusValueRow. Each element of the collection represents one row in the StatusValue table.

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