qry.h File Reference

#include <unidefs.h>
#include <property/propdesc.h>
#include <pom/pom/pom_tokens.h>
#include <qry/libqry_exports.h>
#include <qry/iman_qry.h>
#include <qry/libqry_undef.h>

Go to the source code of this file.

Data Structures
struct	QRY_user_query_row_s

Macros
#define	QRY_puid   (POM_MAX_type_token + 3)
Define attribute size
#define	QRY_name_size_c   128
#define	QRY_desc_size_c   512
#define	QRY_class_size_c   32
#define	QRY_clause_size_c   240
#define	QRY_uid_name_size_c   32
Sort Order
#define	OrderAscending   1
#define	OrderDescending   2

Typedefs
typedef enum QRY_append_wildcard_pref_e	QRY_append_wildcard_pref_t
typedef enum QRY_attribute_type_e	QRY_attribute_type_t
typedef enum QRY_domain_e	QRY_domain_t
typedef struct QRY_user_query_row_s	QRY_user_query_row_t
typedef enum QRY_where_run_e	QRY_where_run_t

Enumerations
enum	QRY_append_wildcard_pref_e { QRY_no_automatic_wildcards, QRY_suffix_wild_card, QRY_prefix_wild_card, QRY_prefix_and_suffix_wild_cards }
enum	QRY_attribute_type_e {   QRY_attribute_char = POM_char, QRY_attribute_date = POM_date, QRY_attribute_double = POM_double, QRY_attribute_float = POM_float,   QRY_attribute_int = POM_int, QRY_attribute_logical = POM_logical, QRY_attribute_short = POM_short, QRY_attribute_string = POM_string,   QRY_attribute_typed_reference = POM_typed_reference, QRY_attribute_untyped_reference = POM_untyped_reference, QRY_attribute_external_reference = POM_external_reference, QRY_attribute_note = POM_note,   QRY_attribute_relationship = PROP_typed_relation, QRY_attribute_puid = QRY_puid }
enum	QRY_domain_e { QRY_DOMAIN_LOCAL, QRY_DOMAIN_REMOTE }
enum	QRY_where_run_e {   QRY_RUN_BY_TC, QRY_RUN_BY_USER_EXIT, QRY_RUN_BY_USER_QUERY, QRY_RUN_BY_KEYWORD_SEARCH,   QRY_RUN_BY_EINT_EXIT, QRY_RUN_BY_BOM_REP, QRY_RUN_BY_USAGEWC, QRY_RUN_BY_TC_PLUS_PROCESS,   QRY_RUN_BY_USER_EXIT_BO }

