cr.h

Go to the documentation of this file.

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

/*  */

#ifndef CR_H
#define CR_H

#include <epm/cr_errors.h>
#include <tccore/workspaceobject.h>
#include <tccore/releasestatus.h>
#include <epm/libepm_exports.h>

//contents of this file are deprecated in tc10.1 with project 015735.  Should be removed in tc12.1.
#define CR_select_signoff_team_task     "select-signoff-team"
#define CR_perform_signoffs_task        "perform-signoffs"

typedef enum CR_signoff_decision_e {
             CR_no_decision         = 0,
             CR_approve_decision    = 'Y',
             CR_reject_decision     = 'N'
} CR_signoff_decision_t;

#define CR_comment_size_c               240

#ifdef __cplusplus
    extern "C"{
#endif

extern EPM_API int CR_init_module(void);

extern EPM_API int CR_exit_module(void);

extern EPM_API int CR_ask_job(
    tag_t          target_object,   
    int*           count,           
    tag_t**        jobs             
    );

extern EPM_API int CR_refresh_job(
    tag_t          job      
    );

extern EPM_API int CR_ask_required_reviewer_types(
    tag_t          job,                     
    const char*    release_level_name,      
    int*           count,                   
    tag_t**        required_accessors       
    );

extern EPM_API int CR_ask_unassigned_reviewer_types(
    tag_t          job,                     
    const char*    release_level_name,      
    int*           count,                   
    tag_t**        unassigned_accessors     
    );

extern EPM_API int CR_ask_reviewers(
    tag_t          job,                     
    const char*    release_level_name,      
    int*           count,                   
    tag_t**        groupmembers             
    );

extern EPM_API int CR_add_reviewers(
    tag_t          job,                     
    const char*    release_level_name,      
    int            n_groupmembers,          
    tag_t*         groupmembers             
    );

extern EPM_API int CR_remove_reviewers(
    tag_t          job,                 
    const char*    release_level_name,  
    int            n_groupmembers,      
    tag_t*         groupmembers         
    );

extern EPM_API int CR_ask_decision(
    tag_t                  job,                             
    const char*            release_level_name,              
    tag_t                  user,                            
    CR_signoff_decision_t* decision,                        
    char                   comments[CR_comment_size_c + 1], 
    date_t*                decision_date                    
    );

extern EPM_API int CR_ask_decision2(
    tag_t                  job,                             
    const char*            release_level_name,              
    tag_t                  user,                            
    CR_signoff_decision_t* decision,                        
    char                   **comments,                      
    date_t*                decision_date                    
    );

extern EPM_API int CR_ask_quorum(
    tag_t          job,                     
    const char*    release_level_name,      
    int*           quorum                   
    );

extern EPM_API int CR_ask_group_release_procedures(
    const char*    group_name,                   
    int*           count,                        
    char***        release_procedure_names       
    );

extern EPM_API int CR_ask_procedure_release_levels(
    const char*    release_procedure_name,     
    int*           count,                      
    char***        release_level_names         
    );

extern EPM_API int CR_reassign_reviewer(
    tag_t          release_level,          
    tag_t          new_groupmember,        
    tag_t          signoff                 
    );

extern EPM_API int CR_find_status_type (
    const char*    status_type,     
    tag_t*         status           
    );

extern EPM_API int CR_ask_release_statuses(
    tag_t          job,                     
    int*           count,                   
    tag_t**        release_status_objects   
    );

extern EPM_API int CR_add_release_status(
    tag_t          job,             
    tag_t          release_status   
    );

extern EPM_API int CR_remove_release_status(
    tag_t          job,             
    tag_t          release_status   
    );

extern EPM_API int CR_remove_status_from_targets(
  tag_t         release_status,            
  tag_t         root_task                   
    );
extern EPM_API int CR_ask_if_released(
    tag_t          workspace_object,    
    int*           is_released          
    );

extern EPM_API int CR_ask_accessor_tags(
    const char*    group_name,          
    logical        allow_sub_groups,    
    const char*    role_name,           
    int*           num_accessors,       
    tag_t**        accessors            
    );

extern EPM_API int CR_ask_procedure_access(
    char*          release_procedure_name,  
    char*          release_level_name,      
    int*           no_of_accessors,         
    char***        group_names,             
    char***        role_names,              
    int**          access_codes             
    );

extern EPM_API int CR_ask_task_reviewers_group_member(
    const tag_t    task_tag,            
    int*           group_member_count,  
    tag_t**        group_members        
    );

extern EPM_API int CR_ask_task_reviewers_resource_pool(
    const tag_t    task_tag,            
    int*           res_pool_count,      
    tag_t**        res_pool_tags        
    );

extern EPM_API int CR_ask_task_reviewers_users(
    const tag_t    task_tag,    
    int*           user_count,  
    tag_t**        users        
    );

extern EPM_API int CR_ask_task_undecided_reviewers_users(
    const tag_t    task_tag,        
    int*           user_count,      
    tag_t**        users            
    );

#ifdef __cplusplus
}
#endif

#include <epm/libepm_undef.h>
#endif