ics_enquiry.h

Go to the documentation of this file.

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

/*  */

#ifndef _ICS_ENQUIRY_H_INCLUDED
#define _ICS_ENQUIRY_H_INCLUDED

typedef struct ICS_value_list_entry_s{
    int        unct;       
    int        n_values;   
    char**     values;     
    char **displayValues;  
} ICS_value_list_entry_t, *ICS_value_list_entry_p_t;

typedef struct ICS_value_list_s{
    int                         n_entries;  
    ICS_value_list_entry_p_t    entries;    
} ICS_value_list_t, *ICS_value_list_p_t;

#include <ics/libics_exports.h>

#ifdef __cplusplus
    extern "C"{
#endif

ICS_API int ICS_enquiry_getPomClassNameForICSClass( 
    char**  thePomClassName     
    );

ICS_API int ICS_enquiry_set_ics_expr( 
    const char*                 theQueryName,       
    const char*                 theExprName,        
    const char*                 theClassId,         
    const ICS_value_list_p_t    theICSQueryList,    
    int                         theOptions          
    );

ICS_API int ICS_enquiry_askPomAttributeNames( 
    const char* theClassId,         
    int         theCount,           
    const int*  theUnctList,        
    char***     thePomColumnNames   
    );

ICS_API int ICS_enquiry_create_enquiry( 
    const char*                 theQueryName,       
    const char*                 theClassId,         
    const ICS_value_list_p_t    theICSQueryList,    
    int                         theOptions          
    );

ICS_API int ICS_enquiry_add_select_attrs(
    const char* theQueryName,           
    const char* theClassId,             
    int         theSelectAttrCount,     
    const int*  theSelectAttrs          
    );

ICS_API int ICS_enquiry_add_select_expr(
    const char* theQueryName,       
    const char* theClassId,         
    int         theAttributeId,     
    int         theSelectExpr       
    );
                                       
ICS_API int ICS_enquiry_set_ics_attr_expr(
    const char* theQueryName,       
    const char* theExprName,        
    const char* theClassId,         
    int         theAttributeId,     
    const char* theICSExpr,         
    int         theOptions          
    );

ICS_API int ICS_enquiry_set_attr_icsexpr(
    const char* theQueryName,       
    const char* theExprName,        
    const char* thePOMClassName,    
    const char* thePOMAttrName,     
    const char* theICSExpr,         
    int         theEnqOptions       
    );

ICS_API int ICS_enquiry_set_attr_expr( 
    const char* theQueryName,       
    const char* theExprName,        
    const char* theClassId,         
    int         theAttributeId,     
    int         thePomOperator,     
    const char* thePomExpression,   
    int         theOptions           
    );

ICS_API int ICS_enquiry_search( 
    const char*                 theClassId,         
    const ICS_value_list_p_t    theICSQueryList,    
    int                         theOrderAttrCount,  
    const int*                  theOrderAttrs,      
    const int*                  theOrder,           
    int                         theOptions,         
    int*                        theResultCount,     
    tag_t**                     theResults          
    );

ICS_API int ICS_enquiry_add_order_attrs( 
    const char* theQueryName,       
    const char* theClassId,         
    int         theOrderAttrCount,  
    const int*  theOrderAttrs,      
    const int*  theOrder            
    );

ICS_API int ICS_enquiry_select_distinct( 
    const char*                 theClassId,         
    const ICS_value_list_p_t    theEnquiryValues,   
    int                         theAttributeId,     
    int                         theOptions,         
    int*                        theResultCount,     
    char***                     theResults          
    );

ICS_API int ICS_enquiry_set_expr_for_class( 
    const char* theQueryName,   
    const char* theExprName,    
    const char* theClassId,     
    int         theOptions      
    );

ICS_API int ICS_get_value_list( 
    int                  theEntryCount,  
    const int*           theAttrIds,     
    const char**         theValues,      
    ICS_value_list_p_t * theValueList    
    );

#ifdef __cplusplus
}
#endif

#include <ics/libics_undef.h>
#endif