Class PersonCollection

public class PersonCollection : EntityCollectionBase, INestedPersist, IEnumerable<INestedPersist>, ISoCollection, IEnumerable, IList, ICollection, ITableRowLoadHandlerFactory, INotifyCollectionChanged, IBindingList

Remarks

Entity 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 to it, and use methods like to operate on the whole collection.
You can create a (nested) PersonCollection PersonCollection.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(PersonCollection.CustomSearch) method to apply the query to the database and obtain the result as an EntityCollection 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 Person object directly, which has nested classes and GetFromIdx methods for each unique index.

Unique indexes on table Person are:

Index fields	Nested index class name
PersonId	PersonId: Primary key Nested index class: Person.IdxPersonId Static Get method: GetFromIdxPersonId(Int32)

Index fields

Nested index class name

PersonId

PersonId:

Primary key

Nested index class: Person.IdxPersonId

Static Get method: GetFromIdxPersonId(Int32)

Non-unique indexes on table Person are:

Index fields	Nested index class name
CategoryIdx	CategoryIdx: Category if this is a B2C person, otherwise mirror of contact.category_idx Nested index class: SuperOffice.CRM.Entities.PersonCollection.IdxCategoryIdx Static Get method: GetFromIdxCategoryIdx(Int32)
PersonNumber	PersonNumber: Alphanumeric user-field Nested index class: PersonCollection.IdxPersonNumber Static Get method: GetFromIdxPersonNumber(String)
BusinessIdx	BusinessIdx: Business if this is a B2C person, otherwise mirror of contact.business_idx Nested index class: SuperOffice.CRM.Entities.PersonCollection.IdxBusinessIdx Static Get method: GetFromIdxBusinessIdx(Int32)
UserdefId	UserdefId: User-defined table record 1 Nested index class: PersonCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(Int32)
Kanalname	Kanalname: JPN Nested index class: PersonCollection.IdxKanalname Static Get method: GetFromIdxKanalname(String)
Lastname	Lastname: Last name Nested index class: PersonCollection.IdxLastname Static Get method: GetFromIdxLastname(String)
ContactId	ContactId: Owning contact ID, 0 is not allowed Nested index class: PersonCollection.IdxContactId Static Get method: GetFromIdxContactId(Int32)
Userdef2Id	Userdef2Id: User-defined table record 2 Nested index class: PersonCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(Int32)
Firstname	Firstname: First name Nested index class: PersonCollection.IdxFirstname Static Get method: GetFromIdxFirstname(String)
Source	Source: How did we get this person? For future integration requirements Nested index class: PersonCollection.IdxSource Static Get method: GetFromIdxSource(Int16)
Kanafname	Kanafname: JPN Nested index class: PersonCollection.IdxKanafname Static Get method: GetFromIdxKanafname(String)
ContactId, Rank	ContactId: Owning contact ID, 0 is not allowed Rank: Display sort sequence; person with rank 1 has special role in selections (rank is unique within each contact and starts on 1). Nested index class: PersonCollection.IdxContactIdRank Static Get method: GetFromIdxContactIdRank(Int32, Int16)

Constructors

PersonCollection(PersonCollection.PersonCollectionIdx)

Constructor for class PersonCollection.
This object represents a collection of rows in table 'person'. Table contact: Persons in a company or an organisation

Declaration

protected PersonCollection(PersonCollection.PersonCollectionIdx idx)

Parameters

Type	Name	Description
SuperOffice.CRM.Entities.PersonCollection.PersonCollectionIdx	idx

Fields

_idx

Fetcher class the collection is based on

Declaration

protected PersonCollection.PersonCollectionIdx _idx

Field Value

Type	Description
SuperOffice.CRM.Entities.PersonCollection.PersonCollectionIdx

_rows

Row objects that the collection is based on.

Declaration

protected PersonRows _rows

Field Value

Type	Description
PersonRows

Properties

Index

Retrieve the index for PersonCollection

Declaration

public PersonCollection.PersonCollectionIdx Index { get; }

