The FTRSearch client API is used to find objects in a HxGN SDx database that has been indexed using Full Text Retrieval (FTR).
Argument |
Description |
---|---|
Parameter 1 |
Classification UIDs |
Parameter 1 default |
None |
Parameter 1 description |
The UIDs of classifications to be displayed in the Classification tab. |
Parameter 1 type |
String |
Parameter 2 |
Show advanced search criteria |
Parameter 2 default |
False |
Parameter 2 description |
Displays the advanced search criteria. |
Parameter 2 type |
Boolean |
Parameter 3 |
Paged query size |
Parameter 3 default |
50 |
Parameter 3 description |
Enter a value to identify the page size, if a value is not specified then a normal query will be used. |
Parameter 3 type |
Integer |
Parameter 4 |
Enable show all for paged |
Parameter 4 default |
None |
Parameter 4 description |
When using paged queries this will enable the show all button which allows the user to get all the data. |
Parameter 4 type |
Boolean |
Parameter 5 |
Honor query limit for paged |
Parameter 5 default |
None |
Parameter 5 description |
When using paged queries are set to True then the users maximum query limit will be applied to the query. |
Parameter 5 type |
None |
Parameter 6 |
Select InterfaceDef to filter |
Parameter 6 default |
ISPFDocumentVersion |
Parameter 6 description |
When searching for complex objects this selects the interface definition to filter by. |
Parameter 6 type |
String |
Parameter 7 |
Enable Content Search by default |
Parameter 7 default |
False |
Parameter 7 description |
If set to True, FTR Search includes all the properties and contents. Otherwise, FTR Search will look for properties only. |
Parameter 7 type |
Boolean |
Parameter 8 |
Not used |
Parameter 9 |
Not used |
Parameter 10 |
Not used |
Parameter 11 |
Not used |
Parameter 12 |
Not used |
Parameter 13 |
Not used |
Parameter 14 |
Enable light list view for paged |
Parameter 14 default |
False |
Parameter 14 description |
When using paged queries this will enable the light list view which allows the user to get the data quicker. |
Parameter 14 type |
Boolean |
The following methods use the FTRSearch client API to find objects in a HxGN SDx database that has been indexed using Full Text Retrieval (FTR).
-
FTRQFind