signoff.h

Go to the documentation of this file.

/* 
 Copyright 2012 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.
 ==================================================
 Copyright 2014
 Siemens Product Lifecycle Management Software Inc.
 All Rights Reserved.
 ==================================================
 Copyright 2012 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.
==================================================*/

/*  */

#ifndef SIGNOFF_H
#define SIGNOFF_H

#include <epm/cr.h>
#include <epm/epm.h>
#include <epm/libepm_exports.h>

#define SIGNOFF_ORIGIN_PROFILE              0
#define SIGNOFF_ORIGIN_ADHOC_USER           1
#define SIGNOFF_ORIGIN_ADHOC_RESOURCEPOOL   2
#define SIGNOFF_ORIGIN_ALIASLIST            3
#define SIGNOFF_ORIGIN_ADHOC_ALL_RESOURCEPOOL 4
#define SIGNOFF_ORIGIN_UNDEFINED            9999

typedef enum signoff_type_e
{
    SIGNOFF_GROUPMEMBER  = 0,
    SIGNOFF_RESOURCEPOOL = 1,
    SIGNOFF_UNDEFINED = 9999
} SIGNOFF_TYPE_t;


typedef enum signoff_action_e
{
    SIGNOFF_REVIEW  = 1,
    SIGNOFF_ACKNOWLEDGE = 2,
    SIGNOFF_NOTIFY = 3,
    SIGNOFF_ACTION_UNDEFINED = 9999
} SIGNOFF_ACTION_t;

#define SIGNOFF_APPROVE_DECISION          "Approve"
#define SIGNOFF_REJECT_DECISION           "Reject"
#define SIGNOFF_NO_DECISION               "No Decision"
#define SIGNOFF_ACKNOWLEDGED_DECISION     "Acknowledge"
#define SIGNOFF_NOT_ACKNOWLEDGED_DECISION "Not Acknowledge"

