Class NSTypicalSearch
Constructors
NSTypicalSearch()
Initializes a new instance of the NSTypicalSearch class.
Declaration
NSTypicalSearchMethods
GetEntityName()
Declaration
String GetEntityName()Examples
NSTypicalSearch thing;
String entityName = thing.GetEntityName();Returns
| Type | Description |
| String | The name of the entity the typical search links to. |
GetIncludePerson()
Declaration
Integer GetIncludePerson()Examples
NSTypicalSearch thing;
Integer includePerson = thing.GetIncludePerson();Returns
| Type | Description |
| Integer | For selection-of-company, state of the Include Main Contact checkbox. |
GetIsEntityDefault()
Declaration
Integer GetIsEntityDefault()Examples
NSTypicalSearch thing;
Integer isEntityDefault = thing.GetIsEntityDefault();Returns
| Type | Description |
| Integer | Indicates if this is the default set of criteria for an entity. |
GetRestrictionGroups()
Declaration
NSArchiveRestrictionGroup[] GetRestrictionGroups()Examples
NSTypicalSearch thing;
NSArchiveRestrictionGroup[] restrictionGroups = thing.GetRestrictionGroups();Returns
| Type | Description |
| NSArchiveRestrictionGroup[] | The restrictions (can be multiple groups) that make up the TypicalSearch. |
GetSource()
Declaration
String GetSource()Examples
NSTypicalSearch thing;
String source = thing.GetSource();Returns
| Type | Description |
| String | Name of organization that sources and maintains this TypicalSearch. |
GetTitle()
Declaration
String GetTitle()Examples
NSTypicalSearch thing;
String title = thing.GetTitle();Returns
| Type | Description |
| String | The title of the typical search (multilingual). |
GetTooltip()
Declaration
String GetTooltip()Examples
NSTypicalSearch thing;
String tooltip = thing.GetTooltip();Returns
| Type | Description |
| String | The tooltip for the typical search (multilingual). |
GetTypicalSearchId()
Declaration
Integer GetTypicalSearchId()Examples
NSTypicalSearch thing;
Integer typicalSearchId = thing.GetTypicalSearchId();Returns
| Type | Description |
| Integer | Primary key. |
GetVersionNumber()
Declaration
Integer GetVersionNumber()Examples
NSTypicalSearch thing;
Integer versionNumber = thing.GetVersionNumber();Returns
| Type | Description |
| Integer | The current downloaded version of this typical search. |
SetEntityName(String)
Declaration
Void SetEntityName(String entityName)Examples
NSTypicalSearch thing;
String entityName;
thing.SetEntityName(entityName);Parameters
| Type | Name | Description |
| String | entityName | The name of the entity the typical search links to. |
Returns
| Type | Description |
| Void |
SetIncludePerson(Integer)
Declaration
Void SetIncludePerson(Integer includePerson)Examples
NSTypicalSearch thing;
Integer includePerson;
thing.SetIncludePerson(includePerson);Parameters
| Type | Name | Description |
| Integer | includePerson | For selection-of-company, state of the Include Main Contact checkbox. |
Returns
| Type | Description |
| Void |
SetIsEntityDefault(Integer)
Declaration
Void SetIsEntityDefault(Integer isEntityDefault)Examples
NSTypicalSearch thing;
Integer isEntityDefault;
thing.SetIsEntityDefault(isEntityDefault);Parameters
| Type | Name | Description |
| Integer | isEntityDefault | Indicates if this is the default set of criteria for an entity. |
Returns
| Type | Description |
| Void |
SetRestrictionGroups(NSArchiveRestrictionGroup[])
Declaration
Void SetRestrictionGroups(NSArchiveRestrictionGroup[] restrictionGroups)Examples
NSTypicalSearch thing;
NSArchiveRestrictionGroup[] restrictionGroups;
thing.SetRestrictionGroups(restrictionGroups);Parameters
| Type | Name | Description |
| NSArchiveRestrictionGroup[] | restrictionGroups | The restrictions (can be multiple groups) that make up the TypicalSearch. |
Returns
| Type | Description |
| Void |
SetSource(String)
Declaration
Void SetSource(String source)Examples
NSTypicalSearch thing;
String source;
thing.SetSource(source);Parameters
| Type | Name | Description |
| String | source | Name of organization that sources and maintains this TypicalSearch. |
Returns
| Type | Description |
| Void |
SetTitle(String)
Declaration
Void SetTitle(String title)Examples
NSTypicalSearch thing;
String title;
thing.SetTitle(title);Parameters
| Type | Name | Description |
| String | title | The title of the typical search (multilingual). |
Returns
| Type | Description |
| Void |
SetTooltip(String)
Declaration
Void SetTooltip(String tooltip)Examples
NSTypicalSearch thing;
String tooltip;
thing.SetTooltip(tooltip);Parameters
| Type | Name | Description |
| String | tooltip | The tooltip for the typical search (multilingual). |
Returns
| Type | Description |
| Void |
SetTypicalSearchId(Integer)
Declaration
Void SetTypicalSearchId(Integer typicalSearchId)Examples
NSTypicalSearch thing;
Integer typicalSearchId;
thing.SetTypicalSearchId(typicalSearchId);Parameters
| Type | Name | Description |
| Integer | typicalSearchId | Primary key. |
Returns
| Type | Description |
| Void |
SetVersionNumber(Integer)
Declaration
Void SetVersionNumber(Integer versionNumber)Examples
NSTypicalSearch thing;
Integer versionNumber;
thing.SetVersionNumber(versionNumber);Parameters
| Type | Name | Description |
| Integer | versionNumber | The current downloaded version of this typical search. |
Returns
| Type | Description |
| Void |