The QueryClassObjFromClass client API is used to configure a shortcut menu method on the classification tree nodes to find classified objects.
Argument |
Description |
---|---|
Parameter 1 |
RelDef to navigate to the ClassDef |
Parameter 1 default |
None |
Parameter 1 description |
The relationship definition used to navigate class definition and to derive the class definition of the classified object being created. |
Parameter 1 type |
String |
Parameter 2 |
Allow classification tree drilldown |
Parameter 2 default |
True |
Parameter 2 description |
Indicates whether to allow the display of a classification tree drilldown when creating the new object. |
Parameter 2 type |
Boolean |
Parameter 3 |
Not used |
Parameter 4 |
Query results title |
Parameter 4 default |
None |
Parameter 4 description |
The title that will appear at the top of the results window. |
Parameter 4 type |
String |
Parameter 5 |
Primary interface override |
Parameter 5 default |
None |
Parameter 5 description |
The override interface definition used in queries, replacing the primary interface. |
Parameter 5 type |
String |
Parameter 6 |
Column set to present results |
Parameter 6 default |
None |
Parameter 6 description |
The name of the column set to be used to display the results of the query. |
Parameter 6 type |
String |
Parameter 7 |
Include ClassDef in query |
Parameter 7 default |
True |
Parameter 7 description |
If True, only objects of the same class definition of the selected object will be included in the results. If False, objects of any class definition may be included in the results. |
Parameter 7 type |
Boolean |
Parameter 8 |
Query filter - Property comparison |
Parameter 8 default |
None |
Parameter 8 description |
Criteria that must be met by an object for it to be returned by the query. |
Parameter 8 type |
String |
Parameter 9 |
Config Behavior |
Parameter 9 default |
None |
Parameter 9 description |
Indicates what configurations will be queried for results. NullConfigQuery - Queries once for null configuration objects. IgnoreConfigFilter - Always queries selected configurations and their parent configurations, Blank - Queries with regular configuration filtering, using the current user's query scope. |
Parameter 9 type |
String |
Parameter 10 |
Classification tree filtering/light view indicator |
Parameter 10 default |
None |
Parameter 10 description |
A ~ separated list of interfaces to perform classification tree filtering (optional). When using paged queries, if it contains LIGHTVIEW, the results are displayed in a light list view. The ~ is used to separate LIGHTVIEW and the interfaces. |
Parameter 10 type |
String |
Parameter 11 |
Page query size |
Parameter 11 default |
None |
Parameter 11 description |
A number to identify the number of results to appear on each page of the paged query view. If no number is specified, all the results will appear on a single page. |
Parameter 11 type |
Integer |
Parameter 12 |
Enable show all for paged |
Parameter 12 default |
None |
Parameter 12 description |
When using paged query, this indicates whether to enable the Show All button that allows the user to view all the results at once. |
Parameter 12 type |
Boolean |
Parameter 13 |
Honor query limit |
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 |
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.