#ifdef __cplusplus
    extern "C"{
#endif

extern EPM_API int CR_signoff_extent(
    int*           n_instances,        
    tag_t**        instances           
    );

extern EPM_API int EPM_signoff_extent(
    int*           n_instances,        
    tag_t**        instances           
    );

extern EPM_API int CR_create_signoff(
    tag_t          group_member,         
    tag_t*         signoff               
    );

extern EPM_API int CR_initialize_signoff(
    tag_t          signoff,             
    tag_t          group_member         
    );

extern EPM_API int EPM_initialize_signoff(
    tag_t          signoff,             
    tag_t          group_member         
    );

extern EPM_API int EPM_remove_signoffs(
    tag_t          task_tag,            
    int            n_groupmembers,      
    tag_t*         groupmembers         
    );

extern EPM_API int CR_ask_signoff_member(
    tag_t          signoff,           
    tag_t*         theMember          
    );

extern EPM_API int EPM_ask_reviewers(
    tag_t          task_tag,                
    int*           count,                   
    tag_t**        groupmembers             
    );

extern EPM_API int CR_ask_signoff_groupmember(
    tag_t          signoff,             
    tag_t*         group_member         
    );

extern EPM_API int CR_ask_signoff_resource_pool(
    tag_t          signoff,              
    tag_t*         resource_pool         
    );

extern EPM_API int EPM_ask_signoff_resource_pool(
    tag_t          signoff,              
    tag_t*         resource_pool         
    );

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

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

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

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

extern EPM_API int EPM_ask_unassigned_reviewer_types(
    tag_t          task_tag,                
    int*           count,                   
    tag_t**        unassigned_accessors     
    );

extern EPM_API int CR_ask_signoff_accessor(
    tag_t          signoff,             
    tag_t*         acc                  
    );

extern EPM_API int EPM_ask_signoff_accessor(
    tag_t          signoff,             
    tag_t*         acc                  
    );

extern EPM_API int CR_set_signoff_accessor(
    tag_t          signoff,             
    tag_t          acc                  
    );

extern EPM_API int EPM_set_signoff_accessor(
    tag_t          signoff,             
    tag_t          acc                  
    );

extern EPM_API int CR_set_signoff_decision(
    tag_t                 signoff,                           
    CR_signoff_decision_t decision,                          
    const char            comments[CR_comment_size_c + 1]    
    );

extern EPM_API int CR_set_signoff_decision2(
    tag_t                 signoff,                           
    CR_signoff_decision_t decision,                          
    const char            *comments                          
    );

extern EPM_API int EPM_set_signoff_decision(
    tag_t                 signoff,                           
    EPM_signoff_decision_t decision,                          
    const char            *comments                          
    );

extern EPM_API int EPM_set_secure_signoff_decision(
    tag_t                 signoff,                           
    CR_signoff_decision_t decision,                          
    const char            comments[CR_comment_size_c + 1],   
    const char            password[CR_comment_size_c + 1]    
    );

extern EPM_API int EPM_set_secure_signoff_decision2(
    tag_t                 signoff,                           
    CR_signoff_decision_t decision,                          
    const char            *comments,                         
    const char            *password                          
    );

extern EPM_API int EPM_set_secure_signoff_decision3(
    tag_t                 signoff,                           
    EPM_signoff_decision_t decision,                         
    const char            *comments,                         
    const char            *password                          
    );


extern EPM_API int CR_ask_signoff_decision(
    tag_t                  signoff,                           
    CR_signoff_decision_t* decision,                          
    char                   comments[CR_comment_size_c + 1],   
    date_t*                decision_date                      
    );

extern EPM_API int CR_ask_signoff_decision2(
    tag_t                  signoff,                           
    CR_signoff_decision_t* decision,                          
    char                   **comments,                        
    date_t*                decision_date                      
    );

extern EPM_API int EPM_ask_signoff_decision(
    tag_t                  signoff,                           
    EPM_signoff_decision_t* decision,                         
    char                   **comments,                        
    date_t*                decision_date                      
    );

extern EPM_API int CR_delegate_signoff(
    tag_t          signoff,                            
    tag_t          new_group_member_to_delegate_to,    
    logical        add_audit_file                      
    );

extern EPM_API int EPM_delegate_signoff(
    tag_t          signoff,                            
    tag_t          new_group_member_to_delegate_to,    
    logical        add_audit                           
    );

extern EPM_API int CR_compare_role_and_group(
    tag_t          signoff,         
    logical*       match            
    );

extern EPM_API int EPM_compare_role_and_group(
    tag_t          signoff,         
    logical*       match            
    );

extern EPM_API int EPM_create_signoff(
    tag_t          member,         
    int            originType,     
    tag_t          originProfile,  
    tag_t*         signoff         
    );

extern EPM_API int EPM_create_profile_signoff(
    tag_t          task,             
    tag_t          member,           
    tag_t          signoffProfile,   
    tag_t*         signoff           
    );

extern EPM_API int EPM_create_adhoc_signoff(
    tag_t          task,           
    tag_t          member,         
    int*           count,          
    tag_t**        signoffs        
    );

extern EPM_API int EPM_ask_signoff_member(
    tag_t            signoff,       
    tag_t*           memberTag,     
    SIGNOFF_TYPE_t*  memberType     
    );

extern EPM_API int EPM_ask_signoff_origin_profile(
    tag_t          signoff,             
    tag_t*         originProfile        
    );

extern EPM_API int EPM_set_signoff_origin_profile(
    tag_t          signoff,             
    tag_t          originProfile        
    );

extern EPM_API int EPM_ask_signoff_origin_type(
    tag_t          signoffTag,               
    int*           origin,                   
    tag_t*         originObject              
    );

extern EPM_API int EPM_ask_signoff_current_task(
    tag_t          signoffTag,            
    tag_t*         taskTag                
    );

extern EPM_API int EPM_ask_last_signoff(
    tag_t           ws_object,                        
    tag_t           release_status_tag,               
    EPM_decision_t* decision,                         
    char            signer[WSO_name_size_c + 1],      
    date_t*         sign_off_date                     
    );

extern EPM_API int EPM_ask_last_signoff2(
    tag_t           ws_object,                        
    tag_t           release_status_tag,               
    EPM_decision_t* decision,                         
    char            **signer,                         
    date_t*         sign_off_date                     
    );

extern EPM_API int EPM_ask_signoff_details(
    tag_t            ws_object,            
    tag_t            release_status_tag,   
    int*             no_of_signoffs,       
    EPM_decision_t** decisions,            
    char***          signers,              
    date_t**         sign_off_dates        
    );

extern EPM_API int EPM_delegate_signoff_with_comments(
    tag_t          signoff,                            
    tag_t          new_group_member_to_delegate_to,    
    logical        add_audit,                          
    const char*    user_comments                       
    );

#ifdef __cplusplus
}
#endif

#include <epm/libepm_undef.h>
#endif