Show / Hide Table of Contents

Class PersonList

PersonList implements the person list in SuperOffice.

Inheritance
Object
ListBase<PersonList.PersonListQuery, PersonListItem>
PersonList
Implements
IEnumerable
IEnumerable<PersonListItem>
IList
ICollection
IList<PersonListItem>
ICollection<PersonListItem>
Inherited Members
ListBase<PersonList.PersonListQuery, PersonListItem>.CopyTo(Array, Int32)
ListBase<PersonList.PersonListQuery, PersonListItem>.CopyTo(PersonListItem[], Int32)
ListBase<PersonList.PersonListQuery, PersonListItem>.IndexOf(PersonListItem)
ListBase<PersonList.PersonListQuery, PersonListItem>.Contains(PersonListItem)
ListBase<PersonList.PersonListQuery, PersonListItem>.OnLoad(PersonList.PersonListQuery, SoDataReader)
ListBase<PersonList.PersonListQuery, PersonListItem>.GetEnumerator()
ListBase<PersonList.PersonListQuery, PersonListItem>.Item[Int32]
ListBase<PersonList.PersonListQuery, PersonListItem>.ListCollection
ListBase<PersonList.PersonListQuery, PersonListItem>.Count
ListBase<PersonList.PersonListQuery, PersonListItem>.IsFixedSize
ListBase<PersonList.PersonListQuery, PersonListItem>.IsReadOnly
Namespace: SuperOffice.CRM.Archives
Assembly: SoDataBase.dll
Syntax
public sealed class PersonList : ListBase<PersonList.PersonListQuery, PersonListItem>, IEnumerable, IEnumerable<PersonListItem>, IList, ICollection, IList<PersonListItem>, ICollection<PersonListItem>

Methods

GetPerson(Int32)

Returns the person described by the person_id.

Declaration
public Person GetPerson(int personId)
Parameters
Type Name Description
Int32 personId

The person in question

Returns
Type Description
Person

The person

GetPersonContact(Int32)

Returns the contact on the person described by the person_id. If the person does not exist in the list, we still return the correct contact.

Declaration
public Contact GetPersonContact(int personId)
Parameters
Type Name Description
Int32 personId

The person in question

Returns
Type Description
Contact

The person's contact.

GetPersonListItem(Int32)

Will return the PersonListItem described by the personId.

Declaration
public PersonListItem GetPersonListItem(int personId)
Parameters
Type Name Description
Int32 personId

The person

Returns
Type Description
PersonListItem

The person.

OnLoad(PersonList.PersonListQuery, SoDataReader)

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

Declaration
protected override void OnLoad(PersonList.PersonListQuery query, SoDataReader reader)
Parameters
Type Name Description
PersonList.PersonListQuery query
SoDataReader reader

The reader which contains all data in the list.

Overrides
SuperOffice.CRM.Lists.ListBase<SuperOffice.CRM.Archives.PersonList.PersonListQuery, SuperOffice.CRM.Archives.PersonListItem>.OnLoad(SuperOffice.CRM.Archives.PersonList.PersonListQuery, SuperOffice.Data.SoDataReader)

PersonExist(Int32)

Checks if the person described by the person_id exist in the list.

Declaration
public bool PersonExist(int personId)
Parameters
Type Name Description
Int32 personId

The person

Returns
Type Description
Boolean

True/false

Implements

System.Collections.IEnumerable
System.Collections.Generic.IEnumerable<T>
System.Collections.IList
System.Collections.ICollection
System.Collections.Generic.IList<T>
System.Collections.Generic.ICollection<T>

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