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.

458 lines
14 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, IRDCDelegate
Filename: IRDCDelegate.hxx
Module: docmgt
@BMIDE autogenerated
==================================================================================================*/
#ifndef TEAMCENTER__IRDCDELEGATE_HXX
#define TEAMCENTER__IRDCDELEGATE_HXX
#include <common/tc_deprecation_macros.h>
#include <docmgt/IRDC.hxx>
#include <docmgt/libdocmgt_exports.h>
namespace Teamcenter
{
class IRDCDelegate;
}
namespace Teamcenter
{
class IRDCImpl;
}
namespace Teamcenter
{
class IRDC;
}
namespace Teamcenter
{
class IRDCGenImpl;
}
namespace Teamcenter_alias = ::Teamcenter;
class DOCMGT_API Teamcenter_alias::IRDCDelegate
{
public:
// Method to initialize this Class
static int initializeClass();
// Method to get the IRDCDelegate instance
static IRDCDelegate& getInstance();
// Method to create the IRDCImpl pointer
static IRDCImpl* createImpl( IRDC& ifObj );
// Method to delete the IRDCImpl pointer
static void deleteImpl( IRDCImpl* impl );
///
/// Getter for a Tag Property
/// @version Tc 8
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getApp_bus_objBase(const IRDC &ifObj, tag_t &value, bool &isNull ) const;
///
/// Getter for a string Property
/// @version Tc 8
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getCreate_templateBase(const IRDC &ifObj, std::string &value, bool &isNull ) const;
///
/// Getter for a Boolean Property
/// @version Tc 8
/// @param value - Parameter Value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getDelete_filesBase(const IRDC &ifObj, bool &value, bool &isNull ) const;
///
/// Getter for a Tag Array Property
/// @version Tc 8
/// @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 getDer_dataset_type_namesBase(const IRDC &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const;
///
/// Getter for a string Property
/// @version Tc 8
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getDer_ds_createBase(const IRDC &ifObj, std::string &value, bool &isNull ) const;
///
/// Getter for a string Property
/// @version Tc 8
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getDer_files_checkinBase(const IRDC &ifObj, std::string &value, bool &isNull ) const;
///
/// Getter for a string Property
/// @version Tc 8
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getExport_templateBase(const IRDC &ifObj, std::string &value, bool &isNull ) const;
///
/// Getter for a Boolean Property
/// @version Tc 8
/// @param value - Parameter Value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getFtr_index_createBase(const IRDC &ifObj, bool &value, bool &isNull ) const;
///
/// Getter for a Tag Array Property
/// @version Tc 8
/// @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 getIrdc_der_namingBase(const IRDC &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const;
///
/// Getter for a Tag Array Property
/// @version Tc 8
/// @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 getIrdc_namingBase(const IRDC &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const;
///
/// Getter for a Tag Property
/// @version Tc 8
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getMk_appBase(const IRDC &ifObj, tag_t &value, bool &isNull ) const;
///
/// Getter for a Tag Property
/// @version Tc 8
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getMk_dataset_type_nameBase(const IRDC &ifObj, tag_t &value, bool &isNull ) const;
///
/// Getter for a string Property
/// @version Tc 8
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getMk_default_aclBase(const IRDC &ifObj, std::string &value, bool &isNull ) const;
///
/// Getter for a Boolean Property
/// @version Tc 8
/// @param value - Parameter Value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getMk_officialBase(const IRDC &ifObj, bool &value, bool &isNull ) const;
///
/// Getter for a string Property
/// @version Tc 8
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getObject_templateBase(const IRDC &ifObj, std::string &value, bool &isNull ) const;
///
/// Getter for a Tag Array Property
/// @version Tc 8
/// @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 getRender_objsBase(const IRDC &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const;
///
/// Getter for a string Property
/// @version Tc 8
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getSpec_templateBase(const IRDC &ifObj, std::string &value, bool &isNull ) const;
///
/// Getter for a Tag Array Property
/// @version Tc 8
/// @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 getSrc_dataset_type_namesBase(const IRDC &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const;
///
/// Getter for a Boolean Property
/// @version Tc 8
/// @param value - Parameter Value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getView_mkBase(const IRDC &ifObj, bool &value, bool &isNull ) const;
///
/// Setter for a Tag Property
/// @version Tc 8
/// @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 setApp_bus_objBase(IRDC &ifObj, const tag_t &value, bool isNull );
///
/// Setter for a string Property
/// @version Tc 8
/// @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 setCreate_templateBase(IRDC &ifObj, const std::string &value, bool isNull );
///
/// Setter for a Boolean Property
/// @version Tc 8
/// @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 setDelete_filesBase(IRDC &ifObj, bool value, bool isNull );
///
/// Setter for a Tag Array Property
/// @version Tc 8
/// @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 setDer_dataset_type_namesBase(IRDC &ifObj, const std::vector< tag_t > &values, const std::vector< int > *isNull );
///
/// Setter for a string Property
/// @version Tc 8
/// @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 setDer_ds_createBase(IRDC &ifObj, const std::string &value, bool isNull );
///
/// Setter for a string Property
/// @version Tc 8
/// @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 setDer_files_checkinBase(IRDC &ifObj, const std::string &value, bool isNull );
///
/// Setter for a string Property
/// @version Tc 8
/// @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 setExport_templateBase(IRDC &ifObj, const std::string &value, bool isNull );
///
/// Setter for a Boolean Property
/// @version Tc 8
/// @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 setFtr_index_createBase(IRDC &ifObj, bool value, bool isNull );
///
/// Setter for a Tag Array Property
/// @version Tc 8
/// @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 setIrdc_der_namingBase(IRDC &ifObj, const std::vector< tag_t > &values, const std::vector< int > *isNull );
///
/// Setter for a Tag Array Property
/// @version Tc 8
/// @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 setIrdc_namingBase(IRDC &ifObj, const std::vector< tag_t > &values, const std::vector< int > *isNull );
///
/// Setter for a Tag Property
/// @version Tc 8
/// @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 setMk_appBase(IRDC &ifObj, const tag_t &value, bool isNull );
///
/// Setter for a Tag Property
/// @version Tc 8
/// @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 setMk_dataset_type_nameBase(IRDC &ifObj, const tag_t &value, bool isNull );
///
/// Setter for a string Property
/// @version Tc 8
/// @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 setMk_default_aclBase(IRDC &ifObj, const std::string &value, bool isNull );
///
/// Setter for a Boolean Property
/// @version Tc 8
/// @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 setMk_officialBase(IRDC &ifObj, bool value, bool isNull );
///
/// Setter for a string Property
/// @version Tc 8
/// @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_templateBase(IRDC &ifObj, const std::string &value, bool isNull );
///
/// Setter for a Tag Array Property
/// @version Tc 8
/// @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 setRender_objsBase(IRDC &ifObj, const std::vector< tag_t > &values, const std::vector< int > *isNull );
///
/// Setter for a string Property
/// @version Tc 8
/// @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 setSpec_templateBase(IRDC &ifObj, const std::string &value, bool isNull );
///
/// Setter for a Tag Array Property
/// @version Tc 8
/// @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 setSrc_dataset_type_namesBase(IRDC &ifObj, const std::vector< tag_t > &values, const std::vector< int > *isNull );
///
/// Setter for a Boolean Property
/// @version Tc 8
/// @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 setView_mkBase(IRDC &ifObj, bool value, bool isNull );
protected:
// Pointer to the instance
static IRDCDelegate* m_pInstance;
IRDCDelegate();
virtual ~IRDCDelegate();
static void setInstance( IRDCDelegate* instance );
private:
friend class ::Teamcenter::IRDCGenImpl;
};
#include <docmgt/libdocmgt_undef.h>
#endif // TEAMCENTER__IRDCDELEGATE_HXX