OperationDispatcherRegistry.hxx

Go to the documentation of this file.

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

                    Copyright (c) 2007 UGS
                             Unpublished - All rights reserved
====================================================================================================
File description:

    Filename: OperationDispatcher.hxx
    Module  : extensionframework

    This operation dispatcher register for BO operation.

====================================================================================================
   Date      Name                    Description of Change
$HISTORY$
==================================================================================================*/
#ifndef OPERATIONDISPATCHERREGISTRY_HXX
#define OPERATIONDISPATCHERREGISTRY_HXX

#include <unidefs.h>

#include <string>
#include <map>

#include <common/tc_deprecation_macros.h>
#include <metaframework/Object.hxx>
#include <extensionframework/OperationDispatcher.hxx>
#include <extensionframework/libextensionframework_exports.h>

namespace Teamcenter
{
    class OperationDispatcherRegistry;
}

typedef enum EXTENSIONFRAMEWORK_operation_int_type_e
{
    OPERATION_TYPE_UNDEFINED = 0,
    OPERATION_TYPE_SETBASED,                        
    OPERATION_TYPE_OBJECT_BASED_MESSAGE_BASED       
}EXTENSIONFRAMEWORK_operation_int_type_t;

typedef enum EXTENSIONFRAMEWORK_bulk_operation_e
{
    OPER_SAVE,            
    OPER_DELETE,          
    OPER_LOCK,            
    OPER_UNLOCK,          
    OPER_REFRESH,         
    OPER_UNDEFINED = 100  
}  EXTENSIONFRAMEWORK_bulk_operation_t;

class EXTENSIONFRAMEWORK_API Teamcenter::OperationDispatcherRegistry : public Teamcenter::Object
{
public:
    typedef OperationDispatcher* (*OperationDispatcherConstructor)();
    
    typedef std::vector< std::pair< OperationDispatcherConstructor, std::string > > OperationDispatcherMapValue;
    typedef std::map< std::string, OperationDispatcherMapValue > OperationDispatcherMap;
    typedef std::map< int, std::vector<int> > SetBasedToObjectBasedOpIntMap;
    typedef std::map< int, std::vector<int> > ObjectBasedToSetBasedOpIntMap;
    static  OperationDispatcherRegistry& instance();
    void initializeRegister(const std::string& opId, OperationDispatcherConstructor ctr);
    void registerBusinessObjOperationDispatcherCtor( const std::string& opId, const std::string& typeName, OperationDispatcherConstructor ctr );
    int createOperationDispatcher( const std::string& opId, OperationDispatcher*& opDispatcher );
    int createBusinessObjOperationDispatcher( const std::string& opId, const std::string& typeName, OperationDispatcher*& opDispatcher );
    void registerTypeOperation(int opInt, tag_t typeTag);
    std::vector<tag_t>* getStopTraverseTypes( int opInt );

    TC_DEPRECATED_NO_REPLACEMENT("11.2.4","getObjectBasedOpIntForSetBasedOpInt")
    void getObjectBasedOpIntForSetBasedOpInt( int setBasedOpInt, std::vector<int>& objBasedOpInt );

    void getEquivalentObjectBasedOrSetBasedOpInt( int inputOpInt, std::vector<int>& equivalentOpInt, EXTENSIONFRAMEWORK_operation_int_type_t& opIntType );

    void dumpFunction();

    static void isFallbackEnabledOperation( const int                             inputOpInt,        
                                            bool&                                 isFallBackEnabled, 
                                            EXTENSIONFRAMEWORK_bulk_operation_t&  bulkOperEnum       
                                          );


protected:
    OperationDispatcherRegistry();
    ~OperationDispatcherRegistry();
private:
    OperationDispatcherMap m_operarionDispatchCtorMap;
    static OperationDispatcherRegistry* m_instance;
    std::map< int, std::vector< tag_t >* > m_typeOperations;
    static SetBasedToObjectBasedOpIntMap s_SetBasedToObjectBasedOpIntMap;
    static ObjectBasedToSetBasedOpIntMap s_ObjectBasedToSetBasedOpIntMap;
    void initializeSetBasedToObjectBaseOperationMap();
    void initializeObjectBasedToSetBaseOperationMap();

    static void initializeFallbackEnabledOperationMap();
};
#include <extensionframework/libextensionframework_undef.h>
#endif //OPERATIONDISPATCHERREGISTRY_HXX