Class NSFreeTextAgent

This agent can be used to manage the free text system.

Syntax

Examples

NSFreeTextAgent agent;
agent.callMethod(arg1, arg2);

Constructors

NSFreeTextAgent()

This agent can be used to manage the free text system.

Introduced or updated in version: 7.5

Declaration

NSFreeTextAgent

Examples

NSFreeTextAgent agent;
agent.callMethod(arg1, arg2);

Methods

AddWords(String)

Adds the words in the string to the stop word list

Introduced or updated in version: 7.5

Declaration

Void AddWords(String stopWords)

Parameters

Type	Name	Description
String	stopWords

Returns

Type	Description
Void

Examples

NSFreeTextAgent agent;
String stopWords;
agent.AddWords(stopWords);

DeleteStopWordsById(Integer[])

Deletes the stop words with these IDs

Introduced or updated in version: 7.5

Declaration

Void DeleteStopWordsById(Integer[] stopWordIds)

Parameters

Type	Name	Description
Integer[]	stopWordIds

Returns

Type	Description
Void

Examples

NSFreeTextAgent agent;
Integer[] stopWordIds;
agent.DeleteStopWordsById(stopWordIds);

GetStatus()

Returns status for the free-text search words

Introduced or updated in version: 7.5

Declaration

NSFreeText GetStatus()

Returns

Type	Description
NSFreeText

Examples

NSFreeTextAgent agent;
NSFreeText res = agent.GetStatus();

GetStopWordList()

Returns the list of stop words

Introduced or updated in version: 7.5

Declaration

String[] GetStopWordList()

Returns

Type	Description
String[]	list of stop words.

Examples

NSFreeTextAgent agent;
String[] res = agent.GetStopWordList();

GetSuggestedStopWords(Integer)

Returns the top used words in the free-text index table, sorted as most used first

Introduced or updated in version: 7.5

Declaration

NSMDOListItem[] GetSuggestedStopWords(Integer countWords)

Parameters

Type	Name	Description
Integer	countWords

Returns

Type	Description
NSMDOListItem[]

Examples

NSFreeTextAgent agent;
Integer countWords;
NSMDOListItem[] res = agent.GetSuggestedStopWords(countWords);

RegenerateIndex(Bool)

Wipes and regenerates the free-text index by scanning the database (free-text search will be unavailable while this operation runs

Introduced or updated in version: 7.5

Declaration

NSBatchTaskInfo RegenerateIndex(Bool runAsBatch)

Parameters

Type	Name	Description
Bool	runAsBatch

Returns

Type	Description
NSBatchTaskInfo

Examples

NSFreeTextAgent agent;
Bool runAsBatch;
NSBatchTaskInfo res = agent.RegenerateIndex(runAsBatch);

SetAutoEnableTravelAreas(Bool)

Introduced or updated in version: 7.5

Declaration

Void SetAutoEnableTravelAreas(Bool autoEnable)

Parameters

Type	Name	Description
Bool	autoEnable	Automatically enable free-text search for new travel areas? true or false.

Returns

Type	Description
Void

Examples

NSFreeTextAgent agent;
Bool autoEnable;
agent.SetAutoEnableTravelAreas(autoEnable);

SetEnabled(Bool)

Sets free-text search to enabled (true) or disabled (false)

Introduced or updated in version: 7.5

Declaration

Void SetEnabled(Bool enabled)

Parameters

Type	Name	Description
Bool	enabled

Returns

Type	Description
Void

Examples

NSFreeTextAgent agent;
Bool enabled;
agent.SetEnabled(enabled);

SetMultiWordOperator(Integer)

Sets the operator used when matching multiple words

Introduced or updated in version: 7.5

Declaration

Void SetMultiWordOperator(Integer freeTextOperator)

Parameters

Type	Name	Description
Integer	freeTextOperator	See FreeTextOperator.

Returns

Type	Description
Void

Examples

NSFreeTextAgent agent;
Integer freeTextOperator;
agent.SetMultiWordOperator(freeTextOperator);

SetSingleWordOperator(Integer)

Sets the operator used when matching single words

Introduced or updated in version: 7.5

Declaration

Void SetSingleWordOperator(Integer freeTextOperator)

Parameters

Type	Name	Description
Integer	freeTextOperator	See FreeTextOperator.

Returns

Type	Description
Void

Examples

NSFreeTextAgent agent;
Integer freeTextOperator;
agent.SetSingleWordOperator(freeTextOperator);