Class Selection
Selection tab
Entity Object for table 'selection'. Entity objects represent full entities with both the base table object and all related objects, such as visiblefor, and things like owner associate and whatever else is logically related to the base object.Inherited Members
Namespace: SuperOffice.CRM.Entities
Assembly: SoDataBase.dll
Syntax
public class Selection : EntityBase, INestedPersist, ITableRowLoadHandler
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
Constructors
Selection(SelectionIdxBase)
Constructor for class Selection.
This object represents a row in table 'selection'.
Table contact: Selections
Declaration
protected Selection(Selection.SelectionIdxBase idx)
Parameters
Type | Name | Description |
---|---|---|
Selection.SelectionIdxBase | idx | ContactRowSelectionRow.SelectionRowIdx object that the Contact encapsulates. |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
Selection(SelectionRow, SelectionIdxBase)
Selection tab
Entity Object for table 'selection'. Entity objects represent full entities with both the base table object and all related objects, such as visiblefor, and things like owner associate and whatever else is logically related to the base object.Declaration
protected Selection(SelectionRow row, Selection.SelectionIdxBase idx)
Parameters
Type | Name | Description |
---|---|---|
SelectionRow | row | |
Selection.SelectionIdxBase | idx |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
Fields
_associate
Related HDB object(s).
Declaration
protected AssociateRow _associate
Field Value
Type | Description |
---|---|
AssociateRow |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
_createdAssociate
Related HDB object(s).
Declaration
protected AssociateRow _createdAssociate
Field Value
Type | Description |
---|---|
AssociateRow |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
_lastLoadedBy
Selection tab
Entity Object for table 'selection'. Entity objects represent full entities with both the base table object and all related objects, such as visiblefor, and things like owner associate and whatever else is logically related to the base object.Declaration
protected AssociateRow _lastLoadedBy
Field Value
Type | Description |
---|---|
AssociateRow |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
_lastMembershipChangeBy
Selection tab
Entity Object for table 'selection'. Entity objects represent full entities with both the base table object and all related objects, such as visiblefor, and things like owner associate and whatever else is logically related to the base object.Declaration
protected AssociateRow _lastMembershipChangeBy
Field Value
Type | Description |
---|---|
AssociateRow |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
_row
HDB object this entity is a facade for.
Declaration
protected SelectionRow _row
Field Value
Type | Description |
---|---|
SelectionRow |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
_rowIdx
Selection tab
Entity Object for table 'selection'. Entity objects represent full entities with both the base table object and all related objects, such as visiblefor, and things like owner associate and whatever else is logically related to the base object.Declaration
protected Selection.SelectionIdxBase _rowIdx
Field Value
Type | Description |
---|---|
Selection.SelectionIdxBase |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
_searchCategory
Related HDB object(s).
Declaration
protected SearchCatRow _searchCategory
Field Value
Type | Description |
---|---|
SearchCatRow |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
_selectionInfo
Related HDB object(s).
Declaration
protected TextRow _selectionInfo
Field Value
Type | Description |
---|---|
TextRow |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
_selectionMembers
Related HDB object(s).
Declaration
protected SelectionMemberRows _selectionMembers
Field Value
Type | Description |
---|---|
SelectionMemberRows |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
_selectionText
Related HDB object(s).
Declaration
protected TextRow _selectionText
Field Value
Type | Description |
---|---|
TextRow |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
_updatedAssociate
Related HDB object(s).
Declaration
protected AssociateRow _updatedAssociate
Field Value
Type | Description |
---|---|
AssociateRow |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
_userGroup
Related HDB object(s).
Declaration
protected UserGroupRow _userGroup
Field Value
Type | Description |
---|---|
UserGroupRow |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
Properties
Associate
Related object AssociateRow: Employees, resources and other users - except for External persons
Declaration
public AssociateRow Associate { get; set; }
Property Value
Type | Description |
---|---|
AssociateRow |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
CompanyUnique
Only one person from a company may be selected as a member
Declaration
public short CompanyUnique { get; set; }
Property Value
Type | Description |
---|---|
short |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
CreatedAssociate
Related object AssociateRow: Employees, resources and other users - except for External persons
Declaration
public AssociateRow CreatedAssociate { get; set; }
Property Value
Type | Description |
---|---|
AssociateRow |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
IncludePerson
0 = Include first person, 1 = Include all persons, 2 = Include no persons
Declaration
public int IncludePerson { get; set; }
Property Value
Type | Description |
---|---|
int |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
IsDeleted
Is the row deleted?
Declaration
public override bool IsDeleted { get; }
Property Value
Type | Description |
---|---|
bool |
Overrides
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
IsMarkedForDelete
Gets or sets a value indicating whether this instance is marked for delete.
Declaration
public override bool IsMarkedForDelete { get; set; }
Property Value
Type | Description |
---|---|
bool |
|
Overrides
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
IsNew
Is the row new, e.g. not been inserted to the database?
Declaration
public override bool IsNew { get; }
Property Value
Type | Description |
---|---|
bool |
Overrides
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
LastLoadedBy
Selection tab
Entity Object for table 'selection'. Entity objects represent full entities with both the base table object and all related objects, such as visiblefor, and things like owner associate and whatever else is logically related to the base object.Declaration
public AssociateRow LastLoadedBy { get; set; }
Property Value
Type | Description |
---|---|
AssociateRow |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
LastMembershipChangeBy
Selection tab
Entity Object for table 'selection'. Entity objects represent full entities with both the base table object and all related objects, such as visiblefor, and things like owner associate and whatever else is logically related to the base object.Declaration
public AssociateRow LastMembershipChangeBy { get; set; }
Property Value
Type | Description |
---|---|
AssociateRow |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
MainRow
Return the main row for the Entity.
Declaration
protected override TableRowBase MainRow { get; }
Property Value
Type | Description |
---|---|
TableRowBase |
Overrides
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
MemberCount
How many selectionmembers (for progress bar)
Declaration
public uint MemberCount { get; set; }
Property Value
Type | Description |
---|---|
uint |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
Name
Name, freetext indexed
Declaration
public string Name { get; set; }
Property Value
Type | Description |
---|---|
string |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
Registered
Registered when
Declaration
public DateTime Registered { get; set; }
Property Value
Type | Description |
---|---|
DateTime |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
Row
The encapsulated object SelectionRow.
Declaration
public SelectionRow Row { get; }
Property Value
Type | Description |
---|---|
SelectionRow |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
SearchCategory
Related object SearchCatRow: SearchCat list table
Declaration
public SearchCatRow SearchCategory { get; set; }
Property Value
Type | Description |
---|---|
SearchCatRow |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
SelectionId
Selection tab
Entity Object for table 'selection'. Entity objects represent full entities with both the base table object and all related objects, such as visiblefor, and things like owner associate and whatever else is logically related to the base object.Declaration
public int SelectionId { get; }
Property Value
Type | Description |
---|---|
int |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
SelectionInfo
Related object TextRow: Long text fields from all over the system
Declaration
public TextRow SelectionInfo { get; set; }
Property Value
Type | Description |
---|---|
TextRow |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
SelectionText
Related object TextRow: Long text fields from all over the system
Declaration
public TextRow SelectionText { get; set; }
Property Value
Type | Description |
---|---|
TextRow |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
Seltype
0 = static selection, 1 = dynamic selection, 2 = combined selection
Declaration
public short Seltype { get; set; }
Property Value
Type | Description |
---|---|
short |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
SoundEx
What the name sounds like, for duplicate detection
Declaration
public string SoundEx { get; set; }
Property Value
Type | Description |
---|---|
string |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
Source
How did we get this selection? For future integration needs
Declaration
public short Source { get; set; }
Property Value
Type | Description |
---|---|
short |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
SystemType
0 = managed by user, 1 = temporary static, 2 = personal dynamic for Find
Declaration
public SelectionSystemType SystemType { get; set; }
Property Value
Type | Description |
---|---|
SelectionSystemType |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
TableInfo
Get a TableInfo object for the selection table.
Declaration
public SelectionTableInfo TableInfo { get; }
Property Value
Type | Description |
---|---|
SelectionTableInfo |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
Updated
Last updated when
Declaration
public DateTime Updated { get; set; }
Property Value
Type | Description |
---|---|
DateTime |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
UpdatedAssociate
Related object AssociateRow: Employees, resources and other users - except for External persons
Declaration
public AssociateRow UpdatedAssociate { get; set; }
Property Value
Type | Description |
---|---|
AssociateRow |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
UpdatedCount
Selection tab
Entity Object for table 'selection'. Entity objects represent full entities with both the base table object and all related objects, such as visiblefor, and things like owner associate and whatever else is logically related to the base object.Declaration
public short UpdatedCount { get; set; }
Property Value
Type | Description |
---|---|
short |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
UserGroup
Related object UserGroupRow: Secondary user groups
Declaration
public UserGroupRow UserGroup { get; set; }
Property Value
Type | Description |
---|---|
UserGroupRow |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
Visibility
OBSOLETE - now uses the VisibleFor table
Declaration
public short Visibility { get; set; }
Property Value
Type | Description |
---|---|
short |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
VisibleForHelper
Get the helper class for working with the visible-for of the entity.
Declaration
public EntityVisibleForHelper VisibleForHelper { get; }
Property Value
Type | Description |
---|---|
EntityVisibleForHelper |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
Methods
CreateNew()
Create a new instance of the Selection entity.
Declaration
public static Selection CreateNew()
Returns
Type | Description |
---|---|
Selection | A new instance of the Selection entity. |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
CreateNew(SelectionIdxBase)
Create a new instance of the Selection entity, by reading from the database using the specified index (represented by a nested index class).
Declaration
public static Selection CreateNew(Selection.SelectionIdxBase idx)
Parameters
Type | Name | Description |
---|---|---|
Selection.SelectionIdxBase | idx | Index search, represented by a subclass if the Selection.SelectionIdxBase nested index class |
Returns
Type | Description |
---|---|
Selection | A new instance of the Selection entity. |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
DeleteAsync()
Delete the row.
Declaration
public override Task DeleteAsync()
Returns
Type | Description |
---|---|
Task |
Overrides
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
ForceEntityUpdate()
Force Updated and UpdatedAssociate to be updated with current time and Currently logged in associate. This will again be overridden in the Database update operation by a query processor.
Declaration
protected override void ForceEntityUpdate()
Overrides
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
FromSelectionRow(SelectionRow)
Operator asigning a Selection from a SelectionRow.
Declaration
public static Selection FromSelectionRow(SelectionRow row)
Parameters
Type | Name | Description |
---|---|---|
SelectionRow | row | SelectionRow object |
Returns
Type | Description |
---|---|
Selection | Selection Entity |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
FromSelectionRow(SelectionRow, SelectionIdxBase)
Selection tab
Entity Object for table 'selection'. Entity objects represent full entities with both the base table object and all related objects, such as visiblefor, and things like owner associate and whatever else is logically related to the base object.Declaration
public static Selection FromSelectionRow(SelectionRow row, Selection.SelectionIdxBase idx)
Parameters
Type | Name | Description |
---|---|---|
SelectionRow | row | |
Selection.SelectionIdxBase | idx |
Returns
Type | Description |
---|---|
Selection |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
GetAdditionalRelatedNestedPersistAsync(List<INestedPersist>, bool, CancellationToken)
Hand-implemented partial class code should override this method to add to the list of related nestedpersist objects
Declaration
protected override Task GetAdditionalRelatedNestedPersistAsync(List<INestedPersist> relatedObjects, bool lacyFetchIfNeeded, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
List<INestedPersist> | relatedObjects | |
bool | lacyFetchIfNeeded | |
CancellationToken | cancellationToken |
Returns
Type | Description |
---|---|
Task |
Overrides
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
GetFromCustomSearchAsync(CustomSearch, CancellationToken)
Create a new instance of the Selection object, and populate it with data from a custom search. If the search returns no results, an empty entity will be returned; if the result contains rows, one Selection object representing the first row will be returned. Any further rows in the result will be ignored.
Declaration
public static Task<Selection> GetFromCustomSearchAsync(Selection.CustomSearch query, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
Selection.CustomSearch | query | The custom search to execute against the database |
CancellationToken | cancellationToken |
Returns
Type | Description |
---|---|
Task<Selection> | A new instance of the Selection object, reflecting the result of the query. |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
GetFromIdxSelectionIdAsync(int, CancellationToken)
Create a new instance of the Selection object, by querying the database table via the index 'IDXSelId'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<Selection> GetFromIdxSelectionIdAsync(int selectionId, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
int | selectionId | Primary key |
CancellationToken | cancellationToken |
Returns
Type | Description |
---|---|
Task<Selection> | Row object that represents the result of the search. IsNew will be true if the query did not match any row in the table |
Remarks
This method represents one of the unique indexes on the Selection table. Non-unique indexes have corresponding inner classes and methods in the SelectionCollection collection, since they may return more than one row.
GetRelatedNestedPersistAsync(List<INestedPersist>, bool, CancellationToken)
Append all the related objects to a list of INestedPersist.
Declaration
protected override Task GetRelatedNestedPersistAsync(List<INestedPersist> relatedObjects, bool lacyFetchIfNeeded, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
List<INestedPersist> | relatedObjects | List to append related objects to. |
bool | lacyFetchIfNeeded | |
CancellationToken | cancellationToken |
Returns
Type | Description |
---|---|
Task |
Overrides
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
GetSelectionMembersAsync(CancellationToken)
Related object SelectionMemberRows: Selection members
Declaration
public Task<SelectionMemberRows> GetSelectionMembersAsync(CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
CancellationToken | cancellationToken |
Returns
Type | Description |
---|---|
Task<SelectionMemberRows> |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
OnIdUpdateAsync()
Update related objects with correct id's to make sure that relations are consistent before saving to the database.
Declaration
protected override Task OnIdUpdateAsync()
Returns
Type | Description |
---|---|
Task |
Overrides
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
OnPostSaveMe()
Handle actions needed to be taken after this object has been saved, but before saving objects depending upon this one.
Declaration
protected virtual void OnPostSaveMe()
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
OnPreIdUpdateAsync()
Allow for "fake id's" to be forced upon related objects.
Declaration
protected override Task OnPreIdUpdateAsync()
Returns
Type | Description |
---|---|
Task |
Overrides
Remarks
In order to figure out which objects taking part of the nested save operation that actually needs to be saved, this method allows for "fake id's" to be forced upon related objects. Upon receiving the "fake id", the objects receiving such an id can determine if they needs to be persisted (e.g. saved) to the database. However, the fake id's forced upon related objects must be set to correct id's in the OnIdUpdate method taking place later in the save operation.
OnPreSaveMe()
Handle actions needed to be taken after objects this object depends on have been saved, but before this object is saved.
Declaration
protected virtual void OnPreSaveMe()
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
OnRowLoad(SoDataReader, TableRowBase)
Event raised when the row is loaded from the database
Declaration
protected override void OnRowLoad(SoDataReader reader, TableRowBase row)
Parameters
Type | Name | Description |
---|---|---|
SoDataReader | reader | |
TableRowBase | row |
Overrides
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
OnRowLoaded()
Selection tab
Entity Object for table 'selection'. Entity objects represent full entities with both the base table object and all related objects, such as visiblefor, and things like owner associate and whatever else is logically related to the base object.Declaration
protected override void OnRowLoaded()
Overrides
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
SetDefaultsAsync(DefaulterStrategy, CancellationToken)
Set default values for the entity.
Declaration
public Task SetDefaultsAsync(DefaulterStrategy strategy, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
DefaulterStrategy | strategy | Strategy used when appliying default values. |
CancellationToken | cancellationToken |
Returns
Type | Description |
---|---|
Task |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
SetDefaultsAsync(CancellationToken)
Set default values for the entity.
Declaration
public Task SetDefaultsAsync(CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
CancellationToken | cancellationToken |
Returns
Type | Description |
---|---|
Task |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
ValidateAsync(CancellationToken)
Check the entity and related objects for consistency and required fields, and return fields and error messages.
Declaration
public override Task<Dictionary<string, string>> ValidateAsync(CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
CancellationToken | cancellationToken |
Returns
Type | Description |
---|---|
Task<Dictionary<string, string>> | Field names and error messages |
Overrides
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |
Operators
explicit operator Selection(SelectionRow)
Operator assigning a Selection from a SelectionRow.
Declaration
public static explicit operator Selection(SelectionRow row)
Parameters
Type | Name | Description |
---|---|---|
SelectionRow | row | SelectionRow object |
Returns
Type | Description |
---|---|
Selection | Selection Entity |
Remarks
Entity objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Selection.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
- You can create a (nested) Selection Selection.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 GetFromCustomSearchAsync(CustomSearch, CancellationToken) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Selection.IsNew and SuperOffice.CRM.Data.Selection.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
Index fields | Nested index class name |
---|---|
SelectionId | SelectionId: Primary key Nested index class: Selection.IdxSelectionIdStatic Get method: GetFromIdxSelectionIdAsync(int, CancellationToken) |
Index fields | Nested index class name |
---|---|
Name | Name: Selection name, freetext indexed Nested index class: SelectionCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxName |
AssociateId | AssociateId: Can also represent other types of owner Nested index class: SelectionCollection.IdxAssociateIdStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxAssociateId |
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: SelectionCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSoundEx |
GroupIdx | GroupIdx: Link to group Nested index class: SelectionCollection.IdxGroupIdxStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxGroupIdx |
Source | Source: How did we get this selection? For future integration needs Nested index class: SelectionCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.SelectionCollection.GetFromIdxSource |