NSSelectionEntity - SuperOffice

Constructors

NSSelectionEntity()

NSSelectionEntity

Initializes a new instance of the NSSelectionEntity class.

Methods

GetAssociate()

NSAssociate GetAssociate()

Returns: CRMScript.NetServer.NSAssociate - Owner of the selection. Example:

NSSelectionEntity thing;
NSAssociate associate = thing.GetAssociate();

GetChartKey()

String GetChartKey()

Returns: CRMScript.Global.String - ID/key of the last-used chart tile on this selection. Example:

NSSelectionEntity thing;
String chartKey = thing.GetChartKey();

GetCompanyUnique()

Bool GetCompanyUnique()

Returns: CRMScript.Global.Bool - Filter out duplicate members based on company? Example:

NSSelectionEntity thing;
Bool companyUnique = thing.GetCompanyUnique();

GetCompleted()

Bool GetCompleted()

Returns: CRMScript.Global.Bool - The Completed state. Example:

NSSelectionEntity thing;
Bool completed = thing.GetCompleted();

GetCreatedBy()

NSAssociate GetCreatedBy()

Returns: CRMScript.NetServer.NSAssociate - Who created the selection. Example:

NSSelectionEntity thing;
NSAssociate createdBy = thing.GetCreatedBy();

GetCreatedDate()

DateTime GetCreatedDate()

Returns: CRMScript.Global.DateTime - Registered when. Example:

NSSelectionEntity thing;
DateTime createdDate = thing.GetCreatedDate();

GetDescription()

String GetDescription()

Returns: CRMScript.Global.String - The actual text, max 2047 significant characters even though it is stored as a larger data type on some databases. Example:

NSSelectionEntity thing;
String description = thing.GetDescription();

GetGroupIdx()

Integer GetGroupIdx()

Returns: CRMScript.Global.Integer - Original primary user group of associate. Example:

NSSelectionEntity thing;
Integer groupIdx = thing.GetGroupIdx();

GetIncludePerson()

Integer GetIncludePerson()

Returns: CRMScript.Global.Integer - 0 = Include first person, 1 = Include all persons, 2 = Include no persons. Example:

NSSelectionEntity thing;
Integer includePerson = thing.GetIncludePerson();

GetLastLoaded()

DateTime GetLastLoaded()

Returns: CRMScript.Global.DateTime - The date/time this selection was last loaded (selectionentity fetched). Example:

NSSelectionEntity thing;
DateTime lastLoaded = thing.GetLastLoaded();

GetLastLoadedBy()

Integer GetLastLoadedBy()

Returns: CRMScript.Global.Integer - Who last loaded this selection. Example:

NSSelectionEntity thing;
Integer lastLoadedBy = thing.GetLastLoadedBy();

GetLastLoadedByAssociate()

NSAssociate GetLastLoadedByAssociate()

Returns: CRMScript.NetServer.NSAssociate - NSAssociate that last looked at the selection members; only date (not time) is valid. Example:

NSSelectionEntity thing;
NSAssociate lastLoadedByAssociate = thing.GetLastLoadedByAssociate();

GetLastMembershipChange()

DateTime GetLastMembershipChange()

Returns: CRMScript.Global.DateTime - The date/time the membership the selection last changed. Dynamic - change of criteria; Static - add/remove members; Combined - change of algorithm. Example:

NSSelectionEntity thing;
DateTime lastMembershipChange = thing.GetLastMembershipChange();

GetLastMembershipChangeBy()

Integer GetLastMembershipChangeBy()

Returns: CRMScript.Global.Integer - Who last changed the membership. Example:

NSSelectionEntity thing;
Integer lastMembershipChangeBy = thing.GetLastMembershipChangeBy();

GetLastMembershipChangeByAssociate()

NSAssociate GetLastMembershipChangeByAssociate()

Returns: CRMScript.NetServer.NSAssociate - Associate that last changed the selection membership (static members, dynamic criteria, combined parameters); only date (not time) is valid. Example:

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.

