qry/qry.h

Go to the documentation of this file.

/*==============================================================================
                Copyright (c) 2003-2005 UGS Corporation
                   Unpublished - All Rights Reserved
 ==============================================================================*/

/*  */

#ifndef QRY_H
#define QRY_H

#include <unidefs.h>
#include <qry/libqry_exports.h>

typedef enum QRY_domain_e {
    QRY_DOMAIN_LOCAL,
    QRY_DOMAIN_REMOTE
} QRY_domain_t;

typedef 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     
} QRY_where_run_t;


typedef struct QRY_user_query_row_s {
    struct QRY_user_query_row_s*    next;               
    char*                           object_string;
    logical                         might_map_to_tc;  
    char*                           values[1];
} QRY_user_query_row_t;

#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

#define OrderAscending      1
#define OrderDescending     2

#ifdef __cplusplus
extern "C"{
#endif

extern QRY_API int QRY_ask_name(
    tag_t          query_tag,                   
    char           qname[QRY_name_size_c + 1]   
    );


extern QRY_API int QRY_ask_name2(
    tag_t          query_tag,                   
    char           **qname                      
    );

extern QRY_API int QRY_set_name(
    tag_t          query_tag,                   
    const char     qname[QRY_name_size_c + 1]   
    );


extern QRY_API int QRY_set_name2(
    tag_t          query_tag,                   
    const char     *qname                       
    );

extern QRY_API int QRY_ask_description(
    tag_t          query_tag,                   
    char           qdesc[QRY_desc_size_c + 1]   
    );


extern QRY_API int QRY_ask_description2(
    tag_t          query_tag,                   
    char           **qdesc                      
    );

extern QRY_API int QRY_set_description(
    tag_t          query_tag,                   
    const char     qdesc[QRY_desc_size_c + 1]   
    );


extern QRY_API int QRY_set_description2(
    tag_t          query_tag,                   
    const char     *qdesc                       
    );

extern QRY_API int QRY_ask_class(
    tag_t          query_tag,                   
    char           qclass[QRY_class_size_c + 1] 
    );


extern QRY_API int QRY_ask_class2(
    tag_t          query_tag,                   
    char           **qclass                     
    );

extern QRY_API int QRY_set_class(
    tag_t          query_tag,                   
    const char     qclass[QRY_class_size_c + 1] 
    );


extern QRY_API int QRY_set_class2(
    tag_t          query_tag,                   
    const char     *qclass                      
    );

extern QRY_API int QRY_find(
    const char     name[QRY_name_size_c + 1],   
    tag_t*         query_tag                    
    );


extern QRY_API int QRY_find2(
    const char     *name,                       
    tag_t*         query_tag                    
    );

extern QRY_API int QRY_extent(
    int*           query_count,     
    tag_t**        query_tags       
    );

extern QRY_API int QRY_find_user_entries(
    tag_t          query_tag,       
    int*           entry_count,     
    char***        entries,         
    char***        values           
    );


extern QRY_API int QRY_execute(
    tag_t          query_tag,       
    int            entry_count,     
    char**         entries,         
    char**         values,          
    int*           num_found,       
    tag_t**        results          
    );

extern 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              
    );

extern 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            
    );

extern 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          
    );

extern 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          
    );

extern 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              
    );

extern 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          
    );

extern QRY_API int QRY_set_name_mode(
    tag_t          query_tag,   
    logical        name_mode    
    );


extern QRY_API int QRY_set_search_domain(
    tag_t          query_tag,       
    QRY_domain_t   search_domain    
    );

extern QRY_API int QRY_ask_search_domain(
    tag_t          query_tag,       
    QRY_domain_t*  search_domain    
    );

extern QRY_API int QRY_set_where_run(
    tag_t           query_tag,  
    QRY_where_run_t where_run   
    );

extern QRY_API int QRY_ask_where_run(
    tag_t               query_tag,  
    QRY_where_run_t*    where_run   
    );

extern 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       
    );

extern QRY_API int QRY_ignore_case_on_search(
    logical        ignore_case      
    );

extern QRY_API int QRY_compute_sort_preference_names(
    tag_t          query_tag,   
    char**         keyname,     
    char**         ordername,   
    char**         pkeyname,    
    char**         pordername   
    );

extern 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              
    );

extern 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        
    );

extern QRY_API int QRY_writeToFile(
    tag_t          query_tag,   
    char*          fileName     
    );

extern QRY_API  int QRY_readFromFile(
    char*           fileName,   
    char**          queryName   
    );

extern QRY_API int QRY_update_fts_index(
    tag_t           object_tag,     
    logical         delete_index    
    );


extern 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        
    );

extern 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,          /***<(I) Array of values to club different clauses.
                                                    For example AND,OR etc. At present AND is assumed.
                                                    For future use only. Right now pass NULL */
    int*           num_rows,               
    tag_t**        results                 
    );


extern 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           
    );


#ifdef __cplusplus
}
#endif

//For deImanization
#include <qry/iman_qry.h>

#include <qry/libqry_undef.h>
#endif

---