aom.h

Go to the documentation of this file.

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

#ifndef AOM_H
#define AOM_H

#include <tc/tc_startup.h>

#include <tccore/workspaceobject.h>

#include <tccore/libtccore_exports.h>

#define AOM_archive_size_c     127
#define AOM_ixr_transactionid_size_c 1023

#define AOM_max_VLA_size 3952

typedef struct AOM_export_info_entry_s
{
    tag_t      site;
    char       exporting_user[WSO_name_size_c+1];
    char       export_reason[WSO_desc_size_c+1];
    char       transaction_id[AOM_ixr_transactionid_size_c+1];
    date_t     last_export_date;
} AOM_export_info_entry_t;

typedef struct AOM_publication_info_entry_s
{
    tag_t      site;
    char       publishing_user[WSO_name_size_c+1];
    date_t     last_publication_date;
} AOM_publication_info_entry_t;

typedef enum AOM_sync_state_e
{
    AOM_SYNC_STATE_UP_TO_DATE                  = 1,
    AOM_SYNC_STATE_OUT_OF_DATE                 = 2,
    AOM_SYNC_STATE_REPLICA_HAS_LATER_DATE      = 3,
    AOM_SYNC_STATE_UNKNOWN                     = 4,
    AOM_SYNC_STATE_NOT_REPLICATED              = 5,
    AOM_SYNC_STATE_MASTER_DOES_NOT_EXIST       = 6,
    AOM_SYNC_STATE_UP_TO_DATE_PER_HUB          = 7,
    AOM_SYNC_STATE_UNKNOWN_OWNING_SITE         = 8,
    AOM_SYNC_STATE_REPLICA_HAS_BEEN_SUPERSEDED = 9,
    AOM_SYNC_STATE_NOT_A_REPLICA               = 10
} AOM_sync_state_t;

typedef enum AOM_sync_type_e
{
    OBJECT_SYNC         = 1,
    COMPONENT_SYNC      = 2,
    ASSEMBLY_SYNC       = 3
} AOM_sync_type_t;

#ifdef __cplusplus
    extern "C"{
#endif

extern TCCORE_API int AOM_init_module();

extern TCCORE_API int AOM_exit_module();

extern TCCORE_API int AOM_load(
    tag_t               obj     
    );

extern TCCORE_API int AOM_load_instances(
    int                 n,              
    tag_t*              objs,           
    int*                n_loaded,       
    tag_t**             objs_loaded     
    );

extern TCCORE_API int AOM_refresh(
    tag_t               obj,        
    int                 lockFlag    
    );

extern TCCORE_API int AOM_save(
    tag_t               obj     
    );

extern TCCORE_API int AOM_save_with_extensions(
    tag_t               obj     
    );

extern TCCORE_API int AOM_unload(
    tag_t               obj     
    );

extern TCCORE_API int AOM_delete(
    tag_t               obj     
    );

extern TCCORE_API int AOM_delete_from_parent(
    tag_t               obj,        
    tag_t               parent      
    );

extern TCCORE_API int AOM_describe_class
  ( tag_t             class_id,          
    int               n_names,           
    char **           attr_names,        
    char **           application_name,  
    int *             descriptor,        
    int *             n_attrs,           
    tag_t **          attr_ids           
  );


extern TCCORE_API int AOM_register_localized_attribute
    ( tag_t         class_id,           
      tag_t         source_att,         
      tag_t         target_att          
    );


#ifdef __cplusplus
}
#endif

#define AOM_unlock(t)           (AOM_refresh(t,FALSE))

