pie.h

Go to the documentation of this file.

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

/*  */

#ifndef PIE_H
#define PIE_H

#include <tc/tc_startup.h>

#include <tccore/workspaceobject.h>
#include <pie/libpie_exports.h>

#define PIE_name_size_c                 32
#define PIE_context_size_c              240
#define PIE_desc_size_c                 240
#define CLAUSE_DELIMITERS               ":."
#define PIE_COLON_DELIMITER             ":"
#define PIE_DOT_DELIMITER               "."
#define PIE_WILD_CARD_ASTERIX           "*"

#define CLAUSE_TYPE_STR                 "TYPE"
#define CLAUSE_CLASS_STR                "CLASS"
#define CLAUSE_PROPERTY_STR             "PROPERTY"
#define CLAUSE_ATTRIBUTE_STR            "ATTRIBUTE"
#define CLAUSE_RELATION_STR             "RELATION"
#define CLAUSE_RELATIONP2S_STR          "RELATIONP2S"
#define CLAUSE_RELATIONS2P_STR          "RELATIONS2P"
#define CLAUSE_REFBY_STR                "REFBY"
#define CLAUSE_OCCTYPE_STR              "OCCTYPE"
#define CLAUSE_CONTENT_STR              "CONTENT"
#define CLAUSE_FUNCTION_STR             "FUNCTION"

#define PROCESS_DIRECTIVE               "PROCESS"
#define NOPROCESS_TRAVERSE_DIRECTIVE    "TRAVERSE_NO_PROCESS"
#define PROCESS_AND_TRAVERSE_DIRECTIVE  "TRAVERSE_AND_PROCESS"

#define CLAUSE_PROPERTY_RULE_DO_STR     "DO"
#define CLAUSE_PROPERTY_RULE_SKIP_STR   "SKIP"
#define CLAUSE_PROPERTY_RULE_SKIP_GRM_STR "SKIP_GRM"

#define CLAUSE_PROPERTY_RULE_STUB_KEY_STR "STUB_KEY"

#define CLAUSE_PROPERTY_RULE_CAND_KEY_STR "CAND_KEY"

#define TRANSIENT_VOLUME_ROOTDIR        "Transient_Volume_RootDir"

typedef enum PIE_type_e
{
    PIE_class = 0,
    PIE_type  = 1
} PIE_type_t;

typedef enum PIE_connection_type_e
{
    PIE_property             = 0,
    PIE_attribute            = 1,
    PIE_relation_primary     = 2,
    PIE_relation_secondary   = 3,
    PIE_referenced_by        = 4,
    PIE_all                  = 5,
    PIE_occurrence_type      = 6,
    PIE_content              = 7,    
    PIE_function             = 8
} PIE_connection_type_t;

typedef enum PIE_rule_type_e
{
    PIE_skip                  = 1,
    PIE_process               = 2,
    PIE_travers_no_process    = 4,
    PIE_travers_and_process   = 6,
    PIE_skip_grm              = 32
} PIE_rule_type_t;

typedef enum PIE_prop_rule_type_e
{
    PIE_prop_do         = 0,    
    PIE_prop_skip       = 1,    
    PIE_prop_stub_key   = 2,    
    PIE_prop_cand_key   = 3     
} PIE_prop_rule_type_t;

typedef enum PIE_direction_e
{
    PIE_teamcenter2PLMXML  = 0,
    PIE_PLMXML2teamcenter  = 1,
    PIE_direction_both  = 2
} PIE_direction_t;

typedef enum PIE_schema_e
{
    PIE_ALL_schema  = 2,
    PIE_PLMXML_schema  = 0,
    PIE_TcXML_schema  = 1
} PIE_schema_t;

#define PIE_TcPLMXML_schema PIE_TcXML_schema

typedef enum PIE_transferoptionset_scope_e
{
    PIE_transferoptionset_private = 0,
    PIE_transferoptionset_public  = 1,
    PIE_transferoptionset_all  = 2
} PIE_transferoptionset_scope_t;

typedef enum PIE_scope_e
{
    PIE_TEAMCENTER   = 0,
    PIE_PLMXML  = 1
} PIE_scope_t;

