tctype.h

Go to the documentation of this file.

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

/*  */

#ifndef TCTYPE_H
#define TCTYPE_H

#include <property/prop.h>
#include <tccore/tctype_msg.h>
#include <user_exits/user_exits.h>
#include <tccore/libtccore_exports.h>

#define TC_set_id_msg                 "IMAN_set_id"
#define TC_set_name_msg               "IMAN_set_name"
#define TC_set_description_msg        "IMAN_set_description"
#define TC_set_type_msg               "IMAN_set_type"
#define TC_set_type_directly_msg      "IMAN_set_type_directly"

#define TCTYPE_name_size_c            32
#define TCTYPE_class_name_size_c      27

#define TCTYPE_DISABLE_UPDATE_LIST    0
#define TCTYPE_ENABLE_UPDATE_LIST     1
#define TCTYPE_SUSPEND_UPDATE_LIST    2
#define TCTYPE_RESUME_UPDATE_LIST     3

#define TCTYPE_UPDATE_ALL_PROPS       "_update_all_"

typedef enum TCTYPE_display_e {
    TCTYPE_DISPLAYABLE=0,          
    TCTYPE_HIDDEN_AT_SYSTEM_LEVEL, 
    TCTYPE_HIDDEN_AT_SITE_LEVEL,   
    TCTYPE_HIDDEN_AT_PARENT_LEVEL, 
    TCTYPE_HIDDEN_AT_CURRENT_LEVEL 
} TCTYPE_display_t;

typedef enum TCTYPE_category_e {
    TCTYPE_Persistent,               
    TCTYPE_Runtime,                  
    TCTYPE_OperationInput,           
    TCTYPE_Root,                     
    TCTYPE_Dynamic,                  
    TCTYPE_All                       
} TCTYPE_category_t;


typedef struct TCTYPE_availablerel_s
{
    char* actualName;  
    char* displayName; 
}  TCTYPE_availablerel_t;

typedef  struct  TCTYPE_deepcopydata_s
{
    int                         n_deepcopydata_attached_objects;    
    tag_t*                      deepcopydata_attached_objects;      
}       TCTYPE_deepcopydata_t;

typedef  struct  TCTYPE_bulk_copy_input_s
{
    tag_t                       source_object;                      
    tag_t                       operation_descriptor;               
    TCTYPE_deepcopydata_t*      attached_deepcopydata;              
}       TCTYPE_bulk_copy_input_t;

typedef enum TCTYPE_compounding_ctxt_e
{
    TCTYPE_compounding_ctxt_unknown,  
    TCTYPE_compounding_ctxt_relation, 
    TCTYPE_compounding_ctxt_secondary 
} TCTYPE_compounding_ctxt_t;

typedef enum TCTYPE_operation_input_e
{
    TCTYPE_OPERATIONINPUT_CREATE = 0, 
    TCTYPE_OPERATIONINPUT_REVISE = 1, 
    TCTYPE_OPERATIONINPUT_SAVEAS = 2, 
    TCTYPE_OPERATIONINPUT_ANY    = 3  
} TCTYPE_operation_input_t;

typedef enum TCTYPE_save_operation_context_e
{
    TCTYPE_save_on_create,            
    TCTYPE_save_on_saveas,            
    TCTYPE_save_on_revise,            
    TCTYPE_save_on_update,            
    TCTYPE_unknown_operation_context, 
    TCTYPE_save_on_clone              
}   TCTYPE_save_operation_context_t;

