Class ProjectMemberCollection

Link-table between person and project

Collection of ProjectMember. Each element of the collection represents one entity based on ProjectMember.
Inheritance
System.Object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
EntityCollectionBase
ProjectMemberCollection
Implements
System.Collections.Generic.IEnumerable<INestedPersist>
System.Collections.IList
System.Collections.ICollection
System.Collections.IEnumerable
System.Collections.Specialized.INotifyCollectionChanged
System.ComponentModel.IBindingList
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: SuperOffice.CRM.Entities
Assembly: SoDataBase.dll
Syntax
public class ProjectMemberCollection : EntityCollectionBase, INestedPersist, IEnumerable<INestedPersist>, ISoCollection, IList, ICollection, IEnumerable, 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) ProjectMemberCollection ProjectMemberCollection.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(ProjectMemberCollection.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 ProjectMember object directly, which has nested classes and GetFromIdx methods for each unique index.

Unique indexes on table ProjectMember are:

Index fieldsNested index class name
ProjectmemberIdProjectmemberId:

Primary key

Nested index class: ProjectMember.IdxProjectmemberId

Static Get method: GetFromIdxProjectmemberId(Int32)

Non-unique indexes on table ProjectMember are:
Index fieldsNested index class name
PersonIdPersonId:

person_id

Nested index class: ProjectMemberCollection.IdxPersonId

Static Get method: GetFromIdxPersonId(Int32)

ContactIdContactId:

contact_id of person (denormalisation!)

Nested index class: ProjectMemberCollection.IdxContactId

Static Get method: GetFromIdxContactId(Int32)

ProjectId, RankProjectId:

Parent project

Rank:

Rank in list (starts over for each project)

Nested index class: ProjectMemberCollection.IdxProjectIdRank

Static Get method: GetFromIdxProjectIdRank(Int32, Int16)

Constructors

ProjectMemberCollection(ProjectMemberCollection.ProjectMemberCollectionIdx)

Constructor for class ProjectMemberCollection.
This object represents a collection of rows in table 'projectmember'. Table contact: Project members

Declaration
protected ProjectMemberCollection(ProjectMemberCollection.ProjectMemberCollectionIdx idx)
Parameters
Type Name Description
ProjectMemberCollection.ProjectMemberCollectionIdx idx

Fields

_idx

Fetcher class the collection is based on

Declaration
protected ProjectMemberCollection.ProjectMemberCollectionIdx _idx
Field Value
Type Description
ProjectMemberCollection.ProjectMemberCollectionIdx

_rows

Row objects that the collection is based on.

Declaration
protected ProjectMemberRows _rows
Field Value
Type Description
ProjectMemberRows

Properties

Index

Retrieve the index for ProjectMemberCollection

Declaration
public ProjectMemberCollection.ProjectMemberCollectionIdx Index { get; }
Property Value
Type Description
ProjectMemberCollection.ProjectMemberCollectionIdx

Item[Int32]

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

Declaration
public ProjectMember this[int index] { get; }
Parameters
Type Name Description
System.Int32 index

Zero-based index in the collection.
Property Value
Type Description
ProjectMember

Rows

The ecapsulated object ProjectMemberRows.

Declaration
public ProjectMemberRows Rows { get; }
Property Value
Type Description
ProjectMemberRows

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

Methods

Add(ProjectMember)

Add one ProjectMember to the collection.

Declaration
public int Add(ProjectMember projectMember)
Parameters
Type Name Description
ProjectMember projectMember

An instance of ProjectMember to be added to the collection.
Returns
Type Description
System.Int32

The index of the added ProjectMember.

AddNew()

Get a new instance of ProjectMember added to the collection.

Declaration
public ProjectMember AddNew()
Returns
Type Description
ProjectMember

A new instance of ProjectMember added to the collection.

CreateChild()

Create a new instance of ProjectMember

Declaration
protected override EntityBase CreateChild()
Returns
Type Description
EntityBase

New instance of ProjectMember
Overrides

CreateNew()

Create a new instance of the ProjectMemberCollection.

Declaration
public static ProjectMemberCollection CreateNew()
Returns
Type Description
ProjectMemberCollection

A new instance of the ProjectMemberCollection.

GetFromCustomSearch(ProjectMemberCollection.CustomSearch)

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

Declaration
public static ProjectMemberCollection GetFromCustomSearch(ProjectMemberCollection.CustomSearch query)
Parameters
Type Name Description
ProjectMemberCollection.CustomSearch query

The custom search to execute against the database
Returns
Type Description
ProjectMemberCollection

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

GetFromIdxContactId(Int32)

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

Declaration
public static ProjectMemberCollection GetFromIdxContactId(int contactId)
Parameters
Type Name Description
System.Int32 contactId

contact_id of person (denormalisation!)

Returns
Type Description
ProjectMemberCollection

New ProjectMemberRows 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 IDXPmembContact_id. Unique indexes have corresponding Create methods directly on the ProjectMemberRow object, since such indexes always return zero or one rows.

GetFromIdxPersonId(Int32)

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

Declaration
public static ProjectMemberCollection GetFromIdxPersonId(int personId)
Parameters
Type Name Description
System.Int32 personId

person_id

Returns
Type Description
ProjectMemberCollection

New ProjectMemberRows 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 IDXPmembPerson_id. Unique indexes have corresponding Create methods directly on the ProjectMemberRow object, since such indexes always return zero or one rows.

GetFromIdxProjectIdRank(Int32, Int16)

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

Declaration
public static ProjectMemberCollection GetFromIdxProjectIdRank(int projectId, short rank)
Parameters
Type Name Description
System.Int32 projectId

Parent project

System.Int16 rank

Rank in list (starts over for each project)

Returns
Type Description
ProjectMemberCollection

New ProjectMemberRows 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 IProj_idRank. Unique indexes have corresponding Create methods directly on the ProjectMemberRow object, since such indexes always return zero or one rows.

Remove(ProjectMember)

Removes the given ProjectMember from the collection

Declaration
public void Remove(ProjectMember projectMember)
Parameters
Type Name Description
ProjectMember projectMember

the ProjectMember to be removed

ToArray()

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

ToString()

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

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.Object.ToString()

Implements

System.Collections.Generic.IEnumerable<T>
System.Collections.IList
System.Collections.ICollection
System.Collections.IEnumerable
System.Collections.Specialized.INotifyCollectionChanged
System.ComponentModel.IBindingList

Extension Methods

EnumUtil.MapEnums<From, To>(From)