Class NSTypicalSearch

Syntax

Constructors

NSTypicalSearch()

Initializes a new instance of the NSTypicalSearch class.

Declaration

NSTypicalSearch

Methods

GetEntityName()

Declaration

String GetEntityName()

Returns

Type	Description
String	The name of the entity the typical search links to.

Examples

NSTypicalSearch thing;
String entityName = thing.GetEntityName();

GetIncludePerson()

Declaration

Integer GetIncludePerson()

Returns

Type	Description
Integer	For selection-of-company, state of the Include Main Contact checkbox.

Examples

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

GetIsEntityDefault()

Declaration

Integer GetIsEntityDefault()

Returns

Type	Description
Integer	Indicates if this is the default set of criteria for an entity.

Examples

NSTypicalSearch thing;
Integer isEntityDefault = thing.GetIsEntityDefault();

GetRestrictionGroups()

Declaration

NSArchiveRestrictionGroup[] GetRestrictionGroups()

Returns

Type	Description
NSArchiveRestrictionGroup[]	The restrictions (can be multiple groups) that make up the TypicalSearch.

Examples

NSTypicalSearch thing;
NSArchiveRestrictionGroup[] restrictionGroups = thing.GetRestrictionGroups();

GetSource()

Declaration

String GetSource()

Returns

Type	Description
String	Name of organization that sources and maintains this TypicalSearch.

Remarks

Allows for both SuperOffice and partners to maintain sets of typical searches without conflict

Examples

NSTypicalSearch thing;
String source = thing.GetSource();

GetTitle()

Declaration

String GetTitle()

Returns

Type	Description
String	The title of the typical search (multilingual).

Examples

NSTypicalSearch thing;
String title = thing.GetTitle();

GetTooltip()

Declaration

String GetTooltip()

Returns

Type	Description
String	The tooltip for the typical search (multilingual).

Examples

NSTypicalSearch thing;
String tooltip = thing.GetTooltip();

GetTypicalSearchId()

Declaration

Integer GetTypicalSearchId()

Returns

Type	Description
Integer	Primary key.

Examples

NSTypicalSearch thing;
Integer typicalSearchId = thing.GetTypicalSearchId();

GetVersionNumber()

Declaration

Integer GetVersionNumber()

Returns

Type	Description
Integer	The current downloaded version of this typical search.

Examples

NSTypicalSearch thing;
Integer versionNumber = thing.GetVersionNumber();

SetEntityName(String)

Declaration

Void SetEntityName(String entityName)

Parameters

Type	Name	Description
String	entityName	The name of the entity the typical search links to.

Returns

Type	Description
Void

Examples

NSTypicalSearch thing;
String entityName;
thing.SetEntityName(entityName);

SetIncludePerson(Integer)

Declaration

Void SetIncludePerson(Integer includePerson)

Parameters

Type	Name	Description
Integer	includePerson	For selection-of-company, state of the Include Main Contact checkbox.

Returns

Type	Description
Void

Examples

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

SetIsEntityDefault(Integer)

Declaration

Void SetIsEntityDefault(Integer isEntityDefault)

Parameters

Type	Name	Description
Integer	isEntityDefault	Indicates if this is the default set of criteria for an entity.

Returns

Type	Description
Void

Examples

NSTypicalSearch thing;
Integer isEntityDefault;
thing.SetIsEntityDefault(isEntityDefault);

SetRestrictionGroups(NSArchiveRestrictionGroup[])

Declaration

Void SetRestrictionGroups(NSArchiveRestrictionGroup[] restrictionGroups)

Parameters

Type	Name	Description
NSArchiveRestrictionGroup[]	restrictionGroups	The restrictions (can be multiple groups) that make up the TypicalSearch.

Returns

Type	Description
Void

Examples

NSTypicalSearch thing;
NSArchiveRestrictionGroup[] restrictionGroups;
thing.SetRestrictionGroups(restrictionGroups);

SetSource(String)

Declaration

Void SetSource(String source)

Parameters

Type	Name	Description
String	source	Name of organization that sources and maintains this TypicalSearch.

Returns

Type	Description
Void

Remarks

Allows for both SuperOffice and partners to maintain sets of typical searches without conflict

Examples

NSTypicalSearch thing;
String source;
thing.SetSource(source);

SetTitle(String)

Declaration

Void SetTitle(String title)

Parameters

Type	Name	Description
String	title	The title of the typical search (multilingual).

Returns

Type	Description
Void

Examples

NSTypicalSearch thing;
String title;
thing.SetTitle(title);

SetTooltip(String)

Declaration

Void SetTooltip(String tooltip)

Parameters

Type	Name	Description
String	tooltip	The tooltip for the typical search (multilingual).

Returns

Type	Description
Void

Examples

NSTypicalSearch thing;
String tooltip;
thing.SetTooltip(tooltip);

SetTypicalSearchId(Integer)

Declaration

Void SetTypicalSearchId(Integer typicalSearchId)

Parameters

Type	Name	Description
Integer	typicalSearchId	Primary key.

Returns

Type	Description
Void

Examples

NSTypicalSearch thing;
Integer typicalSearchId;
thing.SetTypicalSearchId(typicalSearchId);

SetVersionNumber(Integer)

Declaration

Void SetVersionNumber(Integer versionNumber)

Parameters

Type	Name	Description
Integer	versionNumber	The current downloaded version of this typical search.

Returns

Type	Description
Void

Examples

NSTypicalSearch thing;
Integer versionNumber;
thing.SetVersionNumber(versionNumber);