Property Value

Type	Description
SuperOffice.CRM.Entities.PersonCollection.PersonCollectionIdx

Item[Int32]

Get a Person from the collection from its zero-based index.

Declaration

public Person this[int index] { get; }

Parameters

Type	Name	Description
System.Int32	index	Zero-based index in the collection.

Property Value

Type	Description
Person

Rows

The ecapsulated object PersonRows.

Declaration

public PersonRows Rows { get; }

Property Value

Type	Description
PersonRows

Sentries

The collection of sentries that are guarding this collection of rows. This collection is used by RDB entities which return HDB collections.

For example, the contact.Faxes returns a PhoneRows collection in which each row will need to check the contact's sentry for permission to read/write their field

Declaration

public override SentryCollection Sentries { get; }

Property Value

Type	Description
SentryCollection

Overrides

EntityCollectionBase.Sentries

Methods

Add(Person)

Add one Person to the collection.

Declaration

public int Add(Person person)

Parameters

Type	Name	Description
Person	person	An instance of Person to be added to the collection.

Returns

Type	Description
System.Int32	The index of the added Person.

AddNew()

Get a new instance of Person added to the collection.

Declaration

public Person AddNew()

Returns

Type	Description
Person	A new instance of Person added to the collection.

CreateChild()

Create a new instance of Person

Declaration

protected override EntityBase CreateChild()

Returns

Type	Description
EntityBase	New instance of Person

Overrides

EntityCollectionBase.CreateChild()

CreateNew()

Create a new instance of the PersonCollection.

Declaration

public static PersonCollection CreateNew()

Returns

Type	Description
PersonCollection	A new instance of the PersonCollection.

GetFromCustomSearch(PersonCollection.CustomSearch)

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

Declaration

public static PersonCollection GetFromCustomSearch(PersonCollection.CustomSearch query)

Parameters

Type	Name	Description
PersonCollection.CustomSearch	query	The custom search to execute against the database

Returns

Type	Description
PersonCollection	A new instance of the PersonCollection object, reflecting the result of the query.

GetFromIdxBusinessIdx(Int32)

Create a new instance of the PersonRows object, and populate it with PersonRow objects based on the result of a query on the table Person. This method is intended to make it easy to use efficient queries that match a database index.

Declaration

public static PersonCollection GetFromIdxBusinessIdx(int businessIdx)

Parameters

Type	Name	Description
System.Int32	businessIdx	Business if this is a B2C person, otherwise mirror of contact.business_idx

Returns

Type	Description
PersonCollection	New PersonRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index IDXPersBusn_idx. Unique indexes have corresponding Create methods directly on the PersonRow object, since such indexes always return zero or one rows.

GetFromIdxCategoryIdx(Int32)

Declaration

public static PersonCollection GetFromIdxCategoryIdx(int categoryIdx)

Parameters

Type	Name	Description
System.Int32	categoryIdx	Category if this is a B2C person, otherwise mirror of contact.category_idx

Returns

Type	Description
PersonCollection	New PersonRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index IDXPersCatg_idx. Unique indexes have corresponding Create methods directly on the PersonRow object, since such indexes always return zero or one rows.

GetFromIdxContactId(Int32)

Declaration

public static PersonCollection GetFromIdxContactId(int contactId)

Parameters

Type	Name	Description
System.Int32	contactId	Owning contact ID, 0 is not allowed

Returns

Type	Description
PersonCollection	New PersonRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index IDXPersCont_id. Unique indexes have corresponding Create methods directly on the PersonRow object, since such indexes always return zero or one rows.

GetFromIdxContactIdRank(Int32, Int16)

Declaration

public static PersonCollection GetFromIdxContactIdRank(int contactId, short rank)

Parameters

Type	Name	Description
System.Int32	contactId	Owning contact ID, 0 is not allowed
System.Int16	rank	Display sort sequence; person with rank 1 has special role in selections (rank is unique within each contact and starts on 1).

Returns

