You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
240 lines
8.6 KiB
240 lines
8.6 KiB
//Copyright 2020 Siemens Digital Industries Software
|
|
//==================================================
|
|
//Copyright $2020.
|
|
//Siemens Product Lifecycle Management Software Inc.
|
|
//All Rights Reserved.
|
|
//==================================================
|
|
//Copyright 2020 Siemens Digital Industries Software
|
|
|
|
/*==================================================================================================
|
|
File description:
|
|
This file contains the declaration for the Business Object, EPMHandlerDelegate
|
|
Filename: EPMHandlerDelegate.hxx
|
|
Module: epm
|
|
@BMIDE autogenerated
|
|
==================================================================================================*/
|
|
|
|
#ifndef TEAMCENTER__EPMHANDLERDELEGATE_HXX
|
|
#define TEAMCENTER__EPMHANDLERDELEGATE_HXX
|
|
|
|
#include <common/tc_deprecation_macros.h>
|
|
#include <epm/EPMHandler.hxx>
|
|
|
|
#include <epm/libepm_exports.h>
|
|
|
|
namespace Teamcenter
|
|
{
|
|
class EPMHandlerDelegate;
|
|
}
|
|
namespace Teamcenter
|
|
{
|
|
class EPMHandlerImpl;
|
|
}
|
|
namespace Teamcenter
|
|
{
|
|
class EPMHandler;
|
|
}
|
|
namespace Teamcenter
|
|
{
|
|
class EPMHandlerGenImpl;
|
|
}
|
|
|
|
namespace Teamcenter_alias = ::Teamcenter;
|
|
|
|
|
|
class EPM_API Teamcenter_alias::EPMHandlerDelegate
|
|
{
|
|
public:
|
|
// Method to initialize this Class
|
|
static int initializeClass();
|
|
|
|
// Method to get the EPMHandlerDelegate instance
|
|
static EPMHandlerDelegate& getInstance();
|
|
|
|
// Method to create the EPMHandlerImpl pointer
|
|
static EPMHandlerImpl* createImpl( EPMHandler& ifObj );
|
|
|
|
// Method to delete the EPMHandlerImpl pointer
|
|
static void deleteImpl( EPMHandlerImpl* impl );
|
|
|
|
|
|
///
|
|
/// Getter for an String Array Property
|
|
/// @version Teamcenter 10.1
|
|
/// @param values - Parameter value
|
|
/// @param isNull - Returns true for an array element if the parameter value at that location is null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int getHandler_argumentsBase(const EPMHandler &ifObj, std::vector< std::string > &values, std::vector< int > &isNull ) const;
|
|
|
|
|
|
///
|
|
/// Getter for a string Property
|
|
/// @version Teamcenter 10.1
|
|
/// @param value - Parameter value
|
|
/// @param isNull - Returns true if the Parameter value is null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int getHandler_nameBase(const EPMHandler &ifObj, std::string &value, bool &isNull ) const;
|
|
|
|
|
|
///
|
|
/// Getter for an Integer Property
|
|
/// @version Teamcenter 10.1
|
|
/// @param value - Parameter Value
|
|
/// @param isNull - Returns true if the Parameter value is null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int getHandler_typeBase(const EPMHandler &ifObj, int &value, bool &isNull ) const;
|
|
|
|
|
|
///
|
|
/// Getter for an Integer Property
|
|
/// @version Teamcenter 10.1
|
|
/// @param value - Parameter Value
|
|
/// @param isNull - Returns true if the Parameter value is null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int getNumber_of_argumentsBase(const EPMHandler &ifObj, int &value, bool &isNull ) const;
|
|
|
|
|
|
///
|
|
/// Getter for a string Property
|
|
/// @version Teamcenter 10.1
|
|
/// @param value - Parameter value
|
|
/// @param isNull - Returns true if the Parameter value is null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int getObject_nameBase(const EPMHandler &ifObj, std::string &value, bool &isNull ) const;
|
|
|
|
|
|
///
|
|
/// Getter for a Tag Property
|
|
/// @version Teamcenter 10.1
|
|
/// @param value - Parameter value
|
|
/// @param isNull - Returns true if the Parameter value is null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int getParent_actionBase(const EPMHandler &ifObj, tag_t &value, bool &isNull ) const;
|
|
|
|
|
|
///
|
|
/// Getter for an Integer Property
|
|
/// @version Teamcenter 10.1
|
|
/// @param value - Parameter Value
|
|
/// @param isNull - Returns true if the Parameter value is null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int getParent_action_typeBase(const EPMHandler &ifObj, int &value, bool &isNull ) const;
|
|
|
|
|
|
///
|
|
/// Getter for a Tag Property
|
|
/// @version Teamcenter 10.1
|
|
/// @param value - Parameter value
|
|
/// @param isNull - Returns true if the Parameter value is null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int getParent_task_templateBase(const EPMHandler &ifObj, tag_t &value, bool &isNull ) const;
|
|
|
|
|
|
///
|
|
/// Setter for an string Array Property
|
|
/// @version Teamcenter 10.1
|
|
/// @param values - Values to be set for the parameter
|
|
/// @param isNull - If array element is true, set the parameter value at that location as null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int setHandler_argumentsBase(EPMHandler &ifObj, const std::vector< std::string > &values, const std::vector< int > *isNull );
|
|
|
|
|
|
///
|
|
/// Setter for a string Property
|
|
/// @version Teamcenter 10.1
|
|
/// @param value - Value to be set for the parameter
|
|
/// @param isNull - If true, set the parameter value to null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int setHandler_nameBase(EPMHandler &ifObj, const std::string &value, bool isNull );
|
|
|
|
|
|
///
|
|
/// Setter for an Integer Property
|
|
/// @version Teamcenter 10.1
|
|
/// @param value - Value to be set for the parameter
|
|
/// @param isNull - If true, set the parameter value to null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int setNumber_of_argumentsBase(EPMHandler &ifObj, int value, bool isNull );
|
|
|
|
|
|
///
|
|
/// Setter for a string Property
|
|
/// @version Teamcenter 10.1
|
|
/// @param value - Value to be set for the parameter
|
|
/// @param isNull - If true, set the parameter value to null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int setObject_nameBase(EPMHandler &ifObj, const std::string &value, bool isNull );
|
|
|
|
|
|
///
|
|
/// This operation is not supported now, there will be no support for issues stemming from uses of this operation.
|
|
/// @version Teamcenter 11.2.2
|
|
/// @param inputs - A vector of data that contains reference to the object to be refreshed
|
|
/// @param bd - A data structure to store objects and other information relevant for set-based operation
|
|
/// @param isLockForDelete - A boolean to indicate if object(s) are to be locked for deletion
|
|
/// @param allowRelock - A boolean to indicate if object(s) can be relocked, which will discard all unsaved changes, if already locked by the same user
|
|
/// @return - This operation returns ITK_ok on success. Otherwise, it will return specific error code.
|
|
///
|
|
int fnd0LockBase( std::vector< ::Teamcenter::BulkInput* > *inputs, ::Teamcenter::BulkData *bd, const bool isLockForDelete, const bool allowRelock );
|
|
|
|
|
|
///
|
|
/// This operation is not supported now, there will be no support for issues stemming from uses of this operation.
|
|
/// @version Teamcenter 11.2.2
|
|
/// @param inputs - A vector of data that contains reference to the object to be refreshed
|
|
/// @param bd - A data structure to store objects and other information relevant for set-based operation
|
|
/// @return - This operation returns ITK_ok on success. Otherwise, it will return specific error code.
|
|
///
|
|
int fnd0RefreshBase( std::vector< ::Teamcenter::BulkInput* > *inputs, ::Teamcenter::BulkData *bd );
|
|
|
|
|
|
///
|
|
/// This operation is not supported now, there will be no support for issues stemming from uses of this operation.
|
|
/// @version Teamcenter 11.2.2
|
|
/// @param inputs - A vector of data that contains reference information to the object to be saved
|
|
/// @param bd - A data structure to store objects and other information relevant for set-based operation
|
|
/// @return - This operation returns ITK_ok on success. Otherwise, it will return specific error code.
|
|
///
|
|
int fnd0SaveBase( std::vector< ::Teamcenter::BulkInput* > *inputs, ::Teamcenter::BulkData *bd );
|
|
|
|
|
|
///
|
|
/// This operation is not supported now, there will be no support for issues stemming from uses of this operation.
|
|
/// @version Teamcenter 11.2.2
|
|
/// @param inputs - A vector of data that contains reference to the object to be refreshed
|
|
/// @param bd - A data structure to store objects and other information relevant for set-based operation
|
|
/// @return - This operation returns ITK_ok on success. Otherwise, it will return specific error code.
|
|
///
|
|
int fnd0UnlockBase( std::vector< ::Teamcenter::BulkInput* > *inputs, ::Teamcenter::BulkData *bd );
|
|
|
|
|
|
|
|
protected:
|
|
// Pointer to the instance
|
|
static EPMHandlerDelegate* m_pInstance;
|
|
|
|
EPMHandlerDelegate();
|
|
virtual ~EPMHandlerDelegate();
|
|
static void setInstance( EPMHandlerDelegate* instance );
|
|
|
|
|
|
private:
|
|
friend class ::Teamcenter::EPMHandlerGenImpl;
|
|
|
|
};
|
|
|
|
#include <epm/libepm_undef.h>
|
|
#endif // TEAMCENTER__EPMHANDLERDELEGATE_HXX
|