Class NSSelectionEntity
Syntax
Constructors
NSSelectionEntity()
Initializes a new instance of the NSSelectionEntity class.
Introduced or updated in version: 7
Declaration
NSSelectionEntityMethods
GetAssociate()
Introduced or updated in version: 7
Declaration
NSAssociate GetAssociate()Returns
| Type | Description |
|---|---|
| NSAssociate | Owner of the selection. |
Examples
NSSelectionEntity thing;
NSAssociate associate = thing.GetAssociate();GetChartKey()
Introduced or updated in version: 7
Declaration
String GetChartKey()Returns
| Type | Description |
|---|---|
| String | ID/key of the last-used chart tile on this selection. |
Examples
NSSelectionEntity thing;
String chartKey = thing.GetChartKey();GetCompanyUnique()
Introduced or updated in version: 7
Declaration
Bool GetCompanyUnique()Returns
| Type | Description |
|---|---|
| Bool | Filter out duplicate members based on company? |
Examples
NSSelectionEntity thing;
Bool companyUnique = thing.GetCompanyUnique();GetCompleted()
Introduced or updated in version: 7
Declaration
Bool GetCompleted()Returns
| Type | Description |
|---|---|
| Bool | The Completed state. |
Examples
NSSelectionEntity thing;
Bool completed = thing.GetCompleted();GetCreatedBy()
Introduced or updated in version: 7
Declaration
NSAssociate GetCreatedBy()Returns
| Type | Description |
|---|---|
| NSAssociate | Who created the selection. |
Examples
NSSelectionEntity thing;
NSAssociate createdBy = thing.GetCreatedBy();GetCreatedDate()
Introduced or updated in version: 7
Declaration
DateTime GetCreatedDate()Returns
| Type | Description |
|---|---|
| DateTime | Registered when. |
Examples
NSSelectionEntity thing;
DateTime createdDate = thing.GetCreatedDate();GetDescription()
Introduced or updated in version: 7
Declaration
String GetDescription()Returns
| Type | Description |
|---|---|
| String | The actual text, max 2047 significant characters even though it is stored as a larger data type on some databases. |
Examples
NSSelectionEntity thing;
String description = thing.GetDescription();GetGroupIdx()
Introduced or updated in version: 7
Declaration
Integer GetGroupIdx()Returns
| Type | Description |
|---|---|
| Integer | Original primary user group of associate. |
Examples
NSSelectionEntity thing;
Integer groupIdx = thing.GetGroupIdx();GetIncludePerson()
Introduced or updated in version: 7
Declaration
Integer GetIncludePerson()Returns
| Type | Description |
|---|---|
| Integer | 0 = Include first person, 1 = Include all persons, 2 = Include no persons. |
Examples
NSSelectionEntity thing;
Integer includePerson = thing.GetIncludePerson();GetLastLoaded()
Introduced or updated in version: 7
Declaration
DateTime GetLastLoaded()Returns
| Type | Description |
|---|---|
| DateTime | The date/time this selection was last loaded (selectionentity fetched). |
Examples
NSSelectionEntity thing;
DateTime lastLoaded = thing.GetLastLoaded();GetLastLoadedBy()
Introduced or updated in version: 7
Declaration
Integer GetLastLoadedBy()Returns
| Type | Description |
|---|---|
| Integer | Who last loaded this selection. |
Examples
NSSelectionEntity thing;
Integer lastLoadedBy = thing.GetLastLoadedBy();GetLastLoadedByAssociate()
Introduced or updated in version: 7
Declaration
NSAssociate GetLastLoadedByAssociate()Returns
| Type | Description |
|---|---|
| NSAssociate | NSAssociate that last looked at the selection members; only date (not time) is valid. |
Examples
NSSelectionEntity thing;
NSAssociate lastLoadedByAssociate = thing.GetLastLoadedByAssociate();GetLastMembershipChange()
Introduced or updated in version: 7
Declaration
DateTime GetLastMembershipChange()Returns
| Type | Description |
|---|---|
| DateTime | The date/time the membership the selection last changed. Dynamic - change of criteria; Static - add/remove members; Combined - change of algorithm. |
Examples
NSSelectionEntity thing;
DateTime lastMembershipChange = thing.GetLastMembershipChange();GetLastMembershipChangeBy()
Introduced or updated in version: 7
Declaration
Integer GetLastMembershipChangeBy()Returns
| Type | Description |
|---|---|
| Integer | Who last changed the membership. |
Examples
NSSelectionEntity thing;
Integer lastMembershipChangeBy = thing.GetLastMembershipChangeBy();GetLastMembershipChangeByAssociate()
Introduced or updated in version: 7
Declaration
NSAssociate GetLastMembershipChangeByAssociate()Returns
| Type | Description |
|---|---|
| NSAssociate | Associate that last changed the selection membership (static members, dynamic criteria, combined parameters); only date (not time) is valid. |
Examples
NSSelectionEntity thing;
NSAssociate lastMembershipChangeByAssociate = thing.GetLastMembershipChangeByAssociate();GetLeftSelectionId()
LeftSelectionId is used in combination with RightSelectionId and CombinationType to define an union of two selections when SelectionType=Combined.
Introduced or updated in version: 7
Declaration
Integer GetLeftSelectionId()Returns
| Type | Description |
|---|---|
| Integer |
Examples
NSSelectionEntity thing;
Integer leftSelectionId = thing.GetLeftSelectionId();GetMailingsProviderName()
Introduced or updated in version: 7
Declaration
String GetMailingsProviderName()Returns
| Type | Description |
|---|---|
| String | The name of the provider for the Mailings tab, if relevant; this string will contain resource references. |
Examples
NSSelectionEntity thing;
String mailingsProviderName = thing.GetMailingsProviderName();GetMainHeading()
Introduced or updated in version: 7
Declaration
String GetMainHeading()Returns
| Type | Description |
|---|---|
| String | 'Static selection of Companies', or whatever else is appropriate, made by combining text resources for the type and the entity (plural form); this string will contain resource references |
Examples
NSSelectionEntity thing;
String mainHeading = thing.GetMainHeading();GetMainProviderName()
Introduced or updated in version: 7
Declaration
String GetMainProviderName()Returns
| Type | Description |
|---|---|
| String | The name of the Archive Provider that will deliver the content of the archive* the actual entity rows. |
Examples
NSSelectionEntity thing;
String mainProviderName = thing.GetMainProviderName();GetMemberCount()
Introduced or updated in version: 7
Declaration
Integer GetMemberCount()Returns
| Type | Description |
|---|---|
| Integer | How many selection members (for progress bar calculations)* estimate, -1 (or 4294967295) means we don't know. |
Examples
NSSelectionEntity thing;
Integer memberCount = thing.GetMemberCount();GetMemberTabHeading()
Introduced or updated in version: 7
Declaration
String GetMemberTabHeading()Returns
| Type | Description |
|---|---|
| String | 'Companies', or whatever else is appropriate* the plural form of the entity name; this string will contain resource references |
Examples
NSSelectionEntity thing;
String memberTabHeading = thing.GetMemberTabHeading();GetName()
Introduced or updated in version: 7
Declaration
String GetName()Returns
| Type | Description |
|---|---|
| String | Name of selection, free-text indexed. |
Examples
NSSelectionEntity thing;
String name = thing.GetName();GetPostit()
Introduced or updated in version: 7
Declaration
String GetPostit()Returns
| Type | Description |
|---|---|
| String | The actual text, max 2047 significant characters even though it is stored as a larger data type on some databases. |
Examples
NSSelectionEntity thing;
String postit = thing.GetPostit();GetPostitTextId()
Introduced or updated in version: 7
Declaration
Integer GetPostitTextId()Returns
| Type | Description |
|---|---|
| Integer | Postit text record ID. |
Examples
NSSelectionEntity thing;
Integer postitTextId = thing.GetPostitTextId();GetRightSelectionId()
RightSelectionId is used in combination with LeftSelectionId and CombinationType to define an union of two selections when SelectionType=Combined.
Introduced or updated in version: 7
Declaration
Integer GetRightSelectionId()Returns
| Type | Description |
|---|---|
| Integer |
Examples
NSSelectionEntity thing;
Integer rightSelectionId = thing.GetRightSelectionId();GetSelectionCategory()
Introduced or updated in version: 7
Declaration
NSSelectionCategory GetSelectionCategory()Returns
| Type | Description |
|---|---|
| NSSelectionCategory |
Examples
NSSelectionEntity thing;
NSSelectionCategory selectionCategory = thing.GetSelectionCategory();GetSelectionId()
Primary key
Introduced or updated in version: 7
Declaration
Integer GetSelectionId()Returns
| Type | Description |
|---|---|
| Integer | Selection category type (list item). |
Examples
NSSelectionEntity thing;
Integer selectionId = thing.GetSelectionId();GetSelectionType()
Introduced or updated in version: 7
Declaration
Integer GetSelectionType()Returns
| Type | Description |
|---|---|
| Integer | Static/Dynamic/Combined? See SelectionType |
Examples
NSSelectionEntity thing;
Integer selectionType = thing.GetSelectionType();GetSelectionUnionType()
Introduced or updated in version: 7
Declaration
Integer GetSelectionUnionType()Returns
| Type | Description |
|---|---|
| Integer | How to combine the two selections when SelectionType = Combined. See SelectionUnionType. |
Examples
NSSelectionEntity thing;
Integer selectionUnionType = thing.GetSelectionUnionType();GetShadowProviderName()
Introduced or updated in version: 7
Declaration
String GetShadowProviderName()Returns
| Type | Description |
|---|---|
| String | The name, if relevant, of the Archive Provider that will deliver the Shadow rows. contact/person rows related to the actual entity. Can be blank, indicating that there is no shadow archive. |
Examples
NSSelectionEntity thing;
String shadowProviderName = thing.GetShadowProviderName();GetSoundEx()
Introduced or updated in version: 7
Declaration
String GetSoundEx()Returns
| Type | Description |
|---|---|
| String | What the name sounds like, for duplicate detection. |
Examples
NSSelectionEntity thing;
String soundEx = thing.GetSoundEx();GetSource()
Introduced or updated in version: 7
Declaration
Integer GetSource()Returns
| Type | Description |
|---|---|
| Integer | How did we get this selection? For future integration needs. |
Examples
NSSelectionEntity thing;
Integer source = thing.GetSource();GetTargetTableName()
Introduced or updated in version: 7
Declaration
String GetTargetTableName()Returns
| Type | Description |
|---|---|
| String | TargetTableName contains the name of the table in lowercase. defines the type of selection members this selection contains. e.g. 'contact', or 'project' or 'sale' |
Examples
NSSelectionEntity thing;
String targetTableName = thing.GetTargetTableName();GetTargetTableNumber()
Introduced or updated in version: 7
Declaration
Integer GetTargetTableNumber()Returns
| Type | Description |
|---|---|
| Integer | TargetTableNumber defines the type of selection members this selection contains. e.g. the table number for 'contact', or 'project' or 'sale' |
Examples
NSSelectionEntity thing;
Integer targetTableNumber = thing.GetTargetTableNumber();GetTextId()
Introduced or updated in version: 7
Declaration
Integer GetTextId()Returns
| Type | Description |
|---|---|
| Integer | Description text record Id. |
Examples
NSSelectionEntity thing;
Integer textId = thing.GetTextId();GetUpdatedBy()
Introduced or updated in version: 7
Declaration
NSAssociate GetUpdatedBy()Returns
| Type | Description |
|---|---|
| NSAssociate | Who last modified the selection. |
Examples
NSSelectionEntity thing;
NSAssociate updatedBy = thing.GetUpdatedBy();GetUpdatedCount()
Introduced or updated in version: 7
Declaration
Integer GetUpdatedCount()Returns
| Type | Description |
|---|---|
| Integer | Number of updates made to this record. |
Examples
NSSelectionEntity thing;
Integer updatedCount = thing.GetUpdatedCount();GetUpdatedDate()
Introduced or updated in version: 7
Declaration
DateTime GetUpdatedDate()Returns
| Type | Description |
|---|---|
| DateTime | Last updated when. |
Examples
NSSelectionEntity thing;
DateTime updatedDate = thing.GetUpdatedDate();GetVisibility()
Obsolete, but still maintained de-normalization of visiblefor
Introduced or updated in version: 7
Declaration
Integer GetVisibility()Returns
| Type | Description |
|---|---|
| Integer |
Examples
NSSelectionEntity thing;
Integer visibility = thing.GetVisibility();GetVisibleFor()
Returns the user groups and/or users the SelectionEntity item is visible for.
Introduced or updated in version: 7
Declaration
NSVisibleFor[] GetVisibleFor()Returns
| Type | Description |
|---|---|
| NSVisibleFor[] |
Examples
NSSelectionEntity thing;
NSVisibleFor[] visibleFor = thing.GetVisibleFor();SetAssociate(NSAssociate)
Introduced or updated in version: 7
Declaration
Void SetAssociate(NSAssociate associate)Parameters
| Type | Name | Description |
|---|---|---|
| NSAssociate | associate | Owner of the selection. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
NSAssociate associate;
thing.SetAssociate(associate);SetChartKey(String)
Introduced or updated in version: 7
Declaration
Void SetChartKey(String chartKey)Parameters
| Type | Name | Description |
|---|---|---|
| String | chartKey | ID/key of the last-used chart tile on this selection. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
String chartKey;
thing.SetChartKey(chartKey);SetCompanyUnique(Bool)
Introduced or updated in version: 7
Declaration
Void SetCompanyUnique(Bool companyUnique)Parameters
| Type | Name | Description |
|---|---|---|
| Bool | companyUnique | Filter out duplicate members based on company? |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
Bool companyUnique;
thing.SetCompanyUnique(companyUnique);SetCompleted(Bool)
Introduced or updated in version: 7
Declaration
Void SetCompleted(Bool completed)Parameters
| Type | Name | Description |
|---|---|---|
| Bool | completed | The Completed state. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
Bool completed;
thing.SetCompleted(completed);SetCreatedBy(NSAssociate)
Introduced or updated in version: 7
Declaration
Void SetCreatedBy(NSAssociate createdBy)Parameters
| Type | Name | Description |
|---|---|---|
| NSAssociate | createdBy | Who created the selection. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
NSAssociate createdBy;
thing.SetCreatedBy(createdBy);SetCreatedDate(DateTime)
Introduced or updated in version: 7
Declaration
Void SetCreatedDate(DateTime createdDate)Parameters
| Type | Name | Description |
|---|---|---|
| DateTime | createdDate | Registered when. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
DateTime createdDate;
thing.SetCreatedDate(createdDate);SetDescription(String)
Introduced or updated in version: 7
Declaration
Void SetDescription(String description)Parameters
| Type | Name | Description |
|---|---|---|
| String | description | The actual text, max 2047 significant characters even though it is stored as a larger data type on some databases. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
String description;
thing.SetDescription(description);SetGroupIdx(Integer)
Introduced or updated in version: 7
Declaration
Void SetGroupIdx(Integer groupIdx)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | groupIdx | Original primary user group of associate. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
Integer groupIdx;
thing.SetGroupIdx(groupIdx);SetIncludePerson(Integer)
Introduced or updated in version: 7
Declaration
Void SetIncludePerson(Integer includePerson)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | includePerson | 0 = Include first person, 1 = Include all persons, 2 = Include no persons. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
Integer includePerson;
thing.SetIncludePerson(includePerson);SetLastLoaded(DateTime)
Introduced or updated in version: 7
Declaration
Void SetLastLoaded(DateTime lastLoaded)Parameters
| Type | Name | Description |
|---|---|---|
| DateTime | lastLoaded | The date/time this selection was last loaded (selectionentity fetched). |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
DateTime lastLoaded;
thing.SetLastLoaded(lastLoaded);SetLastLoadedBy(Integer)
Introduced or updated in version: 7
Declaration
Void SetLastLoadedBy(Integer lastLoadedBy)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | lastLoadedBy | Who last loaded this selection. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
Integer lastLoadedBy;
thing.SetLastLoadedBy(lastLoadedBy);SetLastLoadedByAssociate(NSAssociate)
Introduced or updated in version: 7
Declaration
Void SetLastLoadedByAssociate(NSAssociate lastLoadedByAssociate)Parameters
| Type | Name | Description |
|---|---|---|
| NSAssociate | lastLoadedByAssociate | NSAssociate that last looked at the selection members; only date (not time) is valid. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
NSAssociate lastLoadedByAssociate;
thing.SetLastLoadedByAssociate(lastLoadedByAssociate);SetLastMembershipChange(DateTime)
Introduced or updated in version: 7
Declaration
Void SetLastMembershipChange(DateTime lastMembershipChange)Parameters
| Type | Name | Description |
|---|---|---|
| DateTime | lastMembershipChange | The date/time the membership the selection last changed. Dynamic - change of criteria; Static - add/remove members; Combined - change of algorithm. |
Examples
NSSelectionEntity thing;
DateTime lastMembershipChange;
thing.SetLastMembershipChange(lastMembershipChange);SetLastMembershipChangeBy(Integer)
Introduced or updated in version: 7
Declaration
Void SetLastMembershipChangeBy(Integer lastMembershipChangeBy)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | lastMembershipChangeBy | Who last changed the membership. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
Integer lastMembershipChangeBy;
thing.SetLastMembershipChangeBy(lastMembershipChangeBy);SetLastMembershipChangeByAssociate(NSAssociate)
Introduced or updated in version: 7
Declaration
Void SetLastMembershipChangeByAssociate(NSAssociate lastMembershipChangeByAssociate)Parameters
| Type | Name | Description |
|---|---|---|
| NSAssociate | lastMembershipChangeByAssociate | Associate that last changed the selection membership (static members, dynamic criteria, combined parameters); only date (not time) is valid. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
NSAssociate lastMembershipChangeByAssociate;
thing.SetLastMembershipChangeByAssociate(lastMembershipChangeByAssociate);SetLeftSelectionId(Integer)
LeftSelectionId is used in combination with RightSelectionId and CombinationType to define an union of two selections when SelectionType=Combined.
Introduced or updated in version: 7
Declaration
Void SetLeftSelectionId(Integer leftSelectionId)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | leftSelectionId |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
Integer leftSelectionId;
thing.SetLeftSelectionId(leftSelectionId);SetMailingsProviderName(String)
Introduced or updated in version: 7
Declaration
Void SetMailingsProviderName(String mailingsProviderName)Parameters
| Type | Name | Description |
|---|---|---|
| String | mailingsProviderName | The name of the provider for the Mailings tab, if relevant; this string will contain resource references. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
String mailingsProviderName;
thing.SetMailingsProviderName(mailingsProviderName);SetMainHeading(String)
Introduced or updated in version: 7
Declaration
Void SetMainHeading(String mainHeading)Parameters
| Type | Name | Description |
|---|---|---|
| String | mainHeading | 'Static selection of Companies', or whatever else is appropriate, made by combining text resources for the type and the entity (plural form); this string will contain resource references |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
String mainHeading;
thing.SetMainHeading(mainHeading);SetMainProviderName(String)
Introduced or updated in version: 7
Declaration
Void SetMainProviderName(String mainProviderName)Parameters
| Type | Name | Description |
|---|---|---|
| String | mainProviderName | The name of the Archive Provider that will deliver the content of the archive* the actual entity rows. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
String mainProviderName;
thing.SetMainProviderName(mainProviderName);SetMemberCount(Integer)
Introduced or updated in version: 7
Declaration
Void SetMemberCount(Integer memberCount)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | memberCount | How many selection members (for progress bar calculations)* estimate, -1 (or 4294967295) means we don't know. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
Integer memberCount;
thing.SetMemberCount(memberCount);SetMemberTabHeading(String)
Introduced or updated in version: 7
Declaration
Void SetMemberTabHeading(String memberTabHeading)Parameters
| Type | Name | Description |
|---|---|---|
| String | memberTabHeading | 'Companies', or whatever else is appropriate* the plural form of the entity name; this string will contain resource references |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
String memberTabHeading;
thing.SetMemberTabHeading(memberTabHeading);SetName(String)
Introduced or updated in version: 7
Declaration
Void SetName(String name)Parameters
| Type | Name | Description |
|---|---|---|
| String | name | Name of selection, free-text indexed. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
String name;
thing.SetName(name);SetPostit(String)
Introduced or updated in version: 7
Declaration
Void SetPostit(String postit)Parameters
| Type | Name | Description |
|---|---|---|
| String | postit | The actual text, max 2047 significant characters even though it is stored as a larger data type on some databases. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
String postit;
thing.SetPostit(postit);SetPostitTextId(Integer)
Introduced or updated in version: 7
Declaration
Void SetPostitTextId(Integer postitTextId)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | postitTextId | Postit text record ID. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
Integer postitTextId;
thing.SetPostitTextId(postitTextId);SetRightSelectionId(Integer)
RightSelectionId is used in combination with LeftSelectionId and CombinationType to define an union of two selections when SelectionType=Combined.
Introduced or updated in version: 7
Declaration
Void SetRightSelectionId(Integer rightSelectionId)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | rightSelectionId |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
Integer rightSelectionId;
thing.SetRightSelectionId(rightSelectionId);SetSelectionCategory(NSSelectionCategory)
Introduced or updated in version: 7
Declaration
Void SetSelectionCategory(NSSelectionCategory selectionCategory)Parameters
| Type | Name | Description |
|---|---|---|
| NSSelectionCategory | selectionCategory | Selection category type (list item). |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
NSSelectionCategory selectionCategory;
thing.SetSelectionCategory(selectionCategory);SetSelectionId(Integer)
Introduced or updated in version: 7
Declaration
Void SetSelectionId(Integer selectionId)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | selectionId | Primary key. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
Integer selectionId;
thing.SetSelectionId(selectionId);SetSelectionType(Integer)
Introduced or updated in version: 7
Declaration
Void SetSelectionType(Integer selectionType)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | selectionType | Static/Dynamic/Combined? See SelectionType. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
Integer selectionType;
thing.SetSelectionType(selectionType);SetSelectionUnionType(Integer)
Introduced or updated in version: 7
Declaration
Void SetSelectionUnionType(Integer selectionUnionType)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | selectionUnionType | How to combine the two selections when SelectionType = Combined. See SelectionUnionType. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
Integer selectionUnionType;
thing.SetSelectionUnionType(selectionUnionType);SetShadowProviderName(String)
Introduced or updated in version: 7
Declaration
Void SetShadowProviderName(String shadowProviderName)Parameters
| Type | Name | Description |
|---|---|---|
| String | shadowProviderName | The name, if relevant, of the Archive Provider that will deliver the Shadow rows, contact/person rows related to the actual entity. Can be blank, indicating that there is no shadow archive. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
String shadowProviderName;
thing.SetShadowProviderName(shadowProviderName);SetSoundEx(String)
Introduced or updated in version: 7
Declaration
Void SetSoundEx(String soundEx)Parameters
| Type | Name | Description |
|---|---|---|
| String | soundEx | What the name sounds like, for duplicate detection. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
String soundEx;
thing.SetSoundEx(soundEx);SetSource(Integer)
Introduced or updated in version: 7
Declaration
Void SetSource(Integer source)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | source | How did we get this selection? For future integration needs. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
Integer source;
thing.SetSource(source);SetTargetTableName(String)
Introduced or updated in version: 7
Declaration
Void SetTargetTableName(String targetTableName)Parameters
| Type | Name | Description |
|---|---|---|
| String | targetTableName | TargetTableName contains the name of the table in lowercase. defines the type of selection members this selection contains. e.g. 'contact', or 'project' or 'sale' |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
String targetTableName;
thing.SetTargetTableName(targetTableName);SetTargetTableNumber(Integer)
Introduced or updated in version: 7
Declaration
Void SetTargetTableNumber(Integer targetTableNumber)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | targetTableNumber | TargetTableNumber defines the type of selection members this selection contains. e.g. the table number for 'contact', or 'project' or 'sale' |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
Integer targetTableNumber;
thing.SetTargetTableNumber(targetTableNumber);SetTextId(Integer)
Introduced or updated in version: 7
Declaration
Void SetTextId(Integer textId)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | textId | Description text record Id. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
Integer textId;
thing.SetTextId(textId);SetUpdatedBy(NSAssociate)
Introduced or updated in version: 7
Declaration
Void SetUpdatedBy(NSAssociate updatedBy)Parameters
| Type | Name | Description |
|---|---|---|
| NSAssociate | updatedBy | Who last modified the selection. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
NSAssociate updatedBy;
thing.SetUpdatedBy(updatedBy);SetUpdatedCount(Integer)
Introduced or updated in version: 7
Declaration
Void SetUpdatedCount(Integer updatedCount)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | updatedCount | Number of updates made to this record. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
Integer updatedCount;
thing.SetUpdatedCount(updatedCount);SetUpdatedDate(DateTime)
Introduced or updated in version: 7
Declaration
Void SetUpdatedDate(DateTime updatedDate)Parameters
| Type | Name | Description |
|---|---|---|
| DateTime | updatedDate | Last updated when. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
DateTime updatedDate;
thing.SetUpdatedDate(updatedDate);SetVisibility(Integer)
Obsolete, but still maintained de-normalization of visiblefor
Introduced or updated in version: 7
Declaration
Void SetVisibility(Integer visibility)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | visibility |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
Integer visibility;
thing.SetVisibility(visibility);SetVisibleFor(NSVisibleFor[])
Sets the user-groups and/or users the SelectionEntity item is visible for.
Introduced or updated in version: 7
Declaration
Void SetVisibleFor(NSVisibleFor[] visibleFor)Parameters
| Type | Name | Description |
|---|---|---|
| NSVisibleFor[] | visibleFor |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionEntity thing;
NSVisibleFor[] visibleFor = thing.GetVisibleFor();
visibleFor[0].SetVisiblity(1); // usergroup
visibleFor[0].SetVisibleId(123); // usergroup id
thing.SetVisibleFor(visibleFor);