#ifdef __cplusplus
extern "C"{
#endif

extern TCCORE_API int TCTYPE_init_module();

extern TCCORE_API int TCTYPE_exit_module();

extern TCCORE_API int TCTYPE_refresh(
    tag_t               type,           
    logical             lock_or_not     
    );

extern TCCORE_API int TCTYPE_ask_name(
    tag_t               type,                             
    char                type_name[TCTYPE_name_size_c+1]   
    );

extern TCCORE_API int TCTYPE_ask_name2(
    tag_t               type,                             
    char                **type_name                       
    );

extern TCCORE_API int TCTYPE_ask_type(
    const char*               type_name,               
    tag_t*                    type                     
    );


extern TCCORE_API int TCTYPE_ask_display_name(
    tag_t               type,                             
    char**              display_type_name                 
    );

extern TCCORE_API int TCTYPE_ask_class_name(
    tag_t               type,                                     
    char                type_class[TCTYPE_class_name_size_c+1]    
    );

extern TCCORE_API int TCTYPE_ask_class_name2(
    tag_t               type,                                     
    char                **type_class                              
    );

extern TCCORE_API int TCTYPE_ask_object_type(
    tag_t               object,    
    tag_t*              type       
    );

extern TCCORE_API int TCTYPE_ask_object_types(
    int                 number_of_objects,      
    const tag_t*        objects,                
    tag_t**             types                   
    );

extern TCCORE_API int TCTYPE_ask_object_type_with_stubs(
    tag_t               object,     
    tag_t*              type        
    );


extern TCCORE_API int TCTYPE_find_type(
    const char*         type_name,      
    const char*         class_name,     
    tag_t*              type            
    );

extern TCCORE_API int TCTYPE_find_types_for_class(
    const char*         class_name,         
    int*                number_of_types,    
    tag_t**             types               
    );

extern TCCORE_API int TCTYPE_find_displayable_types_for_class(
    const char*         class_name,             
    logical             include_subclasses,     
    int*                number_of_types,        
    tag_t**             types                   
    );

extern TCCORE_API int TCTYPE_UIF_find_displayable_types_for_class(
    const char*         class_name,             
    logical             include_subclasses,     
    int*                number_of_types,        
    tag_t**             types,                  
    char***             type_names,             
    char***             display_type_names      
    );

extern TCCORE_API int TCTYPE_find_displayable_types_for_class_and_accessor(
    const char*         class_name,             
    tag_t               accessor_tag,           
    logical             include_subclasses,     
    int*                number_of_types,        
    tag_t**             types                   
    );

extern TCCORE_API int TCTYPE_find_hidden_types_for_class_and_accessor(
    const char*          class_name,            
    tag_t                accessor_tag,          
    logical              include_subclasses,    
    int*                 number_of_types,       
    tag_t**              types,                 
    TCTYPE_display_t**   details                
    );

extern TCCORE_API int TCTYPE_find_alltypes_for_class(
    const char*         class_name,         
    int*                number_of_types,    
    tag_t**             types               
    );

extern TCCORE_API logical TCTYPE_is_extent_already_called();

extern TCCORE_API int TCTYPE_extent(
    int*                number_of_types,    
    tag_t**             types               
    );


extern TCCORE_API int TCTYPE_list_properties(
    tag_t               type,                  
    int*                n_properties,          
    tag_t**             property_descriptors   
    );

extern TCCORE_API int TCTYPE_ask_property_by_name(
    tag_t               type,                     
    const char*         property_name,            
    tag_t*              property_descriptor       
    );

extern TCCORE_API int TCTYPE_property_exists(
    tag_t               type,           
    const char*         property_name,  
    logical*            verdict         
    );

extern TCCORE_API int TCTYPE_ask_property_by_display_name(
    tag_t               type,                     
    const char*         display_name,             
    tag_t*              property_descriptor       
    );


extern TCCORE_API int TCTYPE_add_runtime_array_property(
    tag_t               type,                 
    const char*         property_name,        
    PROP_value_type_t   value_type,          
    int                 max_string_length,   
    int                 max_number_elements, 
    tag_t*              property_descriptor  
    );

extern TCCORE_API int TCTYPE_add_relation_property(
    tag_t               type,                
    const char*         property_name,       
    tag_t               relation_type,       
    tag_t*              property_descriptor  
    );

extern TCCORE_API int TCTYPE_list_primary_rtypes(
    tag_t               primary_type,           
    int*                number_relation_types,  
    tag_t**             relation_types          
    );

extern TCCORE_API int  TCTYPE_register_properties(
    USER_prop_init_entry_t* user_types_methods,     
    int                     array_size              
    );

extern TCCORE_API int TCTYPE_list_displayable_properties(
    tag_t               type,                  
    int*                number_of_properties,  
    tag_t**             property_descriptors   
    );

extern TCCORE_API int TCTYPE_ask_available_relations(
    tag_t                     type,                   
    int*                      number_of_relations,    
    TCTYPE_availablerel_t**   available_relations     
    );


extern TCCORE_API int TCTYPE_ask_available_relation_names(
    tag_t                     type,                   
    int*                      number_of_relations,    
    char***                   relation_display_names, 
    char***                   relation_actual_names   
    );

extern TCCORE_API int TCTYPE_ask_parent_type(
    tag_t type,             
    tag_t *parent_type      
    );

extern TCCORE_API int TCTYPE_is_type_of (
    tag_t     type,         
    tag_t     parent_type,  
    logical * answer        
    );

extern TCCORE_API int TCTYPE_is_type_of_as_str(
    tag_t                    type,                   
    const char*              parent_type_name,       
    logical*                 answer                  
    );

extern TCCORE_API int TCTYPE_ask_subtypes(
    tag_t    type,                   
    logical  for_same_class_only,    
    int *    n_subtypes,             
    tag_t ** subtypes                
    );

extern TCCORE_API int TCTYPE_ask_subtypes_with_exclusions(
    tag_t             type,                       
    logical           for_same_class_only,        
    int               number_exclusion_bo_names,  
    const char**      exclusion_bo_names,         
    int *             number_of_subtypes,         
    tag_t **          subtypes                    
    );

extern TCCORE_API int TCTYPE_ask_child_types(
    tag_t    type,                  
    logical  for_same_class_only,   
    int *    number_of_child_types, 
    tag_t ** child_types            
    );

extern TCCORE_API int TCTYPE_ask_child_primary_types (
    tag_t    type,                  
    int *    number_of_child_types, 
    tag_t ** child_types            
    );

extern TCCORE_API int TCTYPE_load_all_delayed_types() ;

extern TCCORE_API int TCTYPE_ask_create_descriptor(
    tag_t type_tag,             
    tag_t* creation_descriptor  
);


extern TCCORE_API int TCTYPE_ask_saveas_descriptor(
    tag_t type_tag,             
    tag_t* save_as_descriptor   
 );

extern TCCORE_API int TCTYPE_ask_target_deepcopydata(
    tag_t   object_tag,               
    int  *  number_attached_objects,  
    tag_t** deep_copy_data_tags       
);


extern TCCORE_API int TCTYPE_construct_bulk_copy_inputs(
    const int                           n_source_objects,       
    const tag_t*                        source_objects,         
    const TCTYPE_operation_input_t      operation_type,         
    TCTYPE_bulk_copy_input_t**          bulk_copy_inputs        
);


extern TCCORE_API int TCTYPE_delete_operation_input_objects(
    const int                           n_bulk_copy_inputs,                     
    const TCTYPE_bulk_copy_input_t*     bulk_copy_inputs                        
);


extern TCCORE_API int TCTYPE_bulk_saveas_objects(
    const int                           n_bulk_copy_inputs,                     
    const TCTYPE_bulk_copy_input_t*     bulk_copy_inputs,                       
    tag_t**                             copied_objects                          
);


extern TCCORE_API int TCTYPE_bulk_revise_objects(
    const int                           n_bulk_copy_inputs,                     
    const TCTYPE_bulk_copy_input_t*     bulk_copy_inputs,                       
    tag_t**                             revised_objects                         
);

extern TCCORE_API int TCTYPE_bulk_create_objects(
    const int        n_objects,             
    const tag_t*     create_inputs,         
    tag_t**          objects                
);

extern TCCORE_API int TCTYPE_ask_create_prop_descriptors(
    tag_t     create_descriptor_tag,               
    int*      number_property_descriptors,         
    tag_t**   property_descriptor_tags,            
    int*      number_secondary_prop_names,         
    char***   secondary_prop_names,                
    tag_t**   secondary_bo_type_tags,              
    logical** is_required,                         
    logical** is_array,                            
    int**     compounding_ctxts,                   
    tag_t**   secondary_create_descriptor_tags     
);


extern TCCORE_API int TCTYPE_ask_saveas_prop_descriptors(
    tag_t   saveas_descriptor_tag,           
    int*    number_prop_descriptor_tags,     
    tag_t** prop_decriptor_tags              
);


extern TCCORE_API int TCTYPE_construct_create_input(
    tag_t  type,            
    tag_t* create_input     
);

extern TCCORE_API int TCTYPE_construct_saveasinput(
    tag_t  type,            
    tag_t* save_as_input    
);

extern TCCORE_API int TCTYPE_construct_operationinput(
    tag_t                    target_object_type,   
    TCTYPE_operation_input_t operation_input,      
    tag_t*                   target_save_as_input  
);

extern TCCORE_API int TCTYPE_free_deepcopydata(
    int    number_deep_copy_data,   
    tag_t* deep_copy_data          
);

extern TCCORE_API int TCTYPE_saveas_object(
    tag_t  target_object,               
    tag_t  save_as_input,               
    int    number_of_attached_objects,  
    tag_t* deep_copy_data,              
    tag_t* target_copy                  
);

extern TCCORE_API int TCTYPE_ask_revise_descriptor(
    tag_t  object_type,        
    tag_t* revise_descriptor   
);

extern TCCORE_API int TCTYPE_ask_deepcopydata(
    tag_t                    object,                     
    TCTYPE_operation_input_t operation_input,            
    int *                    number_of_attached_objects, 
    tag_t**                  deep_copy_data              
);

extern TCCORE_API int TCTYPE_revise_objects(
    int     number_target_objects,  
    tag_t*  target_object,          
    tag_t*  revise_input,           
    int*    number_attached_objs,   
    tag_t*  deep_copy_data,         
    tag_t** target_copy,            
    int**   ifails                  
);

extern TCCORE_API int TCTYPE_create_object(
    tag_t create_input,  
    tag_t* bo            
);

extern TCCORE_API int TCTYPE_create_objects(
    int n_bulks,            
    int* quantities,        
    tag_t* create_inputs,   
    int* n_objects,         
    tag_t** objects         
);

extern TCCORE_API int TCTYPE_create_single_objects(
    int n_bulks,            
    const tag_t* create_inputs,   
    int* n_objects,         
    tag_t** objects         
);

extern TCCORE_API int TCTYPE_set_create_display_value(
    tag_t  create_input,                
    char*  property_name,               
    int    number_of_display_values,    
    const  char** display_values        
);

extern TCCORE_API int TCTYPE_set_OperationInput_DisplayValue(
    tag_t  operation_input,            
    char*  property_name,              
    const  char** display_values       
);

extern TCCORE_API int TCTYPE_get_OperationInput_DisplayValues(
    tag_t     operation_input,           
    char*     property_name,             
    int*      number_of_display_values,  
    char***   display_values,            
    logical** is_null                    
);

extern TCCORE_API int TCTYPE_find_displayable_business_objects(
    const char*   bo_name,                   
    int           number_exclusion_bo_names, 
    const char**  exclusion_bo_names,        
    int*          number_displayable_types,  
    tag_t**       displayable_types          
);

extern TCCORE_API int TCTYPE_UIF_find_displayable_business_objects(
    const char*    bo_name,                   
    int            number_exclusion_bo_names, 
    const char**   exclusion_bo_names,        
    int*           number_displayable_types,  
    tag_t**        displayable_types,         
    char***        type_names,                
    char***        display_type_names         
);

extern TCCORE_API int TCTYPE_UIF_find_generically_creatable_business_objects(
    const char*   bo_name,                    
    int           number_exclusion_bo_names,  
    const char**  exclusion_bo_names,         
    int*          number_displayable_types,   
    tag_t**       displayable_types,          
    char***       type_names,                 
    char***       display_type_names          
);

extern TCCORE_API int TCTYPE_ask_name_rule_patterns(
    const char*   bo_name,                 
    int*          number_property_names,   
    char***       property_names,          
    int**         pattern_count,           
    int*          number_of_patterns,      
    char***       patterns                 
);

extern TCCORE_API int TCTYPE_ask_save_operation_context(
    TCTYPE_save_operation_context_t*    save_operation_context 
);


extern TCCORE_API int TCTYPE_extent_by_category(
    TCTYPE_category_t       type_category,          
    int*                    number_of_types,        
    tag_t**                 types                   
);


    extern TCCORE_API int TCTYPE_add_to_changed_tag_list(
        tag_t object,           
        const char* properties  
        );

    extern TCCORE_API int TCTYPE_add_to_deleted_tag_list(
        tag_t object           
        );


    extern TCCORE_API int TCTYPE_get_modified_tag_list(
        logical clear_lists,         
        int*    num_objects,         
        tag_t** tags,                
        int**   deleted_or_modified, 
        char*** properties           
        );

    extern TCCORE_API int TCTYPE_remove_from_modified_tag_list(
        tag_t object           
        );

    extern TCCORE_API int TCTYPE_ask_type_descriptions(
        const unsigned int n_types,         
        const tag_t* types,                 
        char*** type_descriptions           
        );

    extern TCCORE_API int TCTYPE_ask_is_abstract( 
        tag_t type,                 
        logical* isAbstract         
        );

#ifdef __cplusplus
}
#endif

#include <tccore/libtccore_undef.h>

#endif