Class NSTypicalSearches

Constructors

NSTypicalSearches()

Initializes a new instance of the NSTypicalSearches class.

Declaration

NSTypicalSearches

Methods

GetDeleteLeftovers()

Declaration

Bool GetDeleteLeftovers()

Examples

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

Returns

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

GetMasterVersion()

Declaration

Integer GetMasterVersion()

Examples

NSTypicalSearches thing;
Integer masterVersion = thing.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).

GetSearches()

Declaration

NSTypicalSearch[] GetSearches()

Examples

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

Returns

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

GetSource()

Declaration

String GetSource()

Examples

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

Returns

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

SetDeleteLeftovers(Bool)

Declaration

Void SetDeleteLeftovers(Bool deleteLeftovers)

Examples

NSTypicalSearches thing;
Bool deleteLeftovers;
thing.SetDeleteLeftovers(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

SetMasterVersion(Integer)

Declaration

Void SetMasterVersion(Integer masterVersion)

Examples

NSTypicalSearches thing;
Integer masterVersion;
thing.SetMasterVersion(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

SetSearches(NSTypicalSearch[])

Declaration

Void SetSearches(NSTypicalSearch[] searches)

Examples

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

Parameters

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

Returns

Type	Description
Void

SetSource(String)

Declaration

Void SetSource(String source)

Examples

NSTypicalSearches 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