Integer GetLeftSelectionId()

Returns: CRMScript.Global.Integer Example:

NSSelectionEntity thing;
Integer leftSelectionId = thing.GetLeftSelectionId();

GetMailingsProviderName()

String GetMailingsProviderName()

Returns: CRMScript.Global.String - The name of the provider for the Mailings tab, if relevant; this string will contain resource references. Example:

NSSelectionEntity thing;
String mailingsProviderName = thing.GetMailingsProviderName();

GetMainHeading()

String GetMainHeading()

Returns: CRMScript.Global.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 Example:

NSSelectionEntity thing;
String mainHeading = thing.GetMainHeading();

GetMainProviderName()

String GetMainProviderName()

Returns: CRMScript.Global.String - The name of the Archive Provider that will deliver the content of the archive* the actual entity rows. Example:

NSSelectionEntity thing;
String mainProviderName = thing.GetMainProviderName();

GetMemberCount()

Integer GetMemberCount()

Returns: CRMScript.Global.Integer - How many selection members (for progress bar calculations)* estimate, -1 (or 4294967295) means we don’t know. Example:

NSSelectionEntity thing;
Integer memberCount = thing.GetMemberCount();

GetMemberTabHeading()

String GetMemberTabHeading()

Returns: CRMScript.Global.String - ‘Companies’, or whatever else is appropriate* the plural form of the entity name; this string will contain resource references Example:

NSSelectionEntity thing;
String memberTabHeading = thing.GetMemberTabHeading();

GetName()

String GetName()

Returns: CRMScript.Global.String - Name of selection, free-text indexed. Example:

NSSelectionEntity thing;
String name = thing.GetName();

GetPostit()

String GetPostit()

Returns: CRMScript.Global.String - The actual text, max 2047 significant characters even though it is stored as a larger data type on some databases. Example:

NSSelectionEntity thing;
String postit = thing.GetPostit();

GetPostitTextId()

Integer GetPostitTextId()

Returns: CRMScript.Global.Integer - Postit text record ID. Example:

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.

Integer GetRightSelectionId()

Returns: CRMScript.Global.Integer Example:

NSSelectionEntity thing;
Integer rightSelectionId = thing.GetRightSelectionId();

GetSelectionCategory()

NSSelectionCategory GetSelectionCategory()

Returns: CRMScript.NetServer.NSSelectionCategory Example:

NSSelectionEntity thing;
NSSelectionCategory selectionCategory = thing.GetSelectionCategory();

GetSelectionId()

Primary key

Integer GetSelectionId()

Returns: CRMScript.Global.Integer - Selection category type (list item). Example:

NSSelectionEntity thing;
Integer selectionId = thing.GetSelectionId();

GetSelectionType()

Integer GetSelectionType()

Returns: CRMScript.Global.Integer - Static/Dynamic/Combined? See <xref href=“CRMScript.NetServer.SelectionType” data-throw-if-not-resolved=“false”></xref> Example:

NSSelectionEntity thing;
Integer selectionType = thing.GetSelectionType();

GetSelectionUnionType()

Integer GetSelectionUnionType()

Returns: CRMScript.Global.Integer - How to combine the two selections when SelectionType = Combined. See <xref href=“CRMScript.NetServer.SelectionUnionType” data-throw-if-not-resolved=“false”></xref>. Example:

NSSelectionEntity thing;
Integer selectionUnionType = thing.GetSelectionUnionType();

GetShadowProviderName()

String GetShadowProviderName()

Returns: CRMScript.Global.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. Example:

NSSelectionEntity thing;
String shadowProviderName = thing.GetShadowProviderName();

GetSoundEx()

String GetSoundEx()

Returns: CRMScript.Global.String - What the name sounds like, for duplicate detection. Example:

NSSelectionEntity thing;
String soundEx = thing.GetSoundEx();

GetSource()

Integer GetSource()

Returns: CRMScript.Global.Integer - How did we get this selection? For future integration needs. Example:

