Class NSSelectionForFind

Syntax

Constructors

NSSelectionForFind()

Initializes a new instance of the NSSelectionForFind class.

Declaration

NSSelectionForFind

Methods

GetCanSaveAsSelection()

Declaration

Bool GetCanSaveAsSelection()

Returns

Type	Description
Bool	Most Find entities support saving the search as a Dynamic Selection. This bool indicates if that is the case.

Examples

NSSelectionForFind thing;
Bool canSaveAsSelection = thing.GetCanSaveAsSelection();

GetFilterScreenHeading()

Declaration

String GetFilterScreenHeading()

Returns

Type	Description
String	'Find sale', or whatever is appropriate for the Findfilter page; this string will contain resource references

Examples

NSSelectionForFind thing;
String filterScreenHeading = thing.GetFilterScreenHeading();

GetMainHeading()

Declaration

String GetMainHeading()

Returns

Type	Description
String	'Sale', intended for the main headings in the Find front page; this string will contain resource references

Examples

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

GetProviderName()

Declaration

String GetProviderName()

Returns

Type	Description
String	The name of the Archive Provider to use when working with this selection; this is the main entity provider, never Shadow, Combined or anything else fancy.

Examples

NSSelectionForFind thing;
String providerName = thing.GetProviderName();

GetSelectionEntityHeading()

Declaration

String GetSelectionEntityHeading()

Returns

Type	Description
String	'Companies', or whatever else is appropriate* the plural form of the entity name, intended for the Selection.Details tab before it is saved (!!); this string will contain resource references

Examples

NSSelectionForFind thing;
String selectionEntityHeading = thing.GetSelectionEntityHeading();

GetSelectionId()

Declaration

Integer GetSelectionId()

Returns

Type	Description
Integer	Primary key.

Examples

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

SetCanSaveAsSelection(Bool)

Declaration

Void SetCanSaveAsSelection(Bool canSaveAsSelection)

Parameters

Type	Name	Description
Bool	canSaveAsSelection	Most Find entities support saving the search as a Dynamic Selection this bool indicates if that is the case.

Returns

Type	Description
Void

Examples

NSSelectionForFind thing;
Bool canSaveAsSelection;
thing.SetCanSaveAsSelection(canSaveAsSelection);

SetFilterScreenHeading(String)

'Find sale', or whatever is appropriate for the Findfilter page; this string will contain resource references

Declaration

Void SetFilterScreenHeading(String filterScreenHeading)

Parameters

Type	Name	Description
String	filterScreenHeading

Returns

Type	Description
Void

Examples

NSSelectionForFind thing;
String filterScreenHeading;
thing.SetFilterScreenHeading(filterScreenHeading);

SetMainHeading(String)

Declaration

Void SetMainHeading(String mainHeading)

Parameters

Type	Name	Description
String	mainHeading	'Sale', intended for the main headings in the Find front page; this string will contain resource references

Returns

Type	Description
Void

Examples

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

SetProviderName(String)

Declaration

Void SetProviderName(String providerName)

Parameters

Type	Name	Description
String	providerName	The name of the Archive Provider to use when working with this selection; this is the main entity provider, never Shadow, Combined or anything else fancy.

Returns

Type	Description
Void

Examples

NSSelectionForFind thing;
String providerName;
thing.SetProviderName(providerName);

SetSelectionEntityHeading(String)

Declaration

Void SetSelectionEntityHeading(String selectionEntityHeading)

Parameters

Type	Name	Description
String	selectionEntityHeading	'Companies', or whatever else is appropriate* the plural form of the entity name, intended for the Selection.Details tab before it is saved (!!); this string will contain resource references

Returns

Type	Description
Void

Examples

NSSelectionForFind thing;
String selectionEntityHeading;
thing.SetSelectionEntityHeading(selectionEntityHeading);

SetSelectionId(Integer)

Declaration

Void SetSelectionId(Integer selectionId)

Parameters

Type	Name	Description
Integer	selectionId	Primary key.

Returns

Type	Description
Void

Examples

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