enq.h

Go to the documentation of this file.

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

/*  */

#ifndef ENQ_H
#define ENQ_H

#include <unidefs.h>
#include <pom/pom/libpom_exports.h>

/* END OF HEADER */

#ifdef __cplusplus
    extern "C"{
#endif

POMAPI int POM_enquiry_create(
    const char*     enq_id   
    );

POMAPI int POM_enquiry_set_sub_enquiry(
    const char*     enq_id,          
    const char*     sub_enq_id       
    );

POMAPI int POM_enquiry_set_setenquiry(
    const char*     enq_id,          
    const char*     q1               
    );

POMAPI int POM_enquiry_add_select_attrs(
    const char*     enq_id,     
    const char*     aclass,     
    int             n_attrs,    
    const char**    attrs       
    );

POMAPI int POM_enquiry_add_select_exprs(
    const char*     enq_id,     
    int             n_expr_ids, 
    const char**    expr_ids    
    );

POMAPI int POM_enquiry_set_attr_expr(
    const char*     enq_id,     
    const char*     expr_id,    
    const char*     aclass,     
    const char*     attr,       
    int             op,         
    const char*     rhs_id      
    );

POMAPI int POM_enquiry_set_where_expr(
    const char*     enq_id,      
    const char*     expr_id      
    );

POMAPI int POM_enquiry_set_having_expr(
    const char*     enq_id,     
    const char*     expr_id     
    );

POMAPI int POM_enquiry_set_setexpr(
    const char*     enq_id,       
    const char*     set_expr_id,  
    int             set_op,       
    const char*     rhs_id        
    );

POMAPI int POM_enquiry_create_class_alias(
    const char*     enq_id,         
    const char*     aclass,         
    logical         is_pom_class,   
    const char*     alias           
    );

POMAPI int POM_enquiry_add_group_expr(
    const char*     enq_id,     
    const char*     expr_id     
    );

POMAPI int POM_enquiry_add_order_expr(
    const char*     enq_id,     
    const char*     expr_id,    
    int             sort_order  
    );

POMAPI int POM_enquiry_add_group_attr(
    const char*     enq_id,     
    const char*     aclass,     
    const char*     attr        
    );

POMAPI int POM_enquiry_add_order_attr(
    const char*     enq_id,     
    const char*     aclass,     
    const char*     attr,       
    int             sort_order  
    );

POMAPI int POM_enquiry_set_expr(
    const char*     enq_id,     
    const char*     expr_id,    
    const char*     lhs_id,     
    int             op,         
    const char*     rhs_id      
    );

POMAPI int POM_enquiry_set_join_expr(
    const char*     enq_id,     
    const char*     expr_id,    
    const char*     aclass1,    
    const char*     attr1,      
    int             op,         
    const char*     aclass2,    
    const char*     attr2       
    );

POMAPI int POM_enquiry_set_int_expr(
    const char*     enq_id,     
    const char*     expr_id,    
    const char*     aclass,     
    const char*     attr,       
    int             op,         
    int             rhs_val     
    );

POMAPI int POM_enquiry_set_double_expr(
    const char*     enq_id,     
    const char*     expr_id,    
    const char*     aclass,     
    const char*     attr,       
    int             op,         
    double          rhs_val     
    );

POMAPI int POM_enquiry_set_date_expr(
    const char*     enq_id,     
    const char*     expr_id,    
    const char*     aclass,     
    const char*     attr,       
    int             op,         
    date_t          rhs_val     
    );

POMAPI int POM_enquiry_set_char_expr(
    const char*     enq_id,     
    const char*     expr_id,    
    const char*     aclass,     
    const char*     attr,       
    int             op,         
    char            rhs_val     
    );

POMAPI int POM_enquiry_set_string_expr(
    const char*     enq_id,     
    const char*     expr_id,    
    const char*     aclass,     
    const char*     attr,       
    int             op,         
    char*           rhs_val     
    );

POMAPI int POM_enquiry_set_logical_expr(
    const char*     enq_id,     
    const char*     expr_id,    
    const char*     aclass,     
    const char*     attr,       
    int             op,         
    logical         rhs_val     
    );

POMAPI int POM_enquiry_set_tag_expr(
    const char*     enq_id,     
    const char*     expr_id,    
    const char*     aclass,     
    const char*     attr,       
    int             op,         
    tag_t           rhs_val     
    );

POMAPI int POM_enquiry_set_int_value(
    const char*     enq_id,     
    const char*     val_id,     
    int             n_vals,     
    const int*      vals,       
    int             propriety   
    );

POMAPI int POM_enquiry_set_double_value(
    const char*     enq_id,     
    const char*     val_id,     
    int             n_vals,     
    const double*   vals,       
    int             propriety   
    );

POMAPI int POM_enquiry_set_char_value(
    const char*     enq_id,     
    const char*     val_id,     
    int             n_vals,     
    const char*     vals,       
    int             propriety   
    );

POMAPI int POM_enquiry_set_string_value(
    const char*     enq_id,     
    const char*     val_id,     
    int             n_vals,     
    const char**    vals,       
    int             propriety   
    );

POMAPI int POM_enquiry_set_logical_value(
    const char*     enq_id,     
    const char*     val_id,     
    int             n_vals,     
    const logical*  vals,       
    int             propriety   
    );

POMAPI int POM_enquiry_set_date_value(
    const char*     enq_id,     
    const char*     val_id,     
    int             n_vals,     
    const date_t*   vals,       
    int             propriety   
    );

POMAPI int POM_enquiry_set_tag_value(
    const char*     enq_id,     
    const char*     val_id,     
    int             n_vals,     
    const tag_t*    vals,       
    int             propriety   
    );
POMAPI int POM_enquiry_set_id(
    const char*     enq_id,     
    char**          id          
    );

POMAPI int POM_enquiry_combine_enquiry(
    const char*     enq_id,         
    const char*     set_expr_id,    
    const char*     lhs_id,         
    int             set_operator,   
    const char*     rhs_id          
    );

POMAPI int POM_enquiry_ask_int_value(
    const char*     enq_id,     
    const char*     val_id,     
    int*            n_vals,     
    int**           vals        
    );

POMAPI int POM_enquiry_ask_double_value(
    const char*     enq_id,     
    const char*     val_id,     
    int*            n,          
    double**        vals        
    );

POMAPI int POM_enquiry_ask_char_value(
    const char*     enq_id,     
    const char*     val_id,     
    int*            n_vals,     
    char**          vals        
    );

POMAPI int POM_enquiry_ask_date_value(
    const char*     enq_id,     
    const char*     val_id,     
    int*            n,          
    date_t**        vals        
    );

POMAPI int POM_enquiry_ask_logical_value(
    const char*     enq_id,     
    const char*     val_id,     
    int*            n,          
    logical**       vals        
    );

POMAPI int POM_enquiry_ask_string_value(
    const char*     enq_id,     
    const char*     val_id,     
    int*            n,          
    char***         vals        
    );

POMAPI int POM_enquiry_ask_tag_value(
    const char*     enq_id,     
    const char*     val_id,     
    int*            n,          
    tag_t**         vals        
    );

POMAPI int POM_enquiry_set_distinct(
    const char*     enq_id,    
    logical         on         
    );

POMAPI int POM_enquiry_set_query_hint(
    const char*     enq_id,   
    const char*     hint      
    );

POMAPI int POM_enquiry_execute(
    const char*     enq_id,     
    int*            rows,       
    int*            cols,       
    void****        report      
    );

POMAPI int POM_enquiry_ask_column_count(
    const char*     enqid,      
    int*            count       
    );

POMAPI int POM_enquiry_ask_column_type(
    const char*     enq_id,     
    int             index,      
    int*            type        
    );

/* The next #define was used to correct an historic spelling mistake in the header file. The original function name
is now deprecated. */
#define POM_enquiry_ask_colum_size POM_enquiry_ask_column_size

POMAPI int POM_enquiry_ask_column_size(
    const char*     enq_id,     
    int             index,      
    int*            size        
    );

POMAPI int POM_enquiry_ask_column_name(
    const char*     enq_id,     
    int             index,      
    char**          name        
    );

POMAPI int POM_enquiry_ask_class_of_alias(
    const char*     enq_id,         
    const char*     alias,          
    char**          aclass,         
    logical*        is_pom_class    
    );

POMAPI int POM_enquiry_ask_attr_of_alias(
    const char*     enq_id,     
    const char*     alias,      
    char**          aclass,     
    char**          attr        
    );

POMAPI int POM_enquiry_ask_distinct(
    const char*     enq_id,     
    const char*     expr_id,    
    logical*        distinct    
    );

POMAPI int POM_enquiry_delete(
    const char*     enq_id      
    );

POMAPI int POM_enquiry_set_pseudo_calias(
    const char*     enq_id,     
    const char*     aclass,     
    const char*     attr,       
    const char*     alias       
    );

POMAPI int POM_enquiry_set_pseudo_attr(
    const char*     enq_id,     
    const char*     aclass,     
    const char*     attr,       
    int             index,      
    const char*     palias      
    );

POMAPI int POM_enquiry_set_expr_proprety(
    const char*     enq_id,             
    const char*     expr,               
    int             prop                
    );

POMAPI int POM_enquiry_copy_query(
    const char*     enq_from,    
    const char*     enq_to       
    );

POMAPI int POM_enquiry_ask_where_exprid(
    const char*     enq_id,         
    char**          where_expr_id   
    );

/*
    This function exposes internal information about the name of the POM class associated with the data the query returns. It is
    intended for use on queries that select only a single attribute from a class.

    <b>Restrictions:</b>
    <ol>
    <li>enq_id must identify an existing query that has been executed.
    </ol>
*/
POMAPI int POM_enquiry_ask_select_class(
    const char*     enq_id,         
    char**          class_name      
    );

POMAPI int POM_enquiry_ask_query_id(
    tag_t  enq_tag,  
    char** enq_id    
    );

POMAPI int POM_enquiry_ask_select_attr(
    const char*     enq_id,     
    char**          attr_name   
    );

POMAPI int POM_enquiry_register_table (
    const char*     table_name,     
    int             n_columns,      
    const char**    column_names,   
    const int*      column_types,   
    const int*      column_sizes    
    );

POMAPI int POM_enquiry_is_table_registered (
    const char* table_name,     
    logical* is_registered      
    );

POMAPI int POM_enquiry_does_query_exists (
    const char* enq_id,         
    logical* verdict            
    );

POMAPI int POM_enquiry_does_class_alias_exists
(
    const char* enq_id,        
    const char* alias,         
    logical* verdict           
);

#ifdef __cplusplus
}
#endif

#include <pom/pom/libpom_undef.h>

#endif