typedef enum PIE_action_e
{
    PIE_PREACTION     = 0,
    PIE_DURINGACTION  = 1,
    PIE_POSTACTION    = 2
} PIE_action_t;

typedef enum PIE_object_status_in_map_e
{
    PIE_NOCOMMENT        = 0,     
    PIE_NEW              = 1,     
    PIE_MOD              = 2,     
    PIE_PROC_NO_TRAV     = 3,     
    PIE_PROC_AGAIN       = 4,     
    PIE_DS_REVISED       = 5,     
    PIE_DS_ADD_TO_IC     = 6,     
    PIE_DS_TO_VERSION    = 7,     
    PIE_BOMLine_editable = 8,     
    PIE_POMCLASS         = 1024,  
    PIE_DEL              = 10,    
    PIE_INCOMPLETE       = 11     
} PIE_object_status_in_map_t;

typedef enum PIE_user_exits_type_e
{
    PIE_internal_user_exits  = 0,
    PIE_external_user_exits  = 1
}PIE_user_exits_type_t;


#ifdef __cplusplus
    extern "C"{
#endif

extern PIE_API int PIE_find_transfer_mode(
    const char     transfer_mode_name[WSO_name_size_c +1],  
    const char     context_string[PIE_context_size_c +1],   
    int*           n_transfer_mode_tags,                    
    tag_t**        transfer_mode_tags                       
    );

extern PIE_API int PIE_find_transfer_mode2(
    const char     *transfer_mode_name,                     
    const char     *context_string,                         
    int*           n_transfer_mode_tags,                    
    tag_t**        transfer_mode_tags                       
    );

extern PIE_API int PIE_extent_transfer_modes(
    int*           n_transfer_modes,    
    tag_t**        transfer_modes       
    );

extern PIE_API int PIE_create_transfer_mode_instance(
    const char     transfer_mode_name[WSO_name_size_c +1],  
    const char     transfer_mode_desc[WSO_desc_size_c +1],  
    const char     context_string[PIE_context_size_c +1],   
    tag_t*         transfer_mode                            
    );

extern PIE_API int PIE_create_transfer_mode_instance2(
    const char     *transfer_mode_name,                     
    const char     *transfer_mode_desc,                     
    const char     *context_string,                         
    tag_t*         transfer_mode                            
    );


extern PIE_API int PIE_transfer_mode_get_context_string(
    tag_t          transfer_mode,                           
    char           context_string[PIE_context_size_c + 1]   
    );


extern PIE_API int PIE_transfer_mode_get_context_string2(
    tag_t          transfer_mode,                           
    char           **context_string                         
    );

extern PIE_API int PIE_transfer_mode_set_context_string(
    tag_t          transfer_mode,                           
    const char     context_string[PIE_context_size_c +1]    
    );


extern PIE_API int PIE_transfer_mode_set_context_string2(
    tag_t          transfer_mode,                           
    const char     *context_string                          
    );

extern PIE_API int PIE_transfer_mode_set_xslt(
    tag_t          transfer_mode,   
    int            n_files,         
    tag_t*         xslt_files       
    );

extern PIE_API int PIE_transfer_mode_remove_xslt(
    tag_t          transfer_mode,   
    tag_t          xslt_file        
    );

extern PIE_API int PIE_transfer_mode_get_xslt(
    tag_t          transfer_mode,   
    int*           n_files,         
    tag_t**        xslt_files       
    );

extern PIE_API int PIE_transfer_mode_get_direction(
    tag_t            transfer_mode, 
    PIE_direction_t* direction      
    );

extern PIE_API int PIE_transfer_mode_set_direction(
    tag_t           transfer_mode,  
    PIE_direction_t direction       
    );

extern PIE_API int PIE_transfer_mode_get_schema_format(
    tag_t            transfer_mode, 
    PIE_schema_t* schema_format     
    );

extern PIE_API int PIE_transfer_mode_set_schema_format(
    tag_t           transfer_mode,  
    PIE_schema_t schema_format      
    );

extern PIE_API int PIE_transfer_mode_get_incremental(
    tag_t          transfer_mode,   
    logical*       incremental      
    );

extern PIE_API int PIE_transfer_mode_set_incremental(
    tag_t          transfer_mode,   
    logical        incremental      
    );

extern PIE_API int PIE_transfer_mode_get_multisite(
  tag_t       transfer_mode,                              /* <I> */
  logical    *multisite                                   /* <O> */
  );

extern PIE_API int PIE_transfer_mode_set_multisite(
  tag_t       transfer_mode,                              /* <I> */
  logical     multisite                                   /* <I> */
  );

extern PIE_API int PIE_transfer_mode_get_closures(
    tag_t          transfer_mode,   
    tag_t*         closure          
    );

extern PIE_API int PIE_transfer_mode_set_closures(
    tag_t          transfer_mode,   
    tag_t          closure          
    );

extern PIE_API int PIE_transfer_mode_get_filters(
    tag_t          transfer_mode,   
    tag_t*         filter           
    );

extern PIE_API int PIE_transfer_mode_set_filters(
    tag_t          transfer_mode,   
    tag_t          filter           
    );

extern PIE_API int PIE_transfer_mode_load_defaults(
    tag_t          transfer_mode    
    );

extern PIE_API int PIE_transfer_mode_get_prop_set(
    tag_t          transfer_mode,   
    tag_t*         prop_set         
    );

extern PIE_API int PIE_transfer_mode_set_prop_set(
    tag_t          transfer_mode,   
    tag_t          prop_set         
    );

extern PIE_API int PIE_transfer_mode_get_config_objs(
    tag_t          transfer_mode,   
    int*           n_config_objs,   
    tag_t**        config_objs      
    );

extern PIE_API int PIE_transfer_mode_set_config_objs(
    tag_t          transfer_mode,   
    int            n_config_objs,   
    tag_t*         config_objs      
    );

extern PIE_API int PIE_transfer_mode_get_action_list(
    tag_t          transfer_mode,       
    int*           n_action_list_objs,  
    tag_t**        action_list_objs     
    );

extern PIE_API int PIE_transfer_mode_set_action_list(
    tag_t          transfer_mode,       
    int            n_action_list_objs,  
    tag_t*         action_list_objs     
    );

extern PIE_API int PIE_create_closure_rules(
    const char     name[PIE_name_size_c + 1],   
    const char     desc[PIE_desc_size_c + 1],   
    PIE_scope_t    scope,                       
    tag_t*         closure_tag                  
    );

extern PIE_API int PIE_create_closure_rules2(
    const char     *name,                       
    const char     *desc,                       
    PIE_scope_t    scope,                       
    tag_t*         closure_tag                  
    );

extern PIE_API int PIE_closure_add_rule_clause(
    tag_t                 closure_tag,      
    PIE_type_t            p_class_or_type,  
    const char*           p_name,           
    PIE_connection_type_t c_type,           
    const char*           c_name,           
    const char*           prop_name,        
    PIE_type_t            s_class_or_type,  
    const char*           s_name,           
    PIE_rule_type_t       rule_type         
    );

extern PIE_API int PIE_closure_set_rule_clause(
    tag_t                 closure_tag,      
    int                   index,            
    PIE_type_t            p_class_or_type,  
    const char*           p_name,           
    PIE_connection_type_t c_type,           
    const char*           c_name,           
    const char*           prop_name,        
    PIE_type_t            s_class_or_type,  
    const char*           s_name,           
    PIE_rule_type_t       rule_type         
    );

extern PIE_API int PIE_describe_closure_rule(
    tag_t          closure_tag,                 
    char           name[PIE_name_size_c + 1],   
    char           desc[PIE_desc_size_c + 1],   
    PIE_scope_t*   scope,                       
    int*           n_clauses                    
    );

extern PIE_API int PIE_describe_closure_rule2(
    tag_t          closure_tag,                 
    char           **name,                      
    char           **desc,                      
    PIE_scope_t*   scope,                       
    int*           n_clauses                    
    );

extern PIE_API int PIE_closure_get_rule_clause(
    tag_t                  closure_tag,     
    int                    index,           
    PIE_type_t*            p_class_or_type, 
    char**                 p_name,          
    PIE_connection_type_t* c_type,          
    char**                 c_name,          
    char**                 prop_name,       
    PIE_type_t*            s_class_or_type, 
    char**                 s_name,          
    PIE_rule_type_t*       rule_type        
    );


extern PIE_API int PIE_find_closure_rules(
    const char     name[PIE_name_size_c + 1],   
    PIE_scope_t    scope,                       
    int*           n_closure_tags,              
    tag_t**        closure_tags                 
    );

extern PIE_API int PIE_find_closure_rules2(
    const char     *name,                       
    PIE_scope_t    scope,                       
    int*           n_closure_tags,              
    tag_t**        closure_tags                 
    );

extern PIE_API int PIE_create_filter(
    const char     name[PIE_name_size_c + 1],   
    const char     desc[PIE_desc_size_c + 1],   
    PIE_scope_t    scope,                       
    tag_t*         filter                       
    );

extern PIE_API int PIE_create_filter2(
    const char     *name,                       
    const char     *desc,                       
    PIE_scope_t    scope,                       
    tag_t*         filter                       
    );

extern PIE_API int PIE_find_filter(
    const char     name[PIE_name_size_c + 1],   
    PIE_scope_t    scope,                       
    int*           n_filter_tags,               
    tag_t**        filter_tags                  
    );


extern PIE_API int PIE_find_filter2(
    const char     *name,                       
    PIE_scope_t    scope,                       
    int*           n_filter_tags,               
    tag_t**        filter_tags                  
    );

extern PIE_API int PIE_describe_filter(
    tag_t          filter_tag,                  
    char           name[PIE_name_size_c + 1],   
    char           desc[PIE_desc_size_c + 1],   
    PIE_scope_t*   scope,                       
    int*           n_clauses                    
    );

extern PIE_API int PIE_describe_filter2(
    tag_t          filter_tag,                  
    char           **name,                      
    char           **desc,                      
    PIE_scope_t*   scope,                       
    int*           n_clauses                    
    );

extern PIE_API int PIE_filter_add_clause(
    tag_t          filter,          
    PIE_type_t     type_or_class,   
    const char*    p_name,          
    const char*    filter_name      
    );

extern PIE_API int PIE_filter_get_clause(
    tag_t          filter,          
    int            index,           
    PIE_type_t*    type_or_class,   
    char**         p_name,          
    char**         filter_name      
    );

extern PIE_API int PIE_create_action(
    const char     name[PIE_name_size_c + 1],   
    const char     desc[PIE_desc_size_c + 1],   
    PIE_scope_t    scope,                       
    PIE_action_t   type,                        
    const char*    actionName,                  
    tag_t*         action                       
    );

extern PIE_API int PIE_create_action2(
    const char     *name,                       
    const char     *desc,                       
    PIE_scope_t    scope,                       
    PIE_action_t   type,                        
    const char*    actionName,                  
    tag_t*         action                       
    );

extern PIE_API int PIE_find_action(
    const char     name[PIE_name_size_c + 1],   
    PIE_scope_t    scope,                       
    int*           n_action_tags,               
    tag_t**        action_tags                  
    );


extern PIE_API int PIE_find_action2(
    const char     *name,                       
    PIE_scope_t    scope,                       
    int*           n_action_tags,               
    tag_t**        action_tags                  
    );

extern PIE_API int PIE_describe_action(
    tag_t          action_tag,                  
    char           name[PIE_name_size_c + 1],   
    char           desc[PIE_desc_size_c + 1],   
    PIE_scope_t*   scope,                       
    PIE_action_t*  type,                        
    char**         actionName                   
    );

extern PIE_API int PIE_describe_action2(
    tag_t          action_tag,                  
    char           **name,                      
    char           **desc,                      
    PIE_scope_t*   scope,                       
    PIE_action_t*  type,                        
    char**         actionName                   
    );

extern PIE_API int PIE_action_set_func_name(
    tag_t          action,      
    const char*    func_name    
    );

extern PIE_API int PIE_action_get_func_name(
    tag_t          action,      
    char**         func_name    
    );

extern PIE_API int PIE_create_prop_set(
    const char     name[PIE_name_size_c + 1],   
    const char     desc[PIE_desc_size_c + 1],   
    PIE_scope_t    scope,                       
    tag_t*         prop_set                     
    );

extern PIE_API int PIE_create_prop_set2(
    const char     *name,                       
    const char     *desc,                       
    PIE_scope_t    scope,                       
    tag_t*         prop_set                     
    );

extern PIE_API int PIE_find_prop_set(
    const char     name[PIE_name_size_c + 1],   
    PIE_scope_t    scope,                       
    int*           n_propset_tags,              
    tag_t**        propset_tags                 
    );

extern PIE_API int PIE_find_prop_set2(
    const char     *name,                       
    PIE_scope_t    scope,                       
    int*           n_propset_tags,              
    tag_t**        propset_tags                 
    );

extern PIE_API int PIE_prop_add_clause(
    tag_t                 prop_set,         
    PIE_type_t            type_or_class,    
    const char*           p_name,           
    PIE_connection_type_t prop_or_attr,     
    const char*           a_name,           
    PIE_prop_rule_type_t  rule_type         
    );

extern PIE_API int PIE_describe_prop_set(
    tag_t          prop_set,                    
    char           name[PIE_name_size_c + 1],   
    char           desc[PIE_desc_size_c + 1],   
    PIE_scope_t*   scope,                       
    int*           n_clauses                    
    );

extern PIE_API int PIE_describe_prop_set2(
    tag_t          prop_set,                    
    char           **name,                      
    char           **desc,                      
    PIE_scope_t*   scope,                       
    int*           n_clauses                    
    );

extern PIE_API int PIE_prop_get_clause(
    tag_t                  prop_set,        
    int                    index,           
    PIE_type_t*            type_or_class,   
    char**                 p_name,          
    PIE_connection_type_t* prop_or_attr,    
    char**                 a_name,          
    PIE_prop_rule_type_t*  rule_type        
    );

extern PIE_API int PIE_find_transfer_option_set(
    const char     *transfer_option_set_name,                     
    int*           num_transfer_option_set_tags,                  
    tag_t**        transfer_option_set_tags                       
    );


extern PIE_API int PIE_get_available_transfer_option_sets(
    tag_t    user,            
    tag_t    group,           
    tag_t    role,            
    int      n_sites,         
    tag_t *   sites,          
    logical  is_push,         
    logical  is_export,       
    int *    n_optionsets,    
    tag_t **  option_set_objs 
    );

extern PIE_API int PIE_describe_option_set(
    tag_t     option_set_tag,                           
    char   option_set_name[WSO_name_size_c + 1],        
    char   option_set_description[WSO_desc_size_c + 1], 
    tag_t*   transfermode,                              
    char   transfermode_name[WSO_name_size_c + 1],      
    tag_t*   site,                                      
    int*     n_options,                                 
    char***  option_names,                              
    char***  option_display_names,                      
    char***  option_values,                             
    char***  option_descriptions,                       
    char***  option_group_names,                        
    logical** option_read_only_flags                    
    );

extern PIE_API int PIE_describe_option_set2(
    tag_t     option_set_tag,                           
    char   **option_set_name,                           
    char   **option_set_description,                    
    tag_t*   transfermode,                              
    char   **transfermode_name,                         
    tag_t*   site,                                      
    int*     n_options,                                 
    char***  option_names,                              
    char***  option_display_names,                      
    char***  option_values,                             
    char***  option_descriptions,                       
    char***  option_group_names,                        
    logical** option_read_only_flags                    
    );

extern PIE_API int PIE_create_session(
    tag_t*         session      
    );

extern PIE_API int PIE_create_session_for_ai(
    tag_t          request,     
    tag_t*         session      
    );

extern PIE_API int PIE_session_set_file(
    tag_t          session,     
    const char*    file_name    
    );

extern PIE_API int PIE_session_ask_file(
    tag_t          session,     
    const char**   file_name    
    );

extern PIE_API int PIE_session_set_log_file(
    tag_t          session,     
    const char*    file_name    
    );

extern PIE_API int PIE_session_ask_transfer_mode(
  tag_t            session,         
  tag_t*           transfer_mode    
  );

extern PIE_API int PIE_session_set_transfer_mode(
    tag_t          session,         
    tag_t          transfer_mode    
    );

extern PIE_API int PIE_session_set_revision_rule(
    tag_t          session,         
    tag_t          revision_rule    
    );

extern PIE_API int PIE_session_export_objects(
    tag_t          session,     
    int            n_objs,      
    tag_t*         obj_list     
    );

extern PIE_API int PIE_session_get_target_pathname(
    tag_t          session,     
    char**         pathname     
    );

extern PIE_API int PIE_session_set_target_pathname(
    tag_t          session,     
    char*          pathname     
    );

extern PIE_API int PIE_session_get_incremental_change(
    tag_t     session,                  /* <I> */
    tag_t     *incremental_change       /* <O> */
  );

extern PIE_API int PIE_session_set_incremental_change(
    tag_t     session,                  /* <I> */
    tag_t     incremental_change        /* <I> */
  );

extern PIE_API int PIE_session_set_edit_targets(
    tag_t          session,                 
    int            num_tags,                
    tag_t*         tags_allowed_to_edit     
  );

extern PIE_API int PIE_session_set_ic_exclusion_list(
    tag_t          session,                 
    int            num_tags,                
    tag_t*         ic_tags_to_exclude       
  );

extern PIE_API int PIE_session_import_objects(
    tag_t          session,     
    logical        dry_run,     
    int*           n_objs,      
    tag_t**        obj_list     
    );

extern PIE_API int PIE_session_get_rule_types(
    tag_t          session,     
    int*           n_types,     
    char***        typeNames    
    );
extern PIE_API int PIE_session_get_log_lines(
    tag_t          session,     
    int*           n_lines,     
    char***        log_lines    
    );
extern PIE_API int PIE_session_get_errors(
    tag_t          session,         
    int*           n_errors,        
    tag_t**        error_objs,      
    int**          error_codes      
    );
extern PIE_API int PIE_session_get_import_errors(
    tag_t          session,         
    int*           n_errors,        
    char***         error_ids,      
    int**          error_codes      
    );

extern PIE_API int PIE_delete_session(
    tag_t          session      
    );

extern PIE_API int PIE_session_add_info(
    tag_t          session,     
    int            n_strings,   
    char**         titles,      
    char**         values       
    );

extern PIE_API int PIE_session_ask_info(
    tag_t          session,     
    int*           n_strings,   
    char***        titles,      
    char***        values       
    );
extern PIE_API int PIE_session_set_xslt(
    tag_t          session,     
    logical        override,    
    int            n_files,     
    tag_t*         xslt_files   
    );
extern PIE_API int PIE_session_get_xslt(
    tag_t          session,     
    logical*       override,    
    int*           n_files,     
    tag_t**        xslt_files   
    );

extern PIE_API int PIE_session_get_user_xslt_file(
    tag_t          session,         
    char**         user_xslt_fname  
    );

extern PIE_API int PIE_session_set_user_xslt_file(
    tag_t          session,         
    const char*    user_xslt_fname  
    );

extern PIE_API int PIE_session_get_export_locales(
    tag_t          session,            
    int            *exportlocaleCount, 
    char           ***exportLocales    
    );

extern PIE_API int PIE_session_set_export_locales(
    tag_t          session,            
    const int      exportlocaleCount,  
    char           **exportLocales     
    );

extern PIE_API int PIE_session_get_plmxml_document(
    tag_t          session,            
    void           **plmxmlDoc         
    );

extern PIE_API int PIE_session_update_processed_object(
    tag_t          session,            
    tag_t          obj,                
    void           *plmxmlObj,         
    int            failCode            
    );

extern PIE_API int PIE_session_get_processed_plmxml_object(
    tag_t          session,            
    tag_t          obj,                
    void           **plmxmlObj,        
    int            *failCode           
    );

extern PIE_API int PIE_session_get_processed_tc_object(
    tag_t          session,            
    void           *plmxmlObj,         
    tag_t          *obj,               
    int            *failCode           
    );

extern PIE_API int PIE_create_delta_info(
    tag_t*         delta_info   
    );

extern PIE_API int PIE_create_bom_delta_info(
    tag_t*         piebomdeltainfo      
    );

extern PIE_API int PIE_add_delta_objects(
    tag_t          delta_info,  
    int            n_objs,      
    tag_t*         objs         
    );

extern PIE_API int PIE_get_delta_adds(
    tag_t          delta_info,      
    int*           n_objs,          
    tag_t**        added_objs       
    );

extern PIE_API int PIE_get_delta_deletes(
    tag_t          delta_info,      
    int*           n_objs,          
    tag_t**        deleted_objs     
    );

extern PIE_API int PIE_get_delta_modifications(
    tag_t          delta_info,      
    int*           n_objs,          
    tag_t**        modified_objs    
    );

extern PIE_API int PIE_create_delta_session(
    tag_t          old_xml_file,    
    char*          targetPathName,  
    tag_t*         session          
    );

extern PIE_API int PIE_merge_delta_to_base(
    tag_t          session,         
    tag_t*         merged_xml_file  
    );

extern PIE_API int PIE__compare_set_visitor(
    tag_t          diff_set,
    int            depth,
    void*          user_data
    );

extern PIE_API int PIE_find_object_by_appref(
    char *appuid,  
    char *appl,    
    char *site,    
    char *ver,     
    int *count,    
    tag_t **found    
    );


/*
 * External User exits import/export methods support
 */
typedef int (* PIE_user_method_func_t)( void *);
typedef struct PIEUserMethodList_s
{
    const char             *contextStr;   /* Context String */
    const char             *name;         /* Class or type name */
    PIE_user_method_func_t  func;         /* User method */
} PIEUserMethodList_t;


extern PIE_API int PIE_register_user_methods(
    void* listUserMethods,    
    int n_methods             
    );

typedef struct
{
    char                 *teamcenterObject;     /* Class name of Teamcenter object */
    char                 *plmxml_class;    /* Class name of plmxml object */
    char                 *teamcenterProperty;   /* Property name of Teamcenter object */
    char                 *plmxmlAttribute; /* Attribute name of plmxml object */
    logical              addToParent;      /* Flag to add to parent */
} PIEUserSchemaMap;


extern PIE_API int PIE_register_user_schema(
    void* listUserSchemas,      
    int n_schemas               
    );

typedef int (* PIE_user_action_func_t)( tag_t );

extern PIE_API int PIE_register_user_action (
  char*                      handleName,    
  PIE_user_action_func_t     user_m         
  );


typedef PIE_rule_type_t (* PIE_user_filter_func_t)( void *);

extern PIE_API int PIE_register_user_filter (
  char*          filterRuleName,    
  PIE_user_filter_func_t user_m     
  );

extern PIE_API int PIE_get_class_from_callpath(
  void         *userPath,         
  char        **calledClass       
  );

extern PIE_API int PIE_get_type_from_callpath(
  void         *userPath,         
  char        **calledType        
  );

extern PIE_API int PIE_get_obj_from_callpath(
  void         *userPath,         
  tag_t        *objTag            
  );

extern PIE_API int PIE_get_plmxmlobj_from_callpath(
  void         *userPath,         
  void         **plmxmlobj        
  );

extern PIE_API int PIE_get_prior_callpath(
  void         *userPath,         
  void        **prev_userPath     
  );

extern PIE_API int PIE_find_callpath_by_class(
   void         *userPath,     
   char         *className,    
   void        **calledPath    
  );

extern PIE_API int PIE_find_callpath_by_type(
   void         *userPath,     
   char         *typeName,     
   void        **calledPath    
  );

extern PIE_API int PIE_get_transfermode(
  void         *userPath,     
  tag_t        *transMode     
  );

extern PIE_API int PIE_get_session(
  void         *userPath,     
  tag_t        *session       
  );

extern PIE_API int PIE_get_relation_type(
  void         *userPath,     
  char        **relType       
  );

extern PIE_API int PIE_get_relation_name(
  void         *userPath,     
  char        **relName       
  );
extern PIE_API int PIE_create_working_dir(
    char        **dirName       
  );

extern PIE_API int PIE_ensure_file_readable(
    char        *path       
  );

extern PIE_API int PIE_send_socket_message(
    const char *message,    
    char *host_n_port,      
    int *response           
  );

extern PIE_API int PIE_get_application_reference_label(
    tag_t                object,          
    char**               label,           
    char**               version          
    );

#ifdef __cplusplus
}
#endif

#include <pie/libpie_undef.h>

#endif