Show / Hide Table of Contents

Class ProjectList

ProjectList implements the Projectlist in SuperOffice.

Inheritance
object
ListBase<ProjectList.ProjectListQuery, ProjectListItem>
ProjectList
Implements
IList
ICollection
IList<ProjectListItem>
ICollection<ProjectListItem>
IEnumerable<ProjectListItem>
IEnumerable
Inherited Members
ListBase<ProjectList.ProjectListQuery, ProjectListItem>.CopyTo(Array, int)
ListBase<ProjectList.ProjectListQuery, ProjectListItem>.CopyTo(ProjectListItem[], int)
ListBase<ProjectList.ProjectListQuery, ProjectListItem>.IndexOf(ProjectListItem)
ListBase<ProjectList.ProjectListQuery, ProjectListItem>.Contains(ProjectListItem)
ListBase<ProjectList.ProjectListQuery, ProjectListItem>.GetEnumerator()
ListBase<ProjectList.ProjectListQuery, ProjectListItem>.this[int]
ListBase<ProjectList.ProjectListQuery, ProjectListItem>.Count
ListBase<ProjectList.ProjectListQuery, ProjectListItem>.IsFixedSize
ListBase<ProjectList.ProjectListQuery, ProjectListItem>.IsReadOnly
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
Namespace: SuperOffice.CRM.Archives
Assembly: SoDataBase.dll
Syntax
public sealed class ProjectList : ListBase<ProjectList.ProjectListQuery, ProjectListItem>, IList, ICollection, IList<ProjectListItem>, ICollection<ProjectListItem>, IEnumerable<ProjectListItem>, IEnumerable

Methods

GetProject(int)

Returns the project corresponding to the project_id.

Declaration
public Project GetProject(int projectId)
Parameters
Type Name Description
int projectId

The project.

Returns
Type Description
Project

The project.

GetProjectListFromContactAsync(Contact, CancellationToken)

Returns the project list that corresponds to the contact.

Declaration
public Task<ProjectList> GetProjectListFromContactAsync(Contact contact, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Contact contact

The contact to build the list from.

CancellationToken cancellationToken
Returns
Type Description
Task<ProjectList>

The project list.

GetProjectListFromContactAsync(ContactRow, CancellationToken)

Returns the project list that corresponds to the contact-row.

Declaration
public Task<ProjectList> GetProjectListFromContactAsync(ContactRow row, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ContactRow row

The contact to build the list from.

CancellationToken cancellationToken
Returns
Type Description
Task<ProjectList>

The project list.

GetProjectListFromContactAsync(int, CancellationToken)

Returns the project list that corresponds to the contact_id.

Declaration
public Task<ProjectList> GetProjectListFromContactAsync(int contactId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int contactId

The contact to build the list from.

CancellationToken cancellationToken
Returns
Type Description
Task<ProjectList>

The project list.

GetProjectListItem(int)

Will return the ProjectListItem described by the projectId.

Declaration
public ProjectListItem GetProjectListItem(int projectId)
Parameters
Type Name Description
int projectId

The project

Returns
Type Description
ProjectListItem

The project

OnLoadAsync(ProjectListQuery, SoDataReader, CancellationToken)

Responsible for reading each row with data from the SoDataReader and insert the object each row represents into the class' collection.

Declaration
protected override Task OnLoadAsync(ProjectList.ProjectListQuery query, SoDataReader reader, CancellationToken cancellationToken)
Parameters
Type Name Description
ProjectList.ProjectListQuery query
SoDataReader reader

The reader which contains all data in the list.

CancellationToken cancellationToken
Returns
Type Description
Task
Overrides
ListBase<ProjectList.ProjectListQuery, ProjectListItem>.OnLoadAsync(ProjectList.ProjectListQuery, SoDataReader, CancellationToken)

ProjectExist(int)

Checks if the project described by the project_id exist in the list.

Declaration
public bool ProjectExist(int projectId)
Parameters
Type Name Description
int projectId

The project

Returns
Type Description
bool

True/false

Implements

IList
ICollection
IList<T>
ICollection<T>
IEnumerable<T>
IEnumerable

Extension Methods

EnumUtil.MapEnums<From, To>(From)
Converters.MapEnums<From, To>(From)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top