NSSelectionEntity thing;
Integer source = thing.GetSource();

GetTargetTableName()

String GetTargetTableName()

Returns: CRMScript.Global.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’ Example:

NSSelectionEntity thing;
String targetTableName = thing.GetTargetTableName();

GetTargetTableNumber()

Integer GetTargetTableNumber()

Returns: CRMScript.Global.Integer - TargetTableNumber defines the type of selection members this selection contains. e.g. the table number for ‘contact’, or ‘project’ or ‘sale’ Example:

NSSelectionEntity thing;
Integer targetTableNumber = thing.GetTargetTableNumber();

GetTextId()

Integer GetTextId()

Returns: CRMScript.Global.Integer - Description text record Id. Example:

NSSelectionEntity thing;
Integer textId = thing.GetTextId();

GetUpdatedBy()

NSAssociate GetUpdatedBy()

Returns: CRMScript.NetServer.NSAssociate - Who last modified the selection. Example:

NSSelectionEntity thing;
NSAssociate updatedBy = thing.GetUpdatedBy();

GetUpdatedCount()

Integer GetUpdatedCount()

Returns: CRMScript.Global.Integer - Number of updates made to this record. Example:

NSSelectionEntity thing;
Integer updatedCount = thing.GetUpdatedCount();

GetUpdatedDate()

DateTime GetUpdatedDate()

Returns: CRMScript.Global.DateTime - Last updated when. Example:

NSSelectionEntity thing;
DateTime updatedDate = thing.GetUpdatedDate();

GetVisibility()

Obsolete, but still maintained de-normalization of visiblefor

Integer GetVisibility()

Returns: CRMScript.Global.Integer Example:

NSSelectionEntity thing;
Integer visibility = thing.GetVisibility();

GetVisibleFor()

Returns the user groups and/or users the SelectionEntity item is visible for.

NSVisibleFor[] GetVisibleFor()

Returns: CRMScript.NetServer.NSVisibleFor[] Example:

NSSelectionEntity thing;
NSVisibleFor[] visibleFor = thing.GetVisibleFor();

SetAssociate(NSAssociate)

Void SetAssociate(NSAssociate associate)

Returns: CRMScript.Global.Void Example:

NSSelectionEntity thing;
NSAssociate associate;
thing.SetAssociate(associate);

SetChartKey(String)

Void SetChartKey(String chartKey)

Returns: CRMScript.Global.Void Example:

NSSelectionEntity thing;
String chartKey;
thing.SetChartKey(chartKey);

SetCompanyUnique(Bool)

Void SetCompanyUnique(Bool companyUnique)

Returns: CRMScript.Global.Void Example:

NSSelectionEntity thing;
Bool companyUnique;
thing.SetCompanyUnique(companyUnique);

SetCompleted(Bool)

Void SetCompleted(Bool completed)

Returns: CRMScript.Global.Void Example:

NSSelectionEntity thing;
Bool completed;
thing.SetCompleted(completed);

SetCreatedBy(NSAssociate)

Void SetCreatedBy(NSAssociate createdBy)

Returns: CRMScript.Global.Void Example:

NSSelectionEntity thing;
NSAssociate createdBy;
thing.SetCreatedBy(createdBy);

SetCreatedDate(DateTime)

Void SetCreatedDate(DateTime createdDate)

Returns: CRMScript.Global.Void Example:

NSSelectionEntity thing;
DateTime createdDate;
thing.SetCreatedDate(createdDate);

SetDescription(String)

Void SetDescription(String description)

Returns: CRMScript.Global.Void Example:

NSSelectionEntity thing;
String description;
thing.SetDescription(description);

SetGroupIdx(Integer)

Void SetGroupIdx(Integer groupIdx)

Returns: CRMScript.Global.Void Example:

NSSelectionEntity thing;
Integer groupIdx;
thing.SetGroupIdx(groupIdx);

SetIncludePerson(Integer)

Void SetIncludePerson(Integer includePerson)

