The QFindObject client API is used to find objects in the database.
Argument |
Description |
---|---|
Parameter 1 |
Interface name for query by |
Parameter 1 default |
None |
Parameter 1 description |
The interface that should be instantiated by objects for them to be returned by the query. |
Parameter 1 type |
String |
Parameter 2 |
Title |
Parameter 2 default |
None |
Parameter 2 description |
The title that will appear at the top of the query form. |
Parameter 2 type |
String |
Parameter 3 |
Query filter - Property Comparison |
Parameter 3 default |
None |
Parameter 3 description |
Criteria that must be met by an object for it to be returned by the query. |
Parameter 3 type |
String |
Parameter 4 |
Column set to present results |
Parameter 4 default |
None |
Parameter 4 description |
Name of the column set used to present the results of the query against the database. |
Parameter 4 type |
String |
Parameter 5 |
For upper case |
Parameter 5 default |
False |
Parameter 5 description |
True indicates that the criteria provided should be changed, if necessary, to all upper case letters. False leaves letters in the case they were provided in. |
Parameter 5 type |
Boolean |
Parameter 6 |
Refresh Interval (secs) |
Parameter 6 default |
None |
Parameter 6 description |
Used to refresh the results in the list view. The value is in seconds. |
Parameter 6 type |
Integer |
Parameter 7 |
Query Criteria |
Parameter 7 default |
None |
Parameter 7 description |
When a value is provided here, it is used as a search criteria that must be met by objects for them to be returned. If left empty, the user is allowed to provide search criteria when performing the query. |
Parameter 7 type |
String |
Parameter 8 |
Not used |
Parameter 9 |
Configuration Behavior |
Parameter 9 default |
None |
Parameter 9 description |
Indicates what configuration filtering will be applied to the query. Supported values are NullConfigQuery, IgnoreConfigFilter, or no value (blank). NullConfigQuery - Queries once for objects that are not assigned to a configuration. IgnoreConfigFilter - Queries the selected query configurations and their parent configurations, if any exist. Blank - Queries with regular configuration filtering |
Parameter 9 type |
String |
Parameter 10 |
Display light list view |
Parameter 10 default |
None |
Parameter 10 description |
When using paged queries, if set to LIGHTVIEW, the results are displayed in the light list view. |
Parameter 10 type |
String |
Parameter 11 |
Paged query size |
Parameter 11 default |
None |
Parameter 11 description |
A number that indicates how many results should appear on each page of results. If no number is provided, all results will appear on the same page. |
Parameter 11 type |
Integer |
Parameter 12 |
Enable show all for paged |
Parameter 12 default |
None |
Parameter 12 description |
When paged queries are used, True indicates that a Show All option will be available to view all the results on one page. False indicates that the Show All option will not be available. |
Parameter 12 type |
Boolean |
Parameter 13 |
Honor query limit for paged |
Parameter 13 default |
None |
Parameter 13 description |
When using paged queries, True indicates that the user's maximum query limit (set on the Change User Preferences dialog box) will be honored when returning results. False indicates that all results will be returned, regardless of the setting in the user preferences. |
Parameter 13 type |
Boolean |
Parameter 14 |
Enable light list view for paged |
Parameter 14 default |
None |
Parameter 14 description |
When using paged queries, True will enable the list list view, which allows the user to get results back faster. False indicates that the light list view will not be used. |
Parameter 14 type |
Boolean |
Parameter 15 |
Enable extract all to excel for paged |
Parameter 15 default |
None |
Parameter 15 description |
When using paged queries, True enables an Extract All to Excel option that allows the user to export all the results to Microsoft Excel without displaying it in the list view. False disables the Extract All to Excel option. |
Parameter 15 type |
Boolean |
Many methods use this client API, and the list can be viewed in the Web Client. To see the methods in your system that use this client API, find the client API, right-click it, and click Show Methods.