Class NSTypicalSearches

Syntax

Constructors

NSTypicalSearches()

Initializes a new instance of the NSTypicalSearches class.

Declaration

NSTypicalSearches

Methods

GetDeleteLeftovers()

Declaration

Bool GetDeleteLeftovers()

Returns

Type	Description
Bool	If true, then any TypicalSearch records in the database that are NOT referenced in this call, should be deleted.

Examples

NSTypicalSearches thing;
Bool deleteLeftovers = thing.GetDeleteLeftovers();

GetMasterVersion()

Declaration

Integer GetMasterVersion()

Returns

Type	Description
Integer	The master version number in this update, at least the highest of those in the searches, but can be higher to force an update (and delete of missing elements).

Examples

NSTypicalSearches thing;
Integer masterVersion = thing.GetMasterVersion();

GetSearches()

Declaration

NSTypicalSearch[] GetSearches()

Returns

Type	Description
NSTypicalSearch[]	The TypicalSearch structures (including criteria) to import.

Examples

NSTypicalSearches thing;
NSTypicalSearch[] searches = thing.GetSearches();

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

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

SetDeleteLeftovers(Bool)

Declaration

Void SetDeleteLeftovers(Bool deleteLeftovers)

Parameters

Type	Name	Description
Bool	deleteLeftovers	If true, then any TypicalSearch records in the database that are NOT referenced in this call, should be deleted.

Returns

Type	Description
Void

Examples

NSTypicalSearches thing;
Bool deleteLeftovers;
thing.SetDeleteLeftovers(deleteLeftovers);

SetMasterVersion(Integer)

Declaration

Void SetMasterVersion(Integer masterVersion)

Parameters

Type	Name	Description
Integer	masterVersion	The master version number in this update, at least the highest of those in the searches, but can be higher to force an update (and delete of missing elements).

Returns

Type	Description
Void

Examples

NSTypicalSearches thing;
Integer masterVersion;
thing.SetMasterVersion(masterVersion);

SetSearches(NSTypicalSearch[])

Declaration

Void SetSearches(NSTypicalSearch[] searches)

Parameters

Type	Name	Description
NSTypicalSearch[]	searches	The TypicalSearch structures (including criteria) to import.

Returns

Type	Description
Void

Examples

NSTypicalSearches thing;
NSTypicalSearch[] searches;
thing.SetSearches(searches);

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

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