ITK Function Reference
(V10000.1.0.60_20160308.00)
qry.h
Go to the documentation of this file.
1 /*==============================================================================
2  Copyright (c) 2003-2005 UGS Corporation
3  Unpublished - All Rights Reserved
4  ==============================================================================*/
5 
12 /* */
13 
14 #ifndef QRY_H
15 #define QRY_H
16 
17 #include <unidefs.h>
18 #include <property/propdesc.h>
19 #include <pom/pom/pom_tokens.h>
20 #include <qry/libqry_exports.h>
21 
44 #define QRY_puid (POM_MAX_type_token + 3)
45 
46 typedef enum QRY_domain_e {
47  QRY_DOMAIN_LOCAL,
48  QRY_DOMAIN_REMOTE
52 } QRY_domain_t;
53 
54 typedef enum QRY_where_run_e {
55  QRY_RUN_BY_TC,
56  QRY_RUN_BY_USER_EXIT,
57  QRY_RUN_BY_USER_QUERY,
58  QRY_RUN_BY_KEYWORD_SEARCH,
59  QRY_RUN_BY_EINT_EXIT,
60  QRY_RUN_BY_BOM_REP,
61  QRY_RUN_BY_USAGEWC,
62  QRY_RUN_BY_TC_PLUS_PROCESS,
63  QRY_RUN_BY_USER_EXIT_BO
64 } QRY_where_run_t;
65 
69 typedef enum QRY_append_wildcard_pref_e {
70  QRY_no_automatic_wildcards,
71  QRY_suffix_wild_card,
72  QRY_prefix_wild_card,
73  QRY_prefix_and_suffix_wild_cards
74 } QRY_append_wildcard_pref_t;
75 
79 typedef enum QRY_attribute_type_e
80 {
81  QRY_attribute_char = POM_char,
82  QRY_attribute_date = POM_date,
83  QRY_attribute_double = POM_double,
84  QRY_attribute_float = POM_float,
85  QRY_attribute_int = POM_int,
86  QRY_attribute_logical = POM_logical,
87  QRY_attribute_short = POM_short,
88  QRY_attribute_string = POM_string,
89  QRY_attribute_typed_reference = POM_typed_reference,
90  QRY_attribute_untyped_reference = POM_untyped_reference,
91  QRY_attribute_external_reference = POM_external_reference,
92  QRY_attribute_note = POM_note,
93  QRY_attribute_relationship = PROP_typed_relation,
94  QRY_attribute_puid = QRY_puid
95 } QRY_attribute_type_t;
96 
100 typedef struct QRY_user_query_row_s {
101  struct QRY_user_query_row_s* next;
102  char* object_string;
103  logical might_map_to_tc;
104  char* values[1];
105 } QRY_user_query_row_t;
106 
111 #define QRY_name_size_c 128
112 #define QRY_desc_size_c 512
113 #define QRY_class_size_c 32
114 #define QRY_clause_size_c 240
115 #define QRY_uid_name_size_c 32
116 
122 #define OrderAscending 1
123 #define OrderDescending 2
124 
126 #ifdef __cplusplus
127 extern "C"{
128 #endif
129 
136 extern QRY_API int QRY_ask_name(
137  tag_t query_tag,
138  char qname[QRY_name_size_c + 1]
139  );
140 
144 extern QRY_API int QRY_ask_name2(
145  tag_t query_tag,
146  char **qname
147  );
148 
158 extern QRY_API int QRY_set_name(
159  tag_t query_tag,
160  const char qname[QRY_name_size_c + 1]
161  );
162 
169 extern QRY_API int QRY_set_name2(
170  tag_t query_tag,
171  const char *qname
172  );
173 
180 extern QRY_API int QRY_ask_description(
181  tag_t query_tag,
182  char qdesc[QRY_desc_size_c + 1]
183  );
184 
188 extern QRY_API int QRY_ask_description2(
189  tag_t query_tag,
190  char **qdesc
191  );
192 
202 extern QRY_API int QRY_set_description(
203  tag_t query_tag,
204  const char qdesc[QRY_desc_size_c + 1]
205  );
206 
213 extern QRY_API int QRY_set_description2(
214  tag_t query_tag,
215  const char *qdesc
216  );
217 
224 extern QRY_API int QRY_ask_class(
225  tag_t query_tag,
226  char qclass[QRY_class_size_c + 1]
227  );
228 
232 extern QRY_API int QRY_ask_class2(
233  tag_t query_tag,
234  char **qclass
235  );
236 
247 extern QRY_API int QRY_set_class(
248  tag_t query_tag,
249  const char qclass[QRY_class_size_c + 1]
250  );
251 
259 extern QRY_API int QRY_set_class2(
260  tag_t query_tag,
261  const char *qclass
262  );
263 
274 extern QRY_API int QRY_ask_clauses(
275  tag_t query_tag,
276  char** qclauses
277  );
278 
291 extern QRY_API int QRY_set_clauses(
292  tag_t query_tag,
293  const char* qclauses
294  );
295 
301 extern QRY_API int QRY_find(
302  const char name[QRY_name_size_c + 1],
303  tag_t* query_tag
304  );
305 
309 extern QRY_API int QRY_find2(
310  const char *name,
311  tag_t* query_tag
312  );
313 
318 extern QRY_API int QRY_extent(
319  int* query_count,
320  tag_t** query_tags
321  );
322 
326 extern QRY_API int QRY_find_user_entries(
327  tag_t query_tag,
328  int* entry_count,
329  char*** entries,
330  char*** values
333  );
334 
343 extern QRY_API int QRY_execute(
344  tag_t query_tag,
345  int entry_count,
346  char** entries,
347  char** values,
349  int* num_found,
350  tag_t** results
351  );
352 
368 extern QRY_API int QRY_execute_on_list(
369  tag_t query_tag,
370  int entry_count,
371  char** entries,
372  char** values,
374  int limit_list_count,
375  tag_t* limit_list,
376  int* num_found,
377  tag_t** results
379  );
380 
381 extern QRY_API int QRY_execute_user_exit_query(
382  tag_t query_tag,
383  int entry_count,
384  char** entries,
385  char** values,
386  int* num_columns,
387  char*** results,
388  QRY_user_query_row_t** rows
389  );
390 
398 extern QRY_API int QRY_execute_at_site(
399  int site_id,
401  tag_t query_tag,
402  int entry_count,
403  char** entries,
404  char** values,
406  int* num_found,
407  tag_t** results
408  );
409 
419 extern QRY_API int QRY_execute_with_sort(
420  tag_t query_tag,
421  int entry_count,
422  char** entries,
423  char** values,
425  int num_to_sort,
426  char** keys,
428  int* orders,
432  int* num_found,
433  tag_t** results
434  );
435 
442 extern QRY_API int QRY_execute_on_list_with_sort(
443  tag_t query_tag,
444  int entry_count,
445  char** entries,
446  char** values,
448  int limit_list_count,
449  tag_t* limit_list,
450  int num_to_sort,
451  char** keys,
453  int* orders,
457  int* num_found,
458  tag_t** results
459  );
460 
471 extern QRY_API int QRY_execute_at_site_with_sort(
472  int site_id,
473  tag_t query_tag,
474  int entry_count,
475  char** entries,
476  char** values,
478  int num_to_sort,
479  char** keys,
481  int* orders,
485  int* num_found,
486  tag_t** results
487  );
488 
494 extern QRY_API int QRY_set_name_mode(
495  tag_t query_tag,
496  logical name_mode
497  );
498 
510 extern QRY_API int QRY_set_search_domain(
511  tag_t query_tag,
512  QRY_domain_t search_domain
513  );
514 
526 extern QRY_API int QRY_ask_search_domain(
527  tag_t query_tag,
528  QRY_domain_t* search_domain
529  );
530 
531 extern QRY_API int QRY_set_where_run(
532  tag_t query_tag,
533  QRY_where_run_t where_run
534  );
535 
536 extern QRY_API int QRY_ask_where_run(
537  tag_t query_tag,
538  QRY_where_run_t* where_run
539  );
540 
545 extern QRY_API int QRY_describe_query(
546  tag_t query_tag,
547  int* num_clauses,
548  char*** attr_names,
550  char*** entry_names,
553  char*** logical_ops,
554  char*** math_ops,
555  char*** values,
559  tag_t** lov_tags,
562  int** attr_types
563  );
564 
575 extern QRY_API int QRY_details(
576  tag_t query_tag,
577  logical substitute_keyword,
578  int* num_clauses,
579  char*** attribute_names,
580  char*** entry_names,
581  char*** entry_names_display,
582  char*** logical_operators,
583  char*** math_operators,
584  char*** values,
585  tag_t** lov_tags,
586  int** attached_specifiers,
587  int*** dependent_indexes,
588  int** key_lov_ids,
589  int** attribute_types );
590 
598 extern QRY_API int QRY_ignore_case_on_search(
599  logical ignore_case
600  );
601 
602 extern QRY_API int QRY_compute_sort_preference_names(
603  tag_t query_tag,
604  char** keyname,
605  char** ordername,
606  char** pkeyname,
607  char** pordername
608  );
609 
648 extern QRY_API int QRY_execute_tuples(
649  tag_t query_tag,
650  int entry_count,
651  char** entries,
652  char** values,
654  int limit_list_count,
655  tag_t* limit_list,
656  int* num_rows,
657  int* num_cols,
658  tag_t** results
660  );
661 
667 extern QRY_API int QRY_execute_query(
668  tag_t queryTag,
669  int entryCount,
670  char** entryNames,
671  char** entryValues,
673  int limitCount,
674  tag_t* limitList,
675  int resultsType,
678  int* componentCount,
679  int** hierarchicalMap,
682  tag_t** componentTags
683  );
684 
685 extern QRY_API int QRY_writeToFile(
686  tag_t query_tag,
687  char* fileName
688  );
689 
690 extern QRY_API int QRY_readFromFile(
691  char* fileName,
692  char** queryName
693  );
694 
699 extern QRY_API int QRY_update_fts_index(
700  tag_t object_tag,
701  logical delete_index
702  );
703 
704 
705 extern QRY_API int QRY_execute_query_with_cancel_option(
706  char* queryrequestId,
707  tag_t queryTag,
708  int entryCount,
709  char** entryNames,
710  char** entryValues,
712  int limitCount,
713  tag_t* limitList,
714  int resultsType,
717  int* componentCount,
718  int** hierarchicalMap,
721  tag_t** componentTags
722  );
723 
739 extern QRY_API int QRY_find_objects_based_on_attributes_and_values(
740  char* class_name,
742  int attribute_count,
743  char** names,
744  char** operations,
745  char** values,
748  char** clauses_rules, /***<(I) Array of values to club different clauses.
749  For example AND,OR etc. At present AND is assumed.
750  For future use only. Right now pass NULL */
751  int* num_rows,
752  tag_t** results
754  );
755 
756 extern QRY_API int QRY_execute_bus_obj_query(
757  char* requestId,
758  tag_t typeTag,
759  int entryCount,
760  char** entryNames,
761  char** entryValues,
762  char** entryMathOp,
763  char** entryLogicOp,
764  int* componentCount,
765  tag_t** componentTags
766  );
767 
768 
769 #ifdef __cplusplus
770 }
771 #endif
772 
775 //For deImanization
776 #include <qry/iman_qry.h>
777 
778 #include <qry/libqry_undef.h>
779 #endif