#ifdef __cplusplus
    extern "C"{
#endif

extern TCCORE_API int AOM_lock(
    tag_t               obj     
    );

extern TCCORE_API int AOM_lock_for_delete(
    tag_t               obj     
    );

extern TCCORE_API int AOM_freeze(
    tag_t               obj     
    );

extern TCCORE_API int AOM_unfreeze(
    tag_t               obj     
    );

extern TCCORE_API int AOM_ask_if_frozen(
    tag_t               obj,        
    logical*            frozen      
    );

extern TCCORE_API int AOM_set_ownership(
    tag_t               obj,    
    tag_t               user,   
    tag_t               group   
    );

extern TCCORE_API int AOM_ask_owner(
    tag_t               obj,            
    tag_t*              owning_user     
    );

extern TCCORE_API int AOM_ask_group(
    tag_t               obj,            
    tag_t*              owning_group    
    );

extern TCCORE_API int AOM_ask_last_modifier(
    tag_t               obj,        
    tag_t*              a_user      
    );

extern TCCORE_API int AOM_ask_creation_date(
    tag_t               obj,            
    date_t*             creation_date   
    );

extern TCCORE_API int AOM_ask_modified_date(
    tag_t               obj,            
    date_t*             modified_date   
    );

extern TCCORE_API int AOM_ask_backup_date(
    tag_t               obj,            
    date_t*             backup_date     
    );

extern TCCORE_API int AOM_ask_archive_info(
    tag_t               obj,                                    
    char                archive_info[AOM_archive_size_c + 1]    
    );

extern TCCORE_API int AOM_ask_archive_info2(
    tag_t               obj,                                    
    char                **archive_info                          
    );

extern TCCORE_API int AOM_ask_archive_date (
    tag_t               object_tag,                         
    char                date_string [WSO_date_size_c + 1]   
    );

extern TCCORE_API int AOM_ask_archive_date2 (
    tag_t               object_tag,                         
    char                **date_string                       
    );

extern TCCORE_API int AOM_is_archived (
    tag_t               object_tag,     
    logical*            answer          
    );

extern TCCORE_API int AOM_get_export_info(
    tag_t                       object_tag,     
    int*                        n_export_info,  
    AOM_export_info_entry_t**   export_info     
    );

extern TCCORE_API int AOM_get_publication_info(
    tag_t                           object_tag,             
    int*                            n_publication_info,     
    AOM_publication_info_entry_t**  publication_info        
    );

extern TCCORE_API int AOM_ask_if_modifiable(
    tag_t               object_tag,     
    logical*            verdict         
    );

extern TCCORE_API int AOM_ask_name(
    tag_t               obj,    
    char**              name    
    );

extern TCCORE_API int AOM_is_type_of(
    tag_t     object_tag,          
    tag_t     type_tag,            
    logical * answer               
    );

extern TCCORE_API int AOM_check_sync_state(
    int                 n_replicas,     
    tag_t*              replica_tags,   
    int**               owning_site_ids,
    AOM_sync_state_t**  sync_state,     
    date_t**            master_lmd,     
    date_t**            replica_lmd,    
    int**               error_codes     
    );

extern TCCORE_API int AOM_ask_import_record(
    tag_t   object_tag,             
    tag_t *import_record            
    );

extern TCCORE_API int AOM_ask_import_record_associated_object(
    tag_t import_record,            
    tag_t *obj_tag                  
    );
extern TCCORE_API int AOM_set_query_rewrite_mode
(
    logical mode  
);

extern TCCORE_API int AOM_ask_query_rewrite_mode
(
    logical *mode  
);

extern TCCORE_API int AOM_set_query_locale_neutral
(
    logical mode 
);

extern TCCORE_API int AOM_ask_query_locale_neutral
(
        logical *mode 
);

extern TCCORE_API int AOM_bulk_save_instances(
    int n_instances,       
    const tag_t *instances 
    );

extern TCCORE_API int AOM_apply_digital_signature(
    tag_t               object_tag,            
    const char *        encrypt_string         
);

extern TCCORE_API int AOM_verify_digital_signatures(
    int              n_target_objects,           
    const tag_t*     target_Objects,             
    int**            num_valid_ds,               
    int**            num_void_ds,                
    int**            num_total_ds,               
    int**            digital_signature_states    
    );

extern TCCORE_API int AOM_void_digital_signature(
    tag_t              targetObjTag,           
    const char*        voidOperationComments,  
    int                n_digital_signature,    
    const tag_t*       digital_signatures      
);

extern TCCORE_API int AOM_refresh_objects_in_bulk (
    int            n_object_tags,                  
    tag_t          *object_tags,                   
    logical        lock_flag,                      
    int            **refresh_status                
);

extern TCCORE_API int AOM_delete_with_extensions(
    tag_t               object     
    );

#ifdef __cplusplus
}
#endif

#include <tccore/libtccore_undef.h>

#endif