Type	Description
PersonCollection	New PersonRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index ICont_idRank. Unique indexes have corresponding Create methods directly on the PersonRow object, since such indexes always return zero or one rows.

GetFromIdxFirstname(String)

Declaration

public static PersonCollection GetFromIdxFirstname(string firstname)

Parameters

Type	Name	Description
System.String	firstname	First name

Returns

Type	Description
PersonCollection	New PersonRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index IDXPersFname. Unique indexes have corresponding Create methods directly on the PersonRow object, since such indexes always return zero or one rows.

GetFromIdxKanafname(String)

Declaration

public static PersonCollection GetFromIdxKanafname(string kanafname)

Parameters

Type	Name	Description
System.String	kanafname	JPN

Returns

Type	Description
PersonCollection	New PersonRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index IDXPersKfname. Unique indexes have corresponding Create methods directly on the PersonRow object, since such indexes always return zero or one rows.

GetFromIdxKanalname(String)

Declaration

public static PersonCollection GetFromIdxKanalname(string kanalname)

Parameters

Type	Name	Description
System.String	kanalname	JPN

Returns

Type	Description
PersonCollection	New PersonRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index IDXPersKlname. Unique indexes have corresponding Create methods directly on the PersonRow object, since such indexes always return zero or one rows.

GetFromIdxLastname(String)

Declaration

public static PersonCollection GetFromIdxLastname(string lastname)

Parameters

Type	Name	Description
System.String	lastname	Last name

Returns

Type	Description
PersonCollection	New PersonRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index IDXPersLname. Unique indexes have corresponding Create methods directly on the PersonRow object, since such indexes always return zero or one rows.

GetFromIdxPersonNumber(String)

Declaration

public static PersonCollection GetFromIdxPersonNumber(string personNumber)

Parameters

Type	Name	Description
System.String	personNumber	Alphanumeric user-field

Returns

Type	Description
PersonCollection	New PersonRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index IDXPersPnum. Unique indexes have corresponding Create methods directly on the PersonRow object, since such indexes always return zero or one rows.

GetFromIdxSource(Int16)

Declaration

public static PersonCollection GetFromIdxSource(short source)

Parameters

Type	Name	Description
System.Int16	source	How did we get this person? For future integration requirements

Returns

Type	Description
PersonCollection	New PersonRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index IDXPersSource. Unique indexes have corresponding Create methods directly on the PersonRow object, since such indexes always return zero or one rows.

GetFromIdxUserdef2Id(Int32)

Declaration

public static PersonCollection GetFromIdxUserdef2Id(int userdef2Id)

Parameters

Type	Name	Description
System.Int32	userdef2Id	User-defined table record 2

Returns

Type	Description
PersonCollection	New PersonRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index IDXPersUdef2_id. Unique indexes have corresponding Create methods directly on the PersonRow object, since such indexes always return zero or one rows.

GetFromIdxUserdefId(Int32)

Declaration

public static PersonCollection GetFromIdxUserdefId(int userdefId)

Parameters

Type	Name	Description
System.Int32	userdefId	User-defined table record 1

Returns

Type	Description
PersonCollection	New PersonRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index IDXPersUdef_id. Unique indexes have corresponding Create methods directly on the PersonRow object, since such indexes always return zero or one rows.

Remove(Person)

Removes the given Person from the collection

Declaration

public void Remove(Person person)

Parameters

Type	Name	Description
Person	person	the Person to be removed

ToArray()

Declaration

public Person[] ToArray()

Returns

Type	Description
Person[]

ToString()

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

Declaration

public override string ToString()

Returns

Type	Description
System.String

Implements

INestedPersist

System.Collections.Generic.IEnumerable<>

ISoCollection

System.Collections.IEnumerable

System.Collections.IList

System.Collections.ICollection

System.Collections.Specialized.INotifyCollectionChanged

System.ComponentModel.IBindingList

Extension Methods

EnumUtil.MapEnums<From, To>(From)

Converters.MapEnums<From, To>(From)