Class ListSelect

The ListSelect class is the base-class for all simple lists.

Inheritance
object
SqlCommand
PrivateSelect
ListSelect
ContactList.ContactListQuery
DocumentList.DocumentListQuery
PersonList.PersonListQuery
ProjectEventList.ProjectEventListQuery
ProjectList.ProjectListQuery
ProjectMemberList.ProjectMemberListQuery
SaleList.SaleListQuery
UserList.UserListQuery
Implements
Inherited Members
Namespace: SuperOfficeCRMLists
Assembly: SoDataBase.dll
Syntax
public abstract class ListSelect : PrivateSelect, ICloneable

Constructors

ListSelect()

Default constructor

Declaration
protected ListSelect()

Fields

_fields

Declaration
protected ReturnFieldsCollection _fields
Field Value
Type Description
ReturnFieldsCollection

_groupBy

Declaration
protected GroupBy _groupBy
Field Value
Type Description
GroupBy

_joinRestriction

Declaration
protected JoinRestriction _joinRestriction
Field Value
Type Description
JoinRestriction

_orderBy

Declaration
protected OrderBy _orderBy
Field Value
Type Description
OrderBy

_restriction

Declaration
protected Restriction _restriction
Field Value
Type Description
Restriction

Properties

InnerGroupBy

Implementation of the Group by clause.

Declaration
protected override GroupBy InnerGroupBy { get; }
Property Value
Type Description
GroupBy
Overrides

InnerJoinRestriction

Implementation of InnerJoinRestriction enabling the
Dialect to get the JoinRestriction object through the PrivateSelect class.

Declaration
protected override JoinRestriction InnerJoinRestriction { get; }
Property Value
Type Description
JoinRestriction
Overrides

InnerOrderBy

Implementation of the OrderBy clause.

Declaration
protected override OrderBy InnerOrderBy { get; }
Property Value
Type Description
OrderBy
Overrides

InnerRestriction

Implementation of InnerRestriction enabling the
Dialect to get the Restriction object through the PrivateSelect class.

Declaration
protected override Restriction InnerRestriction { get; }
Property Value
Type Description
Restriction
Overrides

InnerReturnFields

Implementation of InnerReturnFields enabling the Dialect to get the ReturnFieldsCollection object through the PrivateSelect class

Declaration
protected override ReturnFieldsCollection InnerReturnFields { get; }
Property Value
Type Description
ReturnFieldsCollection
Overrides

Methods

CreateListReaderAsync(SoConnection, PrivateSelect, int, CancellationToken, params Sentry[])

Declaration
protected static Task<SoDataReader> CreateListReaderAsync(SoConnection con, PrivateSelect select, int maxRows, CancellationToken cancellationToken, params Sentry[] sentries)
Parameters
Type Name Description
SoConnection con
PrivateSelect select
int maxRows
CancellationToken cancellationToken
Sentry sentries
Returns
Type Description
TaskSoDataReader

CreateListReaderAsync(SoConnection, PrivateSelect, CancellationToken, params Sentry[])

CreateListReader will generate the query and populate the SoDataReader.

Declaration
protected static Task<SoDataReader> CreateListReaderAsync(SoConnection con, PrivateSelect select, CancellationToken cancellationToken, params Sentry[] sentries)
Parameters
Type Name Description
SoConnection con

Connection used to create the reader
PrivateSelect select

The select object-structure which contains the query-structure.
CancellationToken cancellationToken
Sentry sentries

Array of Sentry objects to be used
Returns
Type Description
TaskSoDataReader

A populated data-reader.
Examples

Remember to close the connection and the reader:

using (SoConnection con = ConnectionFactory.GetConnection())
{
    using (SoDataReader reader = CreateListReader(con, this, sentries))
    {
        list.OnLoad(reader);
    }
}

Implements

Extension Methods