| # | Name | Location | Type | Details | Index | Description |
|---|---|---|---|---|---|---|
| .01 | name(+) | 0;1 | FREE TEXT | B | This property contains the name of the query object being defined. The name should be namespaced. | |
| .02 | file | 0;2 | POINTER | 1 | This property contains the name of the file associated with this query object definition. (Note: It is possible to have a file associated with more than one query object definition.) | |
| .03 | subscripts in global root | 0;3 | NUMERIC | This property contains the number of subscripts in the global root for the file associated with this query object definition. Examples: Global Root Level ----------- ----- ^SCE 0 ^SCPT(404.42) 1 This property is needed by some methods when the intrinic $QSUBCRIPT function is executed. | ||
| .04 | $storage limit | 0;4 | NUMERIC | This property indicates the trigger value of $STORAGE that causes the query object data to be stored in ^TMP global instead of a local array. (The local variable is the default.) If the $STORAGE is less than the Property value then store in global. Examples: $Storage Value Property Value Query Stored in... ============== ============== ================== 30000 10000 local 5000 10000 global | ||
| .07 | ok to transport? | 0;7 | SET OF CODES | 0:NOT OK 1:OK | This field indicates to the transport utility if this query template should be distributed. | |
| 101 | open method | OPEN;E1,245 | FREE TEXT | This property contains any query specific open logic that the custodial pacakge needs performed. This logic is executed after the generic open logic is performed. | ||
| 102 | close method | CLOSE;E1,245 | FREE TEXT | This property contains any query specific close logic that the custodial pacakge needs performed. This logic is executed before the generic close logic is performed. | ||
| 103 | scan method(+) | SCAN;E1,245 | FREE TEXT | This property contains query object specific logic that the custodial package must specify that allows the use of the Scan method by developers. This scan logic typically hard codes references to supported indexes. There is a significant performance reasons for the custidial packages to develop this logic. The Next/Eof scanning approach is much slower then using Scan/Scan Callback approach. For more information, see API definitions for the following: Scan Scan Callback Next EOF Prior BOF | ||
| 104 | zero node method | ZERO;E1,245 | FREE TEXT | This property contains any query specific logic that the custodial pacakge needs performed to screen out unsupported fields on the zero node. Various methods of the query object need to make available to developers the zero node of an entry. For example, during the execution of the filters and scan callbacks, the zero node is made available to developers in the variable Y0. If the custodial package does not support all fields on the zero node, then logic similar to the following needs to be specified in this property: S Y0=$$Y0^XXUTL(Y) ...where Y is the internal entry number | ||
| 200 | supported indexes | INDEX;0 | MULTIPLE | 409.641 | This multiple contains index definitions that are supported by the custodial package when the developer uses this query object definition. |
Not Referenced