idfr.h

Go to the documentation of this file.

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

/*  */

#ifndef IDFR_H
#define IDFR_H

#include <tc/tc_startup.h>
#include <common/emh_const.h>
#include <tccore/idfr_errors.h>
#include <user_exits/user_exits.h>
#include <tccore/libtccore_exports.h>

#define IDENTIFIER_class_name_c          "Identifier"
#define IDENTIFIER_rev_type_name_c       "IdentifierRev"
#define IDENTIFIER_id                    "idfr_id"
#define IDENTIFIER_idcontext             "idcontext"
#define IDENTIFIER_altidof               "altid_of"
#define IDENTIFIER_dispdefault           "disp_default"
#define IDENTIFIER_supplcontext          "suppl_context"
#define ALIASID_relation                 "IMAN_aliasid"

#define IDENTIFIER_create_alternate_msg  "IDENTIFIER_create_alternate"
#define IDENTIFIER_revise_alternate_msg  "IDENTIFIER_revise_alternate"
#define IDENTIFIER_saveas_alternate_msg  "IDENTIFIER_saveas_alternate"
#define IDENTIFIER_create_alias_msg      "IDENTIFIER_create_alias"

#ifdef __cplusplus
extern "C"{
#endif

extern TCCORE_API int IDFR_create_aliasid (
    const char*         identifier_type,    
    tag_t*              new_identifier_tag  
    );

extern TCCORE_API int IDFR_create_altid (
    const char*         identifier_type,    
    tag_t               idfbl_tag,          
    tag_t               idfbl_rev_tag,      
    tag_t               idcontext_tag,      
    tag_t*              altid_tag,          
    tag_t*              altid_rev_tag       
    );

extern TCCORE_API int IDFR_revise_altid (
    tag_t               altid_or_rev_tag,   
    tag_t               idfbl_rev_tag,      
    tag_t*              new_altid_rev_tag   
    );

extern TCCORE_API int IDFR_saveas_altid (
    tag_t               altid_rev_tag,      
    tag_t               idfbl_rev_tag,      
    tag_t*              new_altid_rev_tag   
    );

extern TCCORE_API int IDFR_ask_aliasidof (
    tag_t               identifier_tag,     
    int*                num_identifiables,  
    tag_t**             identifiable_tags   
    );

extern TCCORE_API int IDFR_ask_altidof (
    tag_t               identifier_tag,     
    tag_t*              identifiable_tag    
    );

extern TCCORE_API int IDFR_ask_id (
    tag_t               identifier_tag,     
    char**              identifier_id       
    );

extern TCCORE_API int IDFR_ask_idcontext (
    tag_t               identifier_tag,     
    tag_t*              idcontext_tag       
    );

extern TCCORE_API int IDFR_ask_supplcontext (
    tag_t               identifier_tag,     
    tag_t*              supplcontext_tag    
    );

extern TCCORE_API int IDFR_set_altidof (
    tag_t               identifier_tag,     
    tag_t               identifiable_tag    
    );

extern TCCORE_API int IDFR_set_id (
    tag_t               identifier_tag,     
    const char*         identifier_id       
    );

extern TCCORE_API int IDFR_set_idcontext (
    tag_t               identifier_tag,     
    tag_t               idcontext_tag       
    );

extern TCCORE_API int IDFR_set_supplcontext (
    tag_t               identifier_tag,     
    tag_t               supplcontext_tag    
    );

extern TCCORE_API int IDFR_new_alt_id (
    tag_t               idcontext_tag,  
    const char*         idfr_type,      
    char**              new_id          
    );

extern TCCORE_API int IDFR_new_alt_ids (
    tag_t               idcontext_tag,  
    const char*         idfr_type,      
    char**              new_id,         
    char**              new_rev_id      
    );

extern TCCORE_API int IDFR_new_rev_id (
    tag_t               idfr_rev_tag,   
    char**              new_rev_id      
    );

extern TCCORE_API int IDFR_validate_alt_id (
    tag_t               idcontext_tag,  
    const char*         idfr_type,      
    const char*         new_id,         
    const char*         pattern_name,   
    char**              modified_id,    
    IDValid_e*          status          
    );

extern TCCORE_API int IDFR_validate_alt_ids (
    tag_t               idcontext_tag,      
    const char*         idfr_type,          
    const char*         new_id,             
    const char*         new_rev_id,         
    const char*         pattern_name,       
    char**              modified_id,        
    char**              modified_rev_id,    
    IDValid_e*          status              
    );

extern TCCORE_API int IDFR_validate_rev_id (
    tag_t               idfr_rev_tag,   
    const char*         new_rev_id,     
    const char*         pattern_name,   
    char**              modified_id,    
    IDValid_e*          status          
    );

extern TCCORE_API int IDFR_add_aliasidof (
    tag_t               identifier_tag,     
    int                 num_identifiables,  
    tag_t*              identifiable_tags   
    );

extern TCCORE_API int IDFR_remove_aliasidof (
    tag_t               identifier_tag,     
    int                 num_identifiables,  
    tag_t*              identifiable_tags   
    );

extern TCCORE_API int IDFR_find_identifiers (
    const char*         id,                 
    tag_t               idcontext_tag,      
    int*                num_identifiers,    
    tag_t**             identifier_tags     
    );

extern TCCORE_API int IDFR_list_suppl_identifiers(
    tag_t               master_idfr_tag,    
    int*                num_suppl,          
    tag_t**             suppl_idfr_tags     
    );

extern TCCORE_API int IDFR_find_suppl_identifiers(
    tag_t               master_idfr_tag,    
    const char*         suppl_id,           
    int*                num_suppl,          
    tag_t**             suppl_idfr_tags     
    );

extern TCCORE_API int IDFR_idfbl_ask_disp_default (
    tag_t               identifiable_tag,   
    tag_t*              altid_tag           
    );

extern TCCORE_API int IDFR_idfbl_set_disp_default (
    tag_t               identifiable_tag,   
    tag_t               altid_tag           
    );

extern TCCORE_API int IDFR_idfbl_ask_disp_altid (
    tag_t               identifiable_tag,   
    tag_t               iddisprule_tag,     
    tag_t*              altid_tag           
    );

extern TCCORE_API int IDFR_idfbl_list_altids (
    tag_t               identifiable_tag,   
    int*                num_altids,         
    tag_t**             altid_tags          
    );

extern TCCORE_API int IDFR_idfbl_list_aliasids (
    tag_t               identifiable_tag,   
    int*                num_aliases,        
    tag_t**             aliasid_tags        
    );

extern TCCORE_API int IDFR_idfbl_find_altids (
    tag_t               identifiable_tag,   
    const char*         id,                 
    tag_t               idcontext_tag,      
    int*                num_altids,         
    tag_t**             altid_tags          
    );

extern TCCORE_API int IDFR_idfbl_find_altidsof (
    const char*         id,                         
    tag_t               idcontext_tag,              
    tag_t               identifiable_class_tag,     
    int*                num_identifiables,          
    tag_t**             identifiable_tags           
    );

#ifdef __cplusplus
}
#endif

#include <tccore/libtccore_undef.h>

#endif