Returns: CRMScript.Global.Void Example:

NSSelectionEntity thing;
Integer includePerson;
thing.SetIncludePerson(includePerson);

SetLastLoaded(DateTime)

Void SetLastLoaded(DateTime lastLoaded)

Returns: CRMScript.Global.Void Example:

NSSelectionEntity thing;
DateTime lastLoaded;
thing.SetLastLoaded(lastLoaded);

SetLastLoadedBy(Integer)

Void SetLastLoadedBy(Integer lastLoadedBy)

Returns: CRMScript.Global.Void Example:

NSSelectionEntity thing;
Integer lastLoadedBy;
thing.SetLastLoadedBy(lastLoadedBy);

SetLastLoadedByAssociate(NSAssociate)

Void SetLastLoadedByAssociate(NSAssociate lastLoadedByAssociate)

Returns: CRMScript.Global.Void Example:

NSSelectionEntity thing;
NSAssociate lastLoadedByAssociate;
thing.SetLastLoadedByAssociate(lastLoadedByAssociate);

SetLastMembershipChange(DateTime)

Void SetLastMembershipChange(DateTime lastMembershipChange)

Returns: CRMScript.Global.Void Example:

NSSelectionEntity thing;
DateTime lastMembershipChange;
thing.SetLastMembershipChange(lastMembershipChange);

SetLastMembershipChangeBy(Integer)

Void SetLastMembershipChangeBy(Integer lastMembershipChangeBy)

Returns: CRMScript.Global.Void Example:

NSSelectionEntity thing;
Integer lastMembershipChangeBy;
thing.SetLastMembershipChangeBy(lastMembershipChangeBy);

SetLastMembershipChangeByAssociate(NSAssociate)

Void SetLastMembershipChangeByAssociate(NSAssociate lastMembershipChangeByAssociate)

Returns: CRMScript.Global.Void Example:

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.

Void SetLeftSelectionId(Integer leftSelectionId)

Returns: CRMScript.Global.Void Example:

NSSelectionEntity thing;
Integer leftSelectionId;
thing.SetLeftSelectionId(leftSelectionId);

SetMailingsProviderName(String)

Void SetMailingsProviderName(String mailingsProviderName)

Returns: CRMScript.Global.Void Example:

NSSelectionEntity thing;
String mailingsProviderName;
thing.SetMailingsProviderName(mailingsProviderName);

SetMainHeading(String)

Void SetMainHeading(String mainHeading)

Returns: CRMScript.Global.Void Example:

NSSelectionEntity thing;
String mainHeading;
thing.SetMainHeading(mainHeading);

SetMainProviderName(String)

Void SetMainProviderName(String mainProviderName)

Returns: CRMScript.Global.Void Example:

NSSelectionEntity thing;
String mainProviderName;
thing.SetMainProviderName(mainProviderName);

SetMemberCount(Integer)

Void SetMemberCount(Integer memberCount)

Returns: CRMScript.Global.Void Example:

NSSelectionEntity thing;
Integer memberCount;
thing.SetMemberCount(memberCount);

SetMemberTabHeading(String)

Void SetMemberTabHeading(String memberTabHeading)

Returns: CRMScript.Global.Void Example:

NSSelectionEntity thing;
String memberTabHeading;
thing.SetMemberTabHeading(memberTabHeading);

SetName(String)

Void SetName(String name)

Returns: CRMScript.Global.Void Example:

NSSelectionEntity thing;
String name;
thing.SetName(name);

SetPostit(String)

Void SetPostit(String postit)

Returns: CRMScript.Global.Void Example:

NSSelectionEntity thing;
String postit;
thing.SetPostit(postit);

SetPostitTextId(Integer)

Void SetPostitTextId(Integer postitTextId)

Returns: CRMScript.Global.Void Example:

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.

Void SetRightSelectionId(Integer rightSelectionId)

Returns: CRMScript.Global.Void Example:

NSSelectionEntity thing;
Integer rightSelectionId;
thing.SetRightSelectionId(rightSelectionId);

