cfm.h

Go to the documentation of this file.

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

/*  */

#ifndef CFM_H
#define CFM_H

#include <unidefs.h>

#include <cfm/cfm_errors.h>
#include <cfm/cfm_tokens.h>
#include <cfm/libcfm_exports.h>

#define CFM_entry_working           0
#define CFM_entry_status            1
#define CFM_entry_override          2
#define CFM_entry_date              3
#define CFM_entry_unit_no           4
#define CFM_entry_group             5
#define CFM_entry_precise           6
#define CFM_entry_latest            7
#define CFM_entry_end_item          8
#define CFM_entry_group_item_type   9
#define CFM_entry_branch            10
#define CFM_entry_nested_eff        11

#define CFM_status_released_date    0
#define CFM_status_effective_date   1
#define CFM_status_unit_no          2

#define CFM_latest_creation_date    0
#define CFM_latest_alphanumeric     1
#define CFM_latest_numeric          2
#define CFM_latest_alpha_plus_no    3

#ifdef __cplusplus
extern "C"
{
#endif

/* END OF HEADER */

extern CFM_API int CFM_rule_create(
    const char*    rule_name,       
    const char*    description,     
    tag_t*         new_rule         
    );

extern CFM_API int CFM_rule_copy(
    tag_t          rule_to_copy,    
    const char*    new_name,        
    tag_t*         new_rule         
    );

extern CFM_API int CFM_ask_rule_text(
    tag_t          rule,               
    char**         text                
    );

extern CFM_API int CFM_rule_reevaluate(
    tag_t          rule             
    );

extern CFM_API int CFM_rule_add_entry(
    tag_t          rule,            
    int            type,            
    tag_t*         entry            
    );

extern CFM_API int CFM_rule_delete_entry(
    tag_t          rule,            
    tag_t          entry            
    );

extern CFM_API int CFM_rule_replace_entry(
    tag_t          rule,            
    tag_t          old_entry,       
    int            type,            
    tag_t*         new_entry        
    );

extern CFM_API int CFM_rule_list_entries(
    tag_t          rule,            
    int*           n_entries,       
    tag_t**        entries,         
    int**          entry_types      
    );

extern CFM_API int CFM_rule_move_entry_up(
    tag_t          rule,            
    tag_t          entry            
    );

extern CFM_API int CFM_rule_move_entry_down(
    tag_t          rule,            
    tag_t          entry            
    );

extern CFM_API int CFM_rule_group_entries(
    tag_t          rule,            
    int            n_entries,       
    tag_t*         entries,         
    tag_t*         group_entry      
    );

extern CFM_API int CFM_rule_group_entries_by_itemtype(
    tag_t         rule,            
    int           n_entries,       
    tag_t*       entries,          
    int n_itemtypes,               
    char**       item_types,       
    tag_t*       group_entry       
    );

extern CFM_API int CFM_entry_ask_type(
    tag_t          entry,            
    int*           type              
    );

extern CFM_API int CFM_working_entry_ask_user(
    tag_t          entry,             
    logical*       current_user,      
    tag_t*         user               
    );

extern CFM_API int CFM_working_entry_set_user(
    tag_t          entry,              
    logical        current_user,       
    tag_t          user                
    );

extern CFM_API int CFM_working_entry_ask_group(
    tag_t          entry,             
    logical*       current_group,     
    tag_t*         user               
    );

extern CFM_API int CFM_working_entry_set_group(
    tag_t          entry,              
    logical        current_group,      
    tag_t          user                
    );

extern CFM_API int CFM_status_entry_ask_status(
    tag_t          entry,              
    tag_t*         status_type         
    );

extern CFM_API int CFM_status_entry_set_status(
    tag_t          entry,              
    tag_t          status_type         
    );

extern CFM_API int CFM_status_entry_ask_type(
    tag_t          entry,   
    int*           type     
    );

extern CFM_API int CFM_status_entry_set_type(
    tag_t          entry,   
    int            type     
    );

extern CFM_API int CFM_override_entry_ask_folder(
    tag_t          entry,   
    tag_t*         folder   
    );

extern CFM_API int CFM_override_entry_set_folder(
    tag_t          entry,   
    tag_t          folder   
    );


extern CFM_API int CFM_branch_entry_ask_branch(
    tag_t          entry,   
    tag_t*         branch   
    );

extern CFM_API int CFM_branch_entry_set_branch(
    tag_t          entry,   
    tag_t          branch   
    );


extern CFM_API int CFM_date_entry_ask_date(
    tag_t          entry,              
    logical*       today,              
    date_t*        effective_date      
    );

extern CFM_API int CFM_date_entry_set_date(
    tag_t          entry,              
    logical        today,              
    date_t         effective_date      
    );

extern CFM_API int CFM_rule_ask_date(
    tag_t          rule,    
    date_t*        date     
    );
extern CFM_API int CFM_rule_set_date(
    tag_t          rule,    
    date_t         date     
    );

extern CFM_API int CFM_unitno_entry_ask_no(
    tag_t          entry,   
    int*           unit_no  
    );

extern CFM_API int CFM_unitno_entry_set_no(
    tag_t          entry,   
    int            unit_no  
    );

extern CFM_API int CFM_latest_entry_ask_type(
    tag_t          entry,   
    int*           type     
    );

extern CFM_API int CFM_latest_entry_set_type(
    tag_t          entry,   
    int            type     
    );

extern CFM_API int CFM_group_entry_list_entries(
    tag_t          group_entry, 
    int*           n_entries,   
    tag_t**        entries      
    );

extern CFM_API int  CFM_group_itemtype_entry_ask_itemtypes(
    tag_t entry,                  
    int*  n_itemtypes,            
    char***  itemtypes            
    );

extern CFM_API int  CFM_group_itemtype_entry_set_itemtypes(
    tag_t entry,                 
    int n_itemtypes,             
    char** itemtypes             
    );

extern CFM_API int CFM_group_entry_add_entry(
    tag_t          group_entry,     
    tag_t          entry_to_add     
    );

extern CFM_API int CFM_group_entry_remove_entry(
    tag_t          group_entry,     
    tag_t          entry_in_group   
    );

extern CFM_API int CFM_rule_ask_effective_date(
    tag_t          rule,    
    date_t*        date     
    );

extern CFM_API int CFM_rule_set_effective_date(
    tag_t          rule,    
    date_t         date     
    );

extern CFM_API int CFM_rule_ask_unit(
    tag_t          rule,    
    int*           unit     
    );

extern CFM_API int CFM_rule_set_unit(
    tag_t          rule,    
    int            unit     
    );

extern CFM_API int CFM_rule_ask_modifier(
    tag_t          rule,       
    tag_t *        modifier    
    );

extern CFM_API int CFM_rule_set_modifier(
    tag_t          rule,       
    tag_t          modifier    
    );

extern CFM_API int CFM_rule_generate_modifier(
    tag_t          rule,                
    tag_t          itemrev,             
    logical        override_parent,     
    tag_t          old_modifier,        
    tag_t *        new_modifier         
    );

extern CFM_API int CFM_rule_generate_modifier_chain(
    tag_t          rule,                
    int            n_items,             
    tag_t *        items,               
    logical        override_parent,     
    tag_t **       itemrevs,            
    tag_t **       modifiers            
    );

extern CFM_API int CFM_rule_generate_end_modifier(
    tag_t          rule,                
    int            n_items,             
    tag_t *        items,               
    logical        override_parent,     
    tag_t *        last_itemrev,        
    tag_t *        last_modifier        
    );

extern CFM_API int CFM_rule_delete_modifier(
    tag_t          modifier    
    );


extern CFM_API int CFM_rule_ask_end_item(
    tag_t          rule,    
    tag_t*         end_item 
    );

extern CFM_API int CFM_rule_ask_end_item_rev(
    tag_t          rule,        
    tag_t*         end_item_rev 
    );

extern CFM_API int CFM_rule_set_end_item(
    tag_t          rule,    
    tag_t          end_item 
    );

extern CFM_API int CFM_rule_set_end_item_rev(
    tag_t          rule,    
    tag_t          end_item_rev 
    );

extern CFM_API int CFM_rule_add_intent(
    tag_t          rule,    
    tag_t          intent   
    );

extern CFM_API int CFM_rule_remove_intent(
    tag_t          rule,    
    tag_t          intent   
    );

extern CFM_API int CFM_rule_list_intents(
    tag_t          rule,        
    int*           n_intents,   
    tag_t**        intents      
    );

extern CFM_API int CFM_item_ask_configured(
    tag_t          rule,            
    tag_t          item,            
    tag_t*         configured_rev,  
    char**         how_configured   
    );

extern CFM_API int CFM_item_ask_configured_base(
    tag_t          rule,            
    tag_t          item,            
    tag_t*         configured_rev,  
    char**         how_configured   
    );


extern CFM_API int CFM_item_ask_configured_nested(
    tag_t          rule,            
    tag_t          item,            
    tag_t*         configured_rev,  
    char**         how_configured   
    );

extern CFM_API int CFM_item_ask_how_configured(
    tag_t          rule,            
    tag_t          item,            
    tag_t*         configured_rev,  
    tag_t*         how_configured   
    );

extern CFM_API int CFM_how_configured_text(
    tag_t          how_configured,  
    char**         text             
    );

extern CFM_API int CFM_latest_of_latest(
    tag_t          rule,            
    int            n_candidates,    
    tag_t*         candidates,      
    tag_t*         latest           
    );

extern CFM_API int CFM_ask_how_configured_user_ref(
    tag_t          how_configured,  
    tag_t*         user_ref         
    );

extern CFM_API int CFM_set_how_configured_user_ref(
    tag_t          how_configured,  
    tag_t          user_ref         
    );

extern CFM_API int CFM_free_how_configured(
    tag_t          how_configured   
    );

extern CFM_API int CFM_find(
    const char*    name,    
    tag_t*         rule     
    );

extern CFM_API int CFM_list(
    int*           count,   
    tag_t**        rules    
    );

extern CFM_API int CFM_get_revision_rules(
    int*           count,   
    tag_t**        rules    
    );

extern CFM_API int CFM_updated(
    tag_t          rule     
    );

extern CFM_API int CFM_is_occ_configured(
    tag_t          rule,    
    tag_t          bvr,     
    tag_t          occ,     
    logical*       answer   
    );

extern CFM_API int CFM_occ_set_effectivity(
    tag_t          bvr,         
    tag_t          occ,         
    tag_t          eff_object   
    );

extern CFM_API int CFM_occ_ask_effectivity(
    tag_t          bvr,         
    tag_t          occurrence,  
    tag_t*         eff_object   
    );

extern CFM_API int CFM_effectivity_create(
    const char*    id,          
    tag_t*         eff_object   
    );

extern CFM_API int CFM_effectivity_find(
    const char*    id,          
    tag_t*         eff_object   
    );

extern CFM_API int CFM_effectivity_ask_id(
    tag_t          eff_object,  
    char**         id           
    );

extern CFM_API int CFM_effectivity_set_id(
    tag_t          eff_object,  
    const char*    id           
    );

extern CFM_API int CFM_effectivity_ask_date_ranges(
    tag_t          eff_object,      
    int*           n_ranges,        
    date_t**       from_dates,      
    date_t**       to_dates         
    );

extern CFM_API int CFM_effectivity_set_date_ranges(
    tag_t          eff_object,     
    int            n_ranges,       
    date_t*        from_dates,     
    date_t*        to_dates        
    );

extern CFM_API int CFM_create_intent(
    const char*    name,         
    const char*    desc,         
    tag_t*         new_intent    
    );

/*================================================================================================*/

extern CFM_API int CFM_find_effectivities(
    const char * id,         
    int *        n_effs,     
    tag_t **     effs,       
    tag_t *      date_info   
    );

extern CFM_API int CFM_create_eff_mapping(
    tag_t       itemrev,        
    tag_t*      mapping         
    );

extern CFM_API int CFM_set_eff_mapping_eff(
    tag_t        mapping,      
    tag_t        eff           
    );

extern CFM_API int CFM_set_eff_mapping_eff_id(
    tag_t        mapping,   
    const char * id         
    );

extern CFM_API int CFM_set_eff_mapping_eff_protection(
    tag_t       mapping,        
    logical     protection      
    );

extern CFM_API int CFM_set_eff_mapping_enditem(
    tag_t       mapping,        
    tag_t       enditem         
    );

extern CFM_API int CFM_set_eff_mapping_enditemrev(
    tag_t       mapping,        
    tag_t       enditemrev      
    );

extern CFM_API int CFM_set_eff_mapping_unit_range(
    tag_t       mapping,        
    const char* range_text,     
    logical     append          
    );

extern CFM_API int CFM_set_eff_mapping_units(
    tag_t       mapping,                   
    int         n_units,                   
    int*        start_end_values,          
    int         open_ended_or_stock_out,   
    logical     append                     
    );

extern CFM_API int CFM_set_eff_mapping_date_range(
    tag_t       mapping,        
    const char* range_text,     
    logical     append          
    );

extern CFM_API int CFM_set_eff_mapping_dates(
    tag_t       mapping,                   
    int         n_dates,                   
    date_t*     start_end_values,          
    int         open_ended_or_stock_out,   
    logical     append                     
    );

extern CFM_API int CFM_set_eff_mapping_subenditem(
    tag_t       mapping,        
    tag_t       subenditem      
    );
extern CFM_API int CFM_set_eff_mapping_subenditemrev(
    tag_t       mapping,        
    tag_t       subenditemrev   
    );
extern CFM_API int CFM_set_eff_mapping_subunit(
    tag_t       mapping,        
    int         subunit         
    );
extern CFM_API int CFM_set_eff_mapping_subdate(
    tag_t       mapping,        
    date_t      subdate         
    );

extern CFM_API int CFM_ask_eff_mapping_eff(
    tag_t        mapping,      
    tag_t *      eff           
    );

extern CFM_API int CFM_ask_eff_mapping_eff_id(
    tag_t       mapping,   
    char **     id         
    );

extern CFM_API int CFM_ask_eff_mapping_eff_protection(
    tag_t       mapping,        
    logical *   protection      
    );

extern CFM_API int CFM_ask_eff_mapping_enditem(
    tag_t       mapping,        
    tag_t *     enditem         
    );

extern CFM_API int CFM_ask_eff_mapping_enditemrev(
    tag_t       mapping,        
    tag_t*      enditemrev      
    );

extern CFM_API int CFM_ask_eff_mapping_range_type(
    tag_t       mapping,        
    int*        range_type      
    );

extern CFM_API int CFM_ask_eff_mapping_unit_range(
    tag_t       mapping,        
    char**      range_text      
    );

extern CFM_API int CFM_ask_eff_mapping_units(
    tag_t       mapping,                  
    int*        n_units,                  
    int**       start_end_values,         
    int*        open_ended_or_stock_out   
    );

extern CFM_API int CFM_ask_eff_mapping_date_range(
    tag_t       mapping,        
    char**      range_text      
    );

extern CFM_API int CFM_ask_eff_mapping_dates(
    tag_t       mapping,                  
    int*        n_dates,                  
    date_t**    start_end_values,         
    int*        open_ended_or_stock_out   
    );

extern CFM_API int CFM_ask_eff_mapping_subenditem(
    tag_t       mapping,        
    tag_t*      subenditem      
    );
extern CFM_API int CFM_ask_eff_mapping_subenditemrev(
    tag_t       mapping,        
    tag_t*      subenditemrev   
    );
extern CFM_API int CFM_ask_eff_mapping_subunit(
    tag_t       mapping,        
    int*        subunit         
    );
extern CFM_API int CFM_ask_eff_mapping_subdate(
    tag_t       mapping,        
    date_t*     subdate         
    );

extern CFM_API int CFM_rule_modifier_ask_enditem(
    tag_t       modifier,       
    tag_t*      enditem         
    );
extern CFM_API int CFM_rule_modifier_ask_enditemrev(
    tag_t       modifier,       
    tag_t*      enditemrev      
    );
extern CFM_API int CFM_rule_modifier_ask_unit(
    tag_t       modifier,       
    int*        unit            
    );
extern CFM_API int CFM_rule_modifier_ask_date(
    tag_t       modifier,       
    date_t*     date            
    );

/*================================================================================================*/

#ifdef __cplusplus
}
#endif

#include <cfm/libcfm_undef.h>
#endif