objio.h

Go to the documentation of this file.

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

/*  */

#ifndef OBJIO_H
#define OBJIO_H

#include <tccore/tctype.h>
#include <archive/objio_errors.h>
#include <pom/pom/pom.h>
#include <sa/sa.h>
#include <ss/ss_const.h>
#include <tccore/workspaceobject.h>
#include <epm/epm.h>
#include <objio/libobjio_exports.h>

#define OBJIO_export_type                       1
#define OBJIO_import_type                       2
#define OBJIO_archive_type                      3
#define OBJIO_restore_type                      4
#define OBJIO_backup_type                       5
#define OBJIO_recover_type                      6
#define OBJIO_remote_transfer_from_type         7
#define OBJIO_remote_transfer_to_type           8

#define OBJIO_dataset_all_versions              1
#define OBJIO_item_all_revisions                2
#define OBJIO_assume_ownership                  3
#define OBJIO_abort_if_checked_out              4
#define OBJIO_include_contents                  5
#define OBJIO_xfr_top_lvl_only                  6
#define OBJIO_xfr_xcl_ref_atth                  7
#define OBJIO_xfr_xcl_req_atth                  8
#define OBJIO_xfr_xcl_manif_atth                9
#define OBJIO_xfr_xcl_spec_atth                 10
#define OBJIO_xcl_ref_atth                      11
#define OBJIO_xcl_req_atth                      12
#define OBJIO_xcl_manif_atth                    13
#define OBJIO_xcl_spec_atth                     14
#define OBJIO_export_dataset_refs               15
#define OBJIO_export_BOM_components             16
#define OBJIO_include_modified_only             17
#define OBJIO_exclude_protected_wso             18
#define OBJIO_exclude_no_xfr_comp               19
#define OBJIO_exclude_protected_comp            20
#define OBJIO_selected_revs_only                21
#define OBJIO_latest_rev_only                   22
#define OBJIO_latest_working_rev_only           23
#define OBJIO_latest_released_rev_only          24
#define OBJIO_latest_working_any_only           25
#define OBJIO_is_synchronizing                  26
#define OBJIO_is_remote_operation               27
#define OBJIO_preview_mode                      28
#define OBJIO_completion_report                 29
#define OBJIO_continue_on_error                 30
#define OBJIO_force_import_export               31
#define OBJIO_specific_status_only              32
#define OBJIO_is_background_mode                33
#define OBJIO_same_as_last_export               34
#define OBJIO_synchronous_remote_transfer       35
#define OBJIO_is_retrieving_distributed_comp    36
#define OBJIO_all_released_revs_only            37
#define OBJIO_include_bomchanges                38
#define OBJIO_include_supercedures              39
#define OBJIO_export_for_remote_checkin         40
#define OBJIO_import_for_remote_checkin         41
#define OBJIO_exclude_variant_expressions       42
#define OBJIO_is_variant_background_mode        43
#define OBJIO_defer_bulk_data_xfer              44
#define OBJIO_include_pfmembers                 45
#define OBJIO_include_pftemplates               46
#define OBJIO_bom_pf_option                     47
#define OBJIO_error_report                      48
#define OBJIO_specific_rev_rule_only            49
#define OBJIO_synchronous_site_transfer         50
#define OBJIO_export_recovery_mode              51
#define OBJIO_is_remote_send                    52

#define OBJIO_all_roles                         53
#define OBJIO_all_subgroups                     54
#define OBJIO_all_groupmembers                  55
#define OBJIO_org_exp_flag                      56
#define OBJIO_org_exp_type                      57
#define OBJIO_org_migrate_mode                  58
#define OBJIO_transfer_shared_effectivity       59

#define OBJIO_batch_transfer_of_ve              60

#define OBJIO_all_roles_key                     "AllRoles"

#define OBJIO_all_subgroups_key                 "AllSubGroups"

#define OBJIO_all_groupmembers_key              "AllGroupMembers"