SetSelectionCategory(NSSelectionCategory)

Void SetSelectionCategory(NSSelectionCategory selectionCategory)

Returns: CRMScript.Global.Void Example:

NSSelectionEntity thing;
NSSelectionCategory selectionCategory;
thing.SetSelectionCategory(selectionCategory);

SetSelectionId(Integer)

Void SetSelectionId(Integer selectionId)

Returns: CRMScript.Global.Void Example:

NSSelectionEntity thing;
Integer selectionId;
thing.SetSelectionId(selectionId);

SetSelectionType(Integer)

Void SetSelectionType(Integer selectionType)

Returns: CRMScript.Global.Void Example:

NSSelectionEntity thing;
Integer selectionType;
thing.SetSelectionType(selectionType);

SetSelectionUnionType(Integer)

Void SetSelectionUnionType(Integer selectionUnionType)

Returns: CRMScript.Global.Void Example:

NSSelectionEntity thing;
Integer selectionUnionType;
thing.SetSelectionUnionType(selectionUnionType);

SetShadowProviderName(String)

Void SetShadowProviderName(String shadowProviderName)

Returns: CRMScript.Global.Void Example:

NSSelectionEntity thing;
String shadowProviderName;
thing.SetShadowProviderName(shadowProviderName);

SetSoundEx(String)

Void SetSoundEx(String soundEx)

Returns: CRMScript.Global.Void Example:

NSSelectionEntity thing;
String soundEx;
thing.SetSoundEx(soundEx);

SetSource(Integer)

Void SetSource(Integer source)

Returns: CRMScript.Global.Void Example:

NSSelectionEntity thing;
Integer source;
thing.SetSource(source);

SetTargetTableName(String)

Void SetTargetTableName(String targetTableName)

Returns: CRMScript.Global.Void Example:

NSSelectionEntity thing;
String targetTableName;
thing.SetTargetTableName(targetTableName);

SetTargetTableNumber(Integer)

Void SetTargetTableNumber(Integer targetTableNumber)

Returns: CRMScript.Global.Void Example:

NSSelectionEntity thing;
Integer targetTableNumber;
thing.SetTargetTableNumber(targetTableNumber);

SetTextId(Integer)

Void SetTextId(Integer textId)

Returns: CRMScript.Global.Void Example:

NSSelectionEntity thing;
Integer textId;
thing.SetTextId(textId);

SetUpdatedBy(NSAssociate)

Void SetUpdatedBy(NSAssociate updatedBy)

Returns: CRMScript.Global.Void Example:

NSSelectionEntity thing;
NSAssociate updatedBy;
thing.SetUpdatedBy(updatedBy);

SetUpdatedCount(Integer)

Void SetUpdatedCount(Integer updatedCount)

Returns: CRMScript.Global.Void Example:

NSSelectionEntity thing;
Integer updatedCount;
thing.SetUpdatedCount(updatedCount);

SetUpdatedDate(DateTime)

Void SetUpdatedDate(DateTime updatedDate)

Returns: CRMScript.Global.Void Example:

NSSelectionEntity thing;
DateTime updatedDate;
thing.SetUpdatedDate(updatedDate);

SetVisibility(Integer)

Obsolete, but still maintained de-normalization of visiblefor

Void SetVisibility(Integer visibility)

Returns: CRMScript.Global.Void Example:

NSSelectionEntity thing;
Integer visibility;
thing.SetVisibility(visibility);

SetVisibleFor(NSVisibleFor[])

Sets the user-groups and/or users the SelectionEntity item is visible for.

Void SetVisibleFor(NSVisibleFor[] visibleFor)

Returns: CRMScript.Global.Void Example:

NSSelectionEntity thing;
NSVisibleFor[] visibleFor = thing.GetVisibleFor();
visibleFor[0].SetVisiblity(1);  // usergroup
visibleFor[0].SetVisibleId(123); // usergroup id
thing.SetVisibleFor(visibleFor);

​Constructors