Functions
QRY_API int	QRY_ask_class (tag_t query_tag, char qclass[QRY_class_size_c+1])
QRY_API int	QRY_ask_class2 (tag_t query_tag, char **qclass)
QRY_API int	QRY_ask_clauses (tag_t query_tag, char **qclauses)
QRY_API int	QRY_ask_description (tag_t query_tag, char qdesc[QRY_desc_size_c+1])
QRY_API int	QRY_ask_description2 (tag_t query_tag, char **qdesc)
QRY_API int	QRY_ask_name (tag_t query_tag, char qname[QRY_name_size_c+1])
QRY_API int	QRY_ask_name2 (tag_t query_tag, char **qname)
QRY_API int	QRY_ask_search_domain (tag_t query_tag, QRY_domain_t *search_domain)
QRY_API int	QRY_ask_where_run (tag_t query_tag, QRY_where_run_t *where_run)
QRY_API int	QRY_compute_sort_preference_names (tag_t query_tag, char **keyname, char **ordername, char **pkeyname, char **pordername)
QRY_API int	QRY_describe_query (tag_t query_tag, int *num_clauses, char ***attr_names, char ***entry_names, char ***logical_ops, char ***math_ops, char ***values, tag_t **lov_tags, int **attr_types)
QRY_API int	QRY_details (tag_t query_tag, logical substitute_keyword, int *num_clauses, char ***attribute_names, char ***entry_names, char ***entry_names_display, char ***logical_operators, char ***math_operators, char ***values, tag_t **lov_tags, int **attached_specifiers, int ***dependent_indexes, int **key_lov_ids, int **attribute_types)
QRY_API int	QRY_execute (tag_t query_tag, int entry_count, char **entries, char **values, int *num_found, tag_t **results)
QRY_API int	QRY_execute_at_site (int site_id, tag_t query_tag, int entry_count, char **entries, char **values, int *num_found, tag_t **results)
QRY_API int	QRY_execute_at_site_with_sort (int site_id, tag_t query_tag, int entry_count, char **entries, char **values, int num_to_sort, char **keys, int *orders, int *num_found, tag_t **results)
QRY_API int	QRY_execute_bus_obj_query (char *requestId, tag_t typeTag, int entryCount, char **entryNames, char **entryValues, char **entryMathOp, char **entryLogicOp, int *componentCount, tag_t **componentTags)
QRY_API int	QRY_execute_on_list (tag_t query_tag, int entry_count, char **entries, char **values, int limit_list_count, tag_t *limit_list, int *num_found, tag_t **results)
QRY_API int	QRY_execute_on_list_with_sort (tag_t query_tag, int entry_count, char **entries, char **values, int limit_list_count, tag_t *limit_list, int num_to_sort, char **keys, int *orders, int *num_found, tag_t **results)
QRY_API int	QRY_execute_query (tag_t queryTag, int entryCount, char **entryNames, char **entryValues, int limitCount, tag_t *limitList, int resultsType, int *componentCount, int **hierarchicalMap, tag_t **componentTags)
QRY_API int	QRY_execute_query_with_cancel_option (char *queryrequestId, tag_t queryTag, int entryCount, char **entryNames, char **entryValues, int limitCount, tag_t *limitList, int resultsType, int *componentCount, int **hierarchicalMap, tag_t **componentTags)
QRY_API int	QRY_execute_tuples (tag_t query_tag, int entry_count, char **entries, char **values, int limit_list_count, tag_t *limit_list, int *num_rows, int *num_cols, tag_t **results)
QRY_API int	QRY_execute_user_exit_query (tag_t query_tag, int entry_count, char **entries, char **values, int *num_columns, char ***results, QRY_user_query_row_t **rows)
QRY_API int	QRY_execute_with_sort (tag_t query_tag, int entry_count, char **entries, char **values, int num_to_sort, char **keys, int *orders, int *num_found, tag_t **results)
QRY_API int	QRY_extent (int *query_count, tag_t **query_tags)
QRY_API int	QRY_find (const char name[QRY_name_size_c+1], tag_t *query_tag)
QRY_API int	QRY_find2 (const char *name, tag_t *query_tag)
QRY_API int	QRY_find_objects_based_on_attributes_and_values (char *class_name, int attribute_count, char **names, char **operations, char **values, char **clauses_rules, int *num_rows, tag_t **results)
QRY_API int	QRY_find_user_entries (tag_t query_tag, int *entry_count, char ***entries, char ***values)
QRY_API int	QRY_ignore_case_on_search (logical ignore_case)
QRY_API int	QRY_readFromFile (char *fileName, char **queryName)
QRY_API int	QRY_set_class (tag_t query_tag, const char qclass[QRY_class_size_c+1])
QRY_API int	QRY_set_class2 (tag_t query_tag, const char *qclass)
QRY_API int	QRY_set_clauses (tag_t query_tag, const char *qclauses)
QRY_API int	QRY_set_description (tag_t query_tag, const char qdesc[QRY_desc_size_c+1])
QRY_API int	QRY_set_description2 (tag_t query_tag, const char *qdesc)
QRY_API int	QRY_set_name (tag_t query_tag, const char qname[QRY_name_size_c+1])
QRY_API int	QRY_set_name2 (tag_t query_tag, const char *qname)
QRY_API int	QRY_set_name_mode (tag_t query_tag, logical name_mode)
QRY_API int	QRY_set_search_domain (tag_t query_tag, QRY_domain_t search_domain)
QRY_API int	QRY_set_where_run (tag_t query_tag, QRY_where_run_t where_run)
QRY_API int	QRY_update_fts_index (tag_t object_tag, logical delete_index)
QRY_API int	QRY_writeToFile (tag_t query_tag, char *fileName)

Detailed Description

This file contains Query ITK for general public.

Definition in file qry.h.