#define OBJIO_org_exp_flag_key                  "IsOrgImpExp"

#define OBJIO_org_exp_type_key                  "OrgExpType"

#define OBJIO_top_export_tag                    "TopExpObject"

#define OBJIO_top_migrate_tag                   "TopMigrateTag"

#define OBJIO_role_export_index                 "RoleExpIndex"

typedef enum {
    PERSON_EXP = 0,
    ROLE_EXP,
    GROUP_EXP,
    USER_EXP,
    ROLE_IN_HIERACHY
}
ORGExpType;


#define OBJIO_IS_REQUIRED                       0
#define OBJIO_IS_OPTIONAL                       1

typedef struct OBJIO_report_s
{
    char    tag_string[POM_MAX_NAME_LENGTH+1];
    char    object_id[WSO_name_size_c+1];
    char    object_string[(WSO_name_size_c+1)*2];
    char    object_class[POM_MAX_NAME_LENGTH+1];
    char    object_relation[TCTYPE_name_size_c+1];
    char    object_comment[WSO_desc_size_c+1];
    int     error_code;
    logical is_optional_object;
} OBJIO_report_t;

#define OBJIO_auto_sync                         1
#define OBJIO_batch_sync                        2
#define OBJIO_do_not_sync                       3
#define OBJIO_auto_sync_and_notify              101
#define OBJIO_batch_sync_but_notify             102
#define OBJIO_do_not_sync_but_notify            103
#define OBJIO_notify_and_sync_unchanged         104
#define OBJIO_no_notify_and_sync_unchanged      105

/* VAS on demand sync - Revision rule options */
#define OBJIO_rev_rule_not_defined_at_remote_site     1
#define OBJIO_rev_rule_different_at_remote_site       2
#define OBJIO_rev_rule_non_identical_with_same_name   3

