Class SORPublishRows

SuperOffice reporter data Collection of SORPublishRow. Each element of the collection represents one row in the SORPublish table.

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

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

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

Methods

Add(SORPublishRow)

Add one SORPublishRow to the collection.

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

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

The index of the added SORPublishRow.

AddNew()

Add a new instance of SORPublishRow added to the collection.

Declaration
public SORPublishRow AddNew()
Returns
Type Description
SORPublishRow

A new instance of SORPublishRow added to the collection.

AddRange(IEnumerable<SORPublishRow>)

Add a range of SORPublishRow to the collection.

Declaration
public SORPublishRows AddRange(IEnumerable<SORPublishRow> rows)
Parameters
Type Name Description
IEnumerableSORPublishRow rows
Returns
Type Description
SORPublishRows

The updated SORPublishRows collection object.

CreateChild()

Create a new instance of SORPublishRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of SORPublishRow
Overrides

CreateNew()

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

Declaration
public static SORPublishRows CreateNew()
Returns
Type Description
SORPublishRows

A new instance of the SORPublishRows object.

Find(Predicate<SORPublishRow>)

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

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

FindAll(Predicate<SORPublishRow>)

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

Declaration
public SORPublishRows FindAll(Predicate<SORPublishRow> condition)
Parameters
Type Name Description
PredicateSORPublishRow condition
Returns
Type Description
SORPublishRows

ForEach(Action<SORPublishRow>)

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

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

GetFromCustomSearchAsync(CustomSearch, CancellationToken)

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

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

The custom search to execute against the database
CancellationToken cancellationToken
Returns
Type Description
TaskSORPublishRows

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

GetFromIdxAssociateIdAsync(int, CancellationToken)

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

Declaration
public static Task<SORPublishRows> GetFromIdxAssociateIdAsync(int associateId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int associateId
CancellationToken cancellationToken
Returns
Type Description
TaskSORPublishRows

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

GetFromIdxDefaultLabelLayoutAsync(int, CancellationToken)

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

Declaration
public static Task<SORPublishRows> GetFromIdxDefaultLabelLayoutAsync(int defaultLabelLayout, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int defaultLabelLayout
CancellationToken cancellationToken
Returns
Type Description
TaskSORPublishRows

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

GetFromIdxForceDefaultAsync(short, CancellationToken)

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

Declaration
public static Task<SORPublishRows> GetFromIdxForceDefaultAsync(short forceDefault, CancellationToken cancellationToken = default)
Parameters
Type Name Description
short forceDefault
CancellationToken cancellationToken
Returns
Type Description
TaskSORPublishRows

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

GetFromIdxNameAsync(string, CancellationToken)

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

Declaration
public static Task<SORPublishRows> GetFromIdxNameAsync(string name, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string name
CancellationToken cancellationToken
Returns
Type Description
TaskSORPublishRows

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

GetFromIdxSORTemplateIdAsync(int, CancellationToken)

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

Declaration
public static Task<SORPublishRows> GetFromIdxSORTemplateIdAsync(int sORTemplateId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int sORTemplateId
CancellationToken cancellationToken
Returns
Type Description
TaskSORPublishRows

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

GetFromReaderAsync(SoDataReader, SORPublishTableInfo, CancellationToken)

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

SoDataReader positioned to a valid database row.
SORPublishTableInfo tableInfo

SORPublishTableInfo 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
TaskSORPublishRows

Remove(SORPublishRow)

Removes the given SORPublishRow from the collection

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

the SORPublishRow to be removed

ToArray()

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

ToString()

For debugging: Number of members, and the first (up to) 5 items

Declaration
public override string ToString()
Returns
Type Description
string
Overrides

Implements

Extension Methods