Class SaleCollection
Sales
For every Sale record edited through the SuperOffice GUI, a copy of the previous version of the record will be saved in the SaleHist table. This also applies to editing done through the SaleModel COM interface, but not to editing done through the OLE DB Provider or other channels.
Collection of Sale. Each element of the collection represents one entity based on Sale.Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.Entities
Assembly: SoDataBase.dll
Syntax
public class SaleCollection : EntityCollectionBase, INestedPersist, IEnumerable<INestedPersist>, ISoCollection, IList, ICollection, IEnumerable, ITableRowLoadHandlerFactory, INotifyCollectionChanged, IBindingListRemarks
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) SaleCollection SaleCollection.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(SaleCollection.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 on table Sale are:
| Index fields | Nested index class name |
|---|---|
| SaleId | SaleId: Primary key Nested index class: Sale.IdxSaleIdStatic Get method: GetFromIdxSaleId(Int32) |
| Index fields | Nested index class name |
|---|---|
| Status | Status: Status (open, closed, lost) Nested index class: SaleCollection.IdxStatusStatic Get method: GetFromIdxStatus(SaleStatus) |
| Done | Done: Done (0 = don’t know; 1 = No; 2 = yes) Nested index class: SaleCollection.IdxDoneStatic Get method: GetFromIdxDone(SaleDone) |
| UserdefId | UserdefId: User-defined fields reference Nested index class: SaleCollection.IdxUserdefIdStatic Get method: GetFromIdxUserdefId(Int32) |
| Userdef2Id | Userdef2Id: User-defined fields reference Nested index class: SaleCollection.IdxUserdef2IdStatic Get method: GetFromIdxUserdef2Id(Int32) |
| ProjectId | ProjectId: Optional project reference Nested index class: SaleCollection.IdxProjectIdStatic Get method: GetFromIdxProjectId(Int32) |
| Source | Source: For future integration use; source of record Nested index class: SaleCollection.IdxSourceStatic Get method: GetFromIdxSource(Int16) |
| Heading | Heading: Sale heading (short description) Nested index class: SaleCollection.IdxHeadingStatic Get method: GetFromIdxHeading(String) |
| ProjectId, AssociateId, Saledate | ProjectId: Optional project reference AssociateId:Owning associate Saledate:(expected | lost | won) sales date Nested index class: SaleCollection.IdxProjectIdAssociateIdSaledateStatic Get method: GetFromIdxProjectIdAssociateIdSaledate(Int32, Int32, DateTime) |
| PersonId | PersonId: Optional person reference Nested index class: SaleCollection.IdxPersonIdStatic Get method: GetFromIdxPersonId(Int32) |
| AssociateId, Done, Saledate | AssociateId: Owning associate Done:Done (0 = don’t know; 1 = No; 2 = yes) Saledate:(expected | lost | won) sales date Nested index class: SaleCollection.IdxAssociateIdDoneSaledateStatic Get method: GetFromIdxAssociateIdDoneSaledate(Int32, SaleDone, DateTime) |
| ContactId | ContactId: Optional contact reference Nested index class: SaleCollection.IdxContactIdStatic Get method: GetFromIdxContactId(Int32) |
| Saledate | Saledate: (expected | lost | won) sales date Nested index class: SaleCollection.IdxSaledateStatic Get method: GetFromIdxSaledate(DateTime) |
| Number1 | Number1: Alphanumeric user field Nested index class: SaleCollection.IdxNumber1Static Get method: GetFromIdxNumber1(String) |
| AssociateId, ContactId, Saledate | AssociateId: Owning associate ContactId:Optional contact reference Saledate:(expected | lost | won) sales date Nested index class: SaleCollection.IdxAssociateIdContactIdSaledateStatic Get method: GetFromIdxAssociateIdContactIdSaledate(Int32, Int32, DateTime) |
Constructors
SaleCollection(SaleCollection.SaleCollectionIdx)
Constructor for class SaleCollection.
This object represents a collection of rows in table 'sale'.
Table contact: Sales
Declaration
protected SaleCollection(SaleCollection.SaleCollectionIdx idx)Parameters
| Type | Name | Description |
|---|---|---|
| SaleCollection.SaleCollectionIdx | idx |
Fields
_idx
Fetcher class the collection is based on
Declaration
protected SaleCollection.SaleCollectionIdx _idxField Value
| Type | Description |
|---|---|
| SaleCollection.SaleCollectionIdx |
_rows
Row objects that the collection is based on.
Declaration
protected SaleRows _rowsField Value
| Type | Description |
|---|---|
| SaleRows |
Properties
Index
Retrieve the index for SaleCollection
Declaration
public SaleCollection.SaleCollectionIdx Index { get; }Property Value
| Type | Description |
|---|---|
| SaleCollection.SaleCollectionIdx |
Item[Int32]
Get a Sale from the collection from its zero-based index.
Declaration
public Sale this[int index] { get; }Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | index | Zero-based index in the collection. |
Property Value
| Type | Description |
|---|---|
| Sale |
Rows
The ecapsulated object SaleRows.
Declaration
public SaleRows Rows { get; }Property Value
| Type | Description |
|---|---|
| SaleRows |
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(Sale)
Add one Sale to the collection.
Declaration
public int Add(Sale sale)Parameters
| Type | Name | Description |
|---|---|---|
| Sale | sale | An instance of Sale to be added to the collection. |
Returns
| Type | Description |
|---|---|
| Int32 | The index of the added Sale. |
AddNew()
Get a new instance of Sale added to the collection.
Declaration
public Sale AddNew()Returns
| Type | Description |
|---|---|
| Sale | A new instance of Sale added to the collection. |
CreateChild()
Create a new instance of Sale
Declaration
protected override EntityBase CreateChild()Returns
| Type | Description |
|---|---|
| EntityBase | New instance of Sale |
Overrides
CreateNew()
Create a new instance of the SaleCollection.
Declaration
public static SaleCollection CreateNew()Returns
| Type | Description |
|---|---|
| SaleCollection | A new instance of the SaleCollection. |
GetFromCustomSearch(SaleCollection.CustomSearch)
Create a new instance of the SaleCollection 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 SaleRow objects representing each row will be returned.
Declaration
public static SaleCollection GetFromCustomSearch(SaleCollection.CustomSearch query)Parameters
| Type | Name | Description |
|---|---|---|
| SaleCollection.CustomSearch | query | The custom search to execute against the database |
Returns
| Type | Description |
|---|---|
| SaleCollection | A new instance of the SaleCollection object, reflecting the result of the query. |
GetFromIdxAssociateIdContactIdSaledate(Int32, Int32, DateTime)
Create a new instance of the SaleRows object, and populate it with SaleRow objects based on the result of a query on the table Sale. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static SaleCollection GetFromIdxAssociateIdContactIdSaledate(int associateId, int contactId, DateTime saledate)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | associateId | Owning associate |
| Int32 | contactId | Optional contact reference |
| DateTime | saledate | (expected | lost | won) sales date |
Returns
| Type | Description |
|---|---|
| SaleCollection | New SaleRows 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_idSaledateAssoc_id. Unique indexes have corresponding Create methods directly on the SaleRow object, since such indexes always return zero or one rows.
GetFromIdxAssociateIdDoneSaledate(Int32, SaleDone, DateTime)
Create a new instance of the SaleRows object, and populate it with SaleRow objects based on the result of a query on the table Sale. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static SaleCollection GetFromIdxAssociateIdDoneSaledate(int associateId, SaleDone done, DateTime saledate)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | associateId | Owning associate |
| SaleDone | done | Done (0 = don’t know; 1 = No; 2 = yes) |
| DateTime | saledate | (expected | lost | won) sales date |
Returns
| Type | Description |
|---|---|
| SaleCollection | New SaleRows 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 IAssoc_idDoneSaledate. Unique indexes have corresponding Create methods directly on the SaleRow object, since such indexes always return zero or one rows.
GetFromIdxContactId(Int32)
Create a new instance of the SaleRows object, and populate it with SaleRow objects based on the result of a query on the table Sale. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static SaleCollection GetFromIdxContactId(int contactId)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | contactId | Optional contact reference |
Returns
| Type | Description |
|---|---|
| SaleCollection | New SaleRows 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 IDXSaleCont_id. Unique indexes have corresponding Create methods directly on the SaleRow object, since such indexes always return zero or one rows.
GetFromIdxDone(SaleDone)
Create a new instance of the SaleRows object, and populate it with SaleRow objects based on the result of a query on the table Sale. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static SaleCollection GetFromIdxDone(SaleDone done)Parameters
| Type | Name | Description |
|---|---|---|
| SaleDone | done | Done (0 = don’t know; 1 = No; 2 = yes) |
Returns
| Type | Description |
|---|---|
| SaleCollection | New SaleRows 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 IDXSaleDone. Unique indexes have corresponding Create methods directly on the SaleRow object, since such indexes always return zero or one rows.
GetFromIdxHeading(String)
Create a new instance of the SaleRows object, and populate it with SaleRow objects based on the result of a query on the table Sale. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static SaleCollection GetFromIdxHeading(string heading)Parameters
| Type | Name | Description |
|---|---|---|
| String | heading | Sale heading (short description) |
Returns
| Type | Description |
|---|---|
| SaleCollection | New SaleRows 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 IDXSaleHeading. Unique indexes have corresponding Create methods directly on the SaleRow object, since such indexes always return zero or one rows.
GetFromIdxNumber1(String)
Create a new instance of the SaleRows object, and populate it with SaleRow objects based on the result of a query on the table Sale. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static SaleCollection GetFromIdxNumber1(string number1)Parameters
| Type | Name | Description |
|---|---|---|
| String | number1 | Alphanumeric user field |
Returns
| Type | Description |
|---|---|
| SaleCollection | New SaleRows 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 IDXSaleNum1. Unique indexes have corresponding Create methods directly on the SaleRow object, since such indexes always return zero or one rows.
GetFromIdxPersonId(Int32)
Create a new instance of the SaleRows object, and populate it with SaleRow objects based on the result of a query on the table Sale. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static SaleCollection GetFromIdxPersonId(int personId)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | personId | Optional person reference |
Returns
| Type | Description |
|---|---|
| SaleCollection | New SaleRows 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 IDXSalePers_id. Unique indexes have corresponding Create methods directly on the SaleRow object, since such indexes always return zero or one rows.
GetFromIdxProjectId(Int32)
Create a new instance of the SaleRows object, and populate it with SaleRow objects based on the result of a query on the table Sale. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static SaleCollection GetFromIdxProjectId(int projectId)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | projectId | Optional project reference |
Returns
| Type | Description |
|---|---|
| SaleCollection | New SaleRows 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 IDXSaleProj_id. Unique indexes have corresponding Create methods directly on the SaleRow object, since such indexes always return zero or one rows.
GetFromIdxProjectIdAssociateIdSaledate(Int32, Int32, DateTime)
Create a new instance of the SaleRows object, and populate it with SaleRow objects based on the result of a query on the table Sale. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static SaleCollection GetFromIdxProjectIdAssociateIdSaledate(int projectId, int associateId, DateTime saledate)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | projectId | Optional project reference |
| Int32 | associateId | Owning associate |
| DateTime | saledate | (expected | lost | won) sales date |
Returns
| Type | Description |
|---|---|
| SaleCollection | New SaleRows 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_idSaledateAssoc_id. Unique indexes have corresponding Create methods directly on the SaleRow object, since such indexes always return zero or one rows.
GetFromIdxSaledate(DateTime)
Create a new instance of the SaleRows object, and populate it with SaleRow objects based on the result of a query on the table Sale. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static SaleCollection GetFromIdxSaledate(DateTime saledate)Parameters
| Type | Name | Description |
|---|---|---|
| DateTime | saledate | (expected | lost | won) sales date |
Returns
| Type | Description |
|---|---|
| SaleCollection | New SaleRows 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 IDXSaleSaledate. Unique indexes have corresponding Create methods directly on the SaleRow object, since such indexes always return zero or one rows.
GetFromIdxSource(Int16)
Create a new instance of the SaleRows object, and populate it with SaleRow objects based on the result of a query on the table Sale. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static SaleCollection GetFromIdxSource(short source)Parameters
| Type | Name | Description |
|---|---|---|
| Int16 | source | For future integration use; source of record |
Returns
| Type | Description |
|---|---|
| SaleCollection | New SaleRows 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 IDXSaleSource. Unique indexes have corresponding Create methods directly on the SaleRow object, since such indexes always return zero or one rows.
GetFromIdxStatus(SaleStatus)
Create a new instance of the SaleRows object, and populate it with SaleRow objects based on the result of a query on the table Sale. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static SaleCollection GetFromIdxStatus(SaleStatus status)Parameters
| Type | Name | Description |
|---|---|---|
| SaleStatus | status | Status (open, closed, lost) |
Returns
| Type | Description |
|---|---|
| SaleCollection | New SaleRows 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 IDXSaleStatus. Unique indexes have corresponding Create methods directly on the SaleRow object, since such indexes always return zero or one rows.
GetFromIdxUserdef2Id(Int32)
Create a new instance of the SaleRows object, and populate it with SaleRow objects based on the result of a query on the table Sale. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static SaleCollection GetFromIdxUserdef2Id(int userdef2Id)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | userdef2Id | User-defined fields reference |
Returns
| Type | Description |
|---|---|
| SaleCollection | New SaleRows 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 IDXSaleUdef2_id. Unique indexes have corresponding Create methods directly on the SaleRow object, since such indexes always return zero or one rows.
GetFromIdxUserdefId(Int32)
Create a new instance of the SaleRows object, and populate it with SaleRow objects based on the result of a query on the table Sale. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static SaleCollection GetFromIdxUserdefId(int userdefId)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | userdefId | User-defined fields reference |
Returns
| Type | Description |
|---|---|
| SaleCollection | New SaleRows 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 IDXSaleUdef_id. Unique indexes have corresponding Create methods directly on the SaleRow object, since such indexes always return zero or one rows.
Remove(Sale)
Removes the given Sale from the collection
Declaration
public void Remove(Sale sale)Parameters
| Type | Name | Description |
|---|---|---|
| Sale | sale | the Sale to be removed |
ToArray()
Declaration
public Sale[] ToArray()Returns
| Type | Description |
|---|---|
| Sale[] |
ToString()
For debugging: Number of members, and the first (up to) 5 items
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| String |