typecannedmethod.h

Go to the documentation of this file.

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

/*  */

#ifndef TYPE_CANNEDMETHOD_H
#define TYPE_CANNEDMETHOD_H

#include <tc/tc_startup.h>
#include <tccore/workspaceobject.h>
#include <tccore/method.h>
#include <tccore/libtccore_exports.h>

#define METHOD_CM_Pre_Condition_type        0

#define METHOD_CM_Pre_Action_type           1   

#define METHOD_CM_Base_Action_type          2   

#define METHOD_CM_Post_Action_type          3   

#define METHOD_CM_MAX_MSG_NAME_LEN          32

#define METHOD_CM_MAX_METHOD_NAME_LEN       32 

#define METHOD_CM_PARAM_DELIM               "::"       

#define METHOD_CM_QUERY_ATTR_DELIM          "~"   

#define METHOD_CM_NUM_OF_ATTRS              9    

#define METHOD_CM_MIN_NUM_OF_ATTRS          6    

#define METHOD_CM_TYPE_NAME_ATTR            "type_name"
#define METHOD_CM_MSG_NAME_ATTR             "msg_name"
#define METHOD_CM_ACTION_TYPE_ATTR          "action_type"
#define METHOD_CM_METHOD_NAME_ATTR          "method_name"
#define METHOD_CM_EXEC_SEQ_ATTR             "exec_seq"
#define METHOD_CM_METHOD_OPTIONS_ATTR       "method_options"
#define METHOD_CM_OPTION_PARAMETERS         "parameters"
#define METHOD_CM_OPTION_PARAMETERS_PARAM   "parameter"

typedef struct METHOD_CM_func_name_and_ptr_s
{
    char                func_name[METHOD_CM_MAX_METHOD_NAME_LEN +1];
    METHOD_function_t   func_ptr;
} METHOD_CM_func_name_and_ptr_t, *METHOD_CM_func_name_and_ptr_p_t;


TCCORE_API typedef struct METHOD_CM_Func_Detail_s
{
    char        classOrObjectType [WSO_name_size_c +1];
    char        msgName [METHOD_CM_MAX_MSG_NAME_LEN +1];
    int         actionType;
    char        funcName [METHOD_CM_MAX_METHOD_NAME_LEN];
    const char* userDataTemplate;
    const char* isMandatoryTemplate;
    const char* userSavedQueryDetail;
} METHOD_CM_Func_Detail_t, *METHOD_CM_Func_Detail_p_t;

#ifdef __cplusplus
    extern "C"{
#endif

extern TCCORE_API int METHOD_CM_init_module();

extern TCCORE_API int METHOD_CM_extent(
    int*                count,              
    tag_t**             canned_method_tags  
    );

extern TCCORE_API int METHOD_CM_register_function(
    const char*         func_name,  
    METHOD_function_t   func_ptr    
    );

extern TCCORE_API int METHOD_CM_add_method(
    const char          type_name[WSO_name_size_c + 1],                 
    const char          msg_name[METHOD_CM_MAX_MSG_NAME_LEN + 1],       
    int                 action_type,                                    
    const char          func_name[METHOD_CM_MAX_METHOD_NAME_LEN + 1],   
    const char*         user_data_template,                             
    const char*         is_mandatory_template,                          
    const char*         user_dataQuery_detail                           
    );

extern TCCORE_API int METHOD_CM_add_method2(
    const char          *type_name,                                     
    const char          *msg_name,                                      
    int                 action_type,                                    
    const char          *func_name,                                     
    const char*         user_data_template,                             
    const char*         is_mandatory_template,                          
    const char*         user_dataQuery_detail                           
    );

extern TCCORE_API int METHOD_CM_describe(
    tag_t               cmTag,                                          
    char                type_name[WSO_name_size_c + 1],                 
    char                msg_name[METHOD_CM_MAX_MSG_NAME_LEN + 1],       
    int*                action_type,                                    
    char                method_name[METHOD_CM_MAX_METHOD_NAME_LEN + 1], 
    int*                exec_seq,                                       
    int*                option_value_cnt,                               
    int*                option_cnt,                                     
    char****            option_values                                   
    );

extern TCCORE_API int METHOD_CM_log_details(
    tag_t               cmTag
    );

#ifdef __cplusplus
}
#endif

#include <tccore/libtccore_undef.h>

#endif