res_itk.h

Go to the documentation of this file.

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

/*  */

#define RES_RESERVE                 0
#define RES_UNRESERVE               1

#define RES_RESERVE_AND_EXPORT      3

#define   RES_Type                  "ImanReservation"

#define   RES_checkout_msg          "RES_checkout"
#define   RES_checkin_msg           "RES_checkin"
#define   RES_cancel_checkout_msg   "RES_cancel_checkout"
#define   RES_transfer_checkout_msg "RES_transfer_checkout"
#define   RES_notification_msg      "RES_notification"

#define RES_EXPORT_FILE                         1

#define RES_EXCLUSIVE_RESERVE                   2

#define RES_EXCLUSIVE_LOCAL_RESERVE 3

#define RES_SHORT_TERM_RESERVE      5

#ifndef RES_ITK_H_INCLUDED
#define RES_ITK_H_INCLUDED

#include <tc/tc_startup.h>
#include <ss/ss_const.h>
#include <tccore/workspaceobject.h>
#include <res/libres_exports.h>

#ifdef __cplusplus
    extern "C"{
#endif

extern RES_API int RES_ask_reserved_object (
    tag_t          reservation_tag,         
    int*           tag_count,               
    tag_t**        reserved_object_tags     
    );

extern RES_API int RES_ask_reason (
    tag_t          reservation_tag,             
    char           reason[WSO_desc_size_c + 1]  
    );


extern RES_API int RES_ask_reason2 (
    tag_t          reservation_tag,             
    char           **reason                     
    );

extern RES_API int RES_ask_export_on_checkout (
    tag_t          reservation_tag,     
    logical*       export_flag          
    );

extern RES_API int RES_ask_exp_directory (
    tag_t          reservation_tag,             
    char           directory[SS_MAXPATHLEN + 1] 
    );


extern RES_API int RES_ask_exp_directory2 (
    tag_t          reservation_tag,             
    char           **directory                  
    );

extern RES_API int RES_ask_reservation_type (
    tag_t          reservation_tag,     
    int*           reservation_type     
    );

extern RES_API int RES_ask_reservation_state (
    tag_t          reservation_tag,     
    int*           reservation_state    
    );

extern RES_API int RES_extent_reservation (
    int*           tag_count,           
    tag_t**        reservation_tags     
    );

extern RES_API int RES_find_reservations_by_user (
    tag_t          user_tag,            
    int*           tag_count,           
    tag_t**        reservation_tags     
    );

extern RES_API int RES_find_reservations_by_group (
    tag_t          group_tag,           
    int*           tag_count,           
    tag_t**        reservation_tags     
    );

extern RES_API int RES_who_checked_object_out (
    tag_t          object_tag,      
    tag_t*         user_tag,        
    tag_t*         group_tag        
    );

extern RES_API int RES_checkout (
    tag_t          object_tag,                      
    const char     reason[WSO_desc_size_c + 1],     
    const char     change_id[WSO_name_size_c + 1],  
    const char     dir_name[SS_MAXPATHLEN + 1],     
    int            reservation_type                 
    );


extern RES_API int RES_checkout2 (
    tag_t          object_tag,                      
    const char     *reason,                         
    const char     *change_id,                      
    const char     *dir_name,                       
    int            reservation_type                 
    );

extern RES_API int RES_checkin (
    tag_t          obj_tag      
    );

extern RES_API int RES_cancel_checkout (
    tag_t          object_tag,      
    logical        copy_flag        
    );

extern RES_API int RES_transfer_checkout (
    tag_t          object_tag,  
    tag_t          user_tag,    
    tag_t          group_tag    
    );

extern RES_API int RES_list_checkout (
    tag_t          user_tag,    
    int*           tag_count,   
    tag_t**        object_tags  
    );

extern RES_API int RES_is_checked_out (
    tag_t          object_tag,      
    logical*       is_reserved      
    );

extern RES_API int RES_assert_object_modifiable (
    tag_t          object_tag       
    );

extern RES_API int RES_ask_notifylist (
    tag_t          reservation_tag,     
    int*           no_users,            
    tag_t**        notifylist           
    );

extern RES_API int RES_add_to_notifylist (
    tag_t          reservation_tag,     
    tag_t          user_tag             
    );

extern RES_API int RES_remove_from_notifylist (
    tag_t          reservation_tag,     
    tag_t          user_tag             
    );

extern RES_API int RES_ask_user (
    tag_t          reservation_tag,     
    tag_t*         user_tag             
    );

extern RES_API int RES_ask_group (
    tag_t          reservation_tag,     
    tag_t*         group_tag            
    );

extern RES_API int RES_ask_reservation_date (
    tag_t          reservation_tag,     
    date_t*        date                 
    );

extern RES_API int RES_ask_change_id (
    tag_t          reservation_tag,                 
    char           change_id[WSO_name_size_c + 1]   
    );


extern RES_API int RES_ask_change_id2 (
    tag_t          reservation_tag,                 
    char           **change_id                      
    );

extern RES_API int RES_ask_reservation_object (
    tag_t          object_tag,          
    tag_t*         reservation_tag      
    );

extern RES_API int RES_ask_audit_file(
    tag_t          object_tag,  
    tag_t*         file_tag     
    );

extern RES_API int RES_ask_audit_history(
    tag_t       object_tag, 
    int*        event_count,
    char***     dates,      
    char***     users,      
    char***     actions,    
    char***     change_ids, 
    char***     reasons     
    );

extern RES_API int RES_save_reservation (
    tag_t          reservation_tag,     
    logical        whether_to_unload    
    );

extern RES_API int RES_init_module ();

extern RES_API int RES_list_remote_checkout( 
    tag_t          remote_site,     
    const char*    remote_user,     
    const char*    remote_group,    
    int*           tag_count,       
    tag_t**        object_tags      
    );

extern RES_API int RES_list_replica_checkout( 
    tag_t          remote_site,         
    tag_t          local_user_tag,      
    tag_t          local_group_tag,     
    int*           tag_count,           
    tag_t**        object_tags          
    );

extern RES_API int RES_is_checked_out_by_remote_user( 
    tag_t          object_tag,      
    logical*       is_reserved      
    );

extern RES_API int RES_is_checked_out_replica( 
    tag_t          object_tag,      
    logical*       is_reserved      
    );

extern RES_API int RES_ask_remote_user_and_group( 
    tag_t          reservation_tag,     
    char**         remote_user,         
    char**         remote_group         
    ); 

extern RES_API int RES_ask_remote_site( 
    tag_t          reservation_tag,     
    tag_t*         remote_site          
    );

extern RES_API int RES_is_checkoutable(
    tag_t          object_tag,      
    logical*       is_checkoutable  
    );
#ifdef __cplusplus
}
#endif

#include <res/libres_undef.h>

#endif