#ifdef __cplusplus
extern "C"{
#endif

extern OBJIO_API int OBJIO_create(
    int              type,          
    char*            area_name,     
    tag_t*           manager_tag    
    );

extern OBJIO_API int OBJIO_set_target_sites(
    tag_t            manager_tag,   
    int              site_count,    
    tag_t*           site_list      
    );

extern OBJIO_API int OBJIO_set_owning_site(
    tag_t            manager_tag,   
    tag_t            site_tag       
    );

extern OBJIO_API int OBJIO_set_receiving_user(
    tag_t            manager_tag,                       
    const char       receiving_user[SA_user_size_c+1]   
    );


extern OBJIO_API int OBJIO_set_receiving_user2(
    tag_t            manager_tag,                       
    const char       *receiving_user                    
    );

extern OBJIO_API int OBJIO_set_receiving_group(
    tag_t            manager_tag,                               
    const char       receiving_user[SA_group_name_size_c+1]     
    );


extern OBJIO_API int OBJIO_set_receiving_group2(
    tag_t            manager_tag,                       
    const char       *receiving_user                    
    );

extern OBJIO_API int OBJIO_set_sending_user
    (   tag_t           manager_tag,                     
        const char      sending_user[SA_user_size_c+1]   
    );

extern OBJIO_API int OBJIO_set_sending_user2
    (   tag_t           manager_tag,                     
        const char      *sending_user                    
    );

extern OBJIO_API int OBJIO_set_sending_group
    (   tag_t           manager_tag,                     
        const char      sending_group[SS_MAXPATHLEN+1]   
    );

extern OBJIO_API int OBJIO_set_sending_group2
    (   tag_t           manager_tag,                     
        const char      *sending_group                   
    );

extern OBJIO_API int OBJIO_ask_receiving_user
    (   tag_t           manager_tag,                     
        char            receiving_user[SA_user_size_c+1] 
    );


extern OBJIO_API int OBJIO_ask_receiving_user2
    (   tag_t           manager_tag,                     
        char            **receiving_user                 
    );

extern OBJIO_API int OBJIO_ask_receiving_group
    (   tag_t           manager_tag,                     
        char            receiving_group[SS_MAXPATHLEN+1] 
    );

extern OBJIO_API int OBJIO_ask_receiving_group2
    (   tag_t           manager_tag,                     
        char            **receiving_group                
    );

extern OBJIO_API int OBJIO_ask_sending_user
    (   tag_t           manager_tag,                     
        char            sending_user[SA_user_size_c+1]   
    );


extern OBJIO_API int OBJIO_ask_sending_user2
    (   tag_t           manager_tag,                     
        char            **sending_user                   
    );

extern OBJIO_API int OBJIO_ask_sending_group
    (   tag_t           manager_tag,                     
        char            sending_group[SS_MAXPATHLEN+1]   
    );


extern OBJIO_API int OBJIO_ask_sending_group2
    (   tag_t           manager_tag,                     
        char            **sending_group                  
    );


extern OBJIO_API int OBJIO_set_attribute(
    tag_t            manager_tag,       
    int              attribute_flag,    
    int              value              
    );

extern OBJIO_API int OBJIO_set_site_based_attribute(
    tag_t            manager_tag,       
    tag_t            remote_site,       
    int              attribute_flag,    
    int              value              
    );

extern OBJIO_API int OBJIO_set_export_reason(
    tag_t            manager_tag,   
    const char*      export_reason  
    );


extern OBJIO_API int OBJIO_set_release_status(
    tag_t            manager_tag,                       
    const char       status_type[WSO_name_size_c + 1]   
    );


extern OBJIO_API int OBJIO_set_release_status2(
    tag_t            manager_tag,                       
    const char       *status_type                       
    );


extern OBJIO_API int OBJIO_set_revision_rule
    (   tag_t               manager_tag,                      
        const char          status_type[WSO_name_size_c + 1]  
    );


extern OBJIO_API int OBJIO_set_revision_rule2
    (   tag_t               manager_tag,                      
        const char          *status_type                      
    );


extern OBJIO_API int OBJIO_store_objects(
    tag_t            manager_tag,   
    int              n_objects,     
    tag_t*           objects        
    );

extern OBJIO_API int OBJIO_write(
    tag_t            manager_tag    
    );

extern OBJIO_API int OBJIO_read(
    tag_t            manager_tag    
    );

extern OBJIO_API int OBJIO_ask_contents(
    tag_t            manager_tag,   
    int*             n_objects,     
    tag_t**          objects        
    );

extern OBJIO_API int OBJIO_restore_objects(
    tag_t            manager_tag,   
    int              n_objects,     
    tag_t*           objects        
    );

extern OBJIO_API int OBJIO_ask_failures(
    tag_t            manager_tag,       
    int*             n_failures,        
    tag_t**          failing_objects,   
    int**            failures           
    );

extern OBJIO_API int OBJIO_exclude_objects(
    tag_t            manager_tag,   
    int              n_objects,     
    tag_t*           objects        
    );



extern OBJIO_API int OBJIO_include_objects
    (   tag_t               manager_tag,    
        int                 n_objects,      
        tag_t *             objects         
    );

extern OBJIO_API int OBJIO_free_memory(
    tag_t            manager_tag    
    );

extern OBJIO_API int OBJIO_delete(
    tag_t            manager_tag    
    );

extern OBJIO_API int OBJIO_record_being_imported(
    tag_t            manager_tag    
    );

extern OBJIO_API int OBJIO_exclude_relation_types(
    tag_t            manager_tag,       
    int              count,             
    tag_t*           relation_types     
    );

extern OBJIO_API int OBJIO_retrieve(
    tag_t            manager_tag,   
    tag_t            source_site    
    );

extern OBJIO_API int OBJIO_send(
    tag_t            manager_tag,       
    tag_t            destination_site   
    );

extern OBJIO_API int OBJIO_delete_staging_dir(
    const char*      directory  
    );

extern OBJIO_API int OBJIO__make_temp_staging_dir(
    char**           directory  
    );

extern OBJIO_API int OBJIO_remove_excluded_reltype(
    tag_t            manager_tag,   
    tag_t            relation_type  
    );

extern OBJIO_API int OBJIO_ask_report_info(
    tag_t            manager_tag,   
    int*             n_info,        
    OBJIO_report_t** info_list      
    );

extern OBJIO_API int OBJIO_ask_error_report_info
    (   tag_t             manager_tag,           
        int *             n_info,                
        OBJIO_report_t**  info_list              
    );

extern OBJIO_API int OBJIO_end_remote_transfer(
    tag_t            manager_tag,   
    int              error_code     
    );

extern OBJIO_API int OBJIO_abort_sst_export(
    tag_t            export_bier_tag  
    );

extern OBJIO_API int OBJIO_abort_sst_export_post_write(
    tag_t            main_object_tag  
    );

extern OBJIO_API int OBJIO_abort_sst_import(
    tag_t            obj_tag          
    );

extern OBJIO_API int OBJIO_ask_metafile(
    tag_t            manager_tag,   
    tag_t*           metafile_tag   
    );

extern OBJIO_API int OBJIO_set_sync_options(
    tag_t            owning_site,       
    int              options_token,     
    int              n_obj_tags,        
    const tag_t*     obj_tags,          
    int**            failure_codes      
    );

extern OBJIO_API int OBJIO_ask_distributed_assy_info(
    tag_t            manager_tag,           
    int*             n_dist_components,     
    tag_t**          dist_component_list,   
    int**            owning_site_list       
    );

extern OBJIO_API int OBJIO_ask_assembly_components_owned_by_exporting_site(
    tag_t            manager_tag,           
    int*             n_components,          
    tag_t**          component_list,        
    int**            owning_site_list       
    );

extern OBJIO_API int OBJIO_set_incremental_bvr_changes
    (   tag_t         manager_tag,              /* <I> */
        tag_t         bvr_tag,                  /* <I> */
        int           n_modified_or_added_occs, /* <I> */
        const tag_t*  modified_or_added_occs,   /* <I> n_modified_or_added_occs */
        int           n_deleted_occs,           /* <I> */
        const tag_t*  deleted_occs              /* <I> n_deleted_occs */
    );

extern OBJIO_API int OBJIO_set_script(
    tag_t            manager_tag,               
    const char       script[SS_MAXPATHLEN + 1]  
    );


extern OBJIO_API int OBJIO_set_script2(
    tag_t            manager_tag,               
    const char       *script                    
    );

extern OBJIO_API int OBJIO_get_report_file(
    char**           report_file_name   
    );

extern OBJIO_API int OBJIO_get_bg_report_file(
    char*            reportStr,         
    char**           report_file_name   
    );

extern OBJIO_API int OBJIO_release_and_replicate(
    EPM_action_message_t msg            
    );

extern OBJIO_API int OBJIO_find_import_record_by_tag(
    tag_t       object_tag,                 /* (I) Tag of tc object */
    tag_t*      gsidentity_tag              /* (O) Tag of gsid object */
    );

extern OBJIO_API int OBJIO_find_export_sites_by_tag(
    tag_t           object_tag,                  /* (I) Tag of tc object */
    int*            nSites,                      /* (O) number of expoted sites. */
    tag_t**         site_tags,                    /* (O) Tag of IXR object */
    char**          export_sites_as_string,       /* (O) append site name as string. Useful for run time property */
    logical*           isSiteStrNull                 /* (O) check if the export_site_string is null */
    );


extern OBJIO_API int OBJIO_delete_replica_objects(
      tag_t       replica_object,               
      int         n_objects,                    
      const tag_t*      dependents,             
      const char*       optionset,              
      logical     delete_unref_pomstubs,        
      logical     delete_export_records         
      );
      

#ifdef __cplusplus
}
#endif

#include <objio/libobjio_undef.h>

#endif