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.

297 lines
12 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, Cfg0AbsConfiguratorWSODelegate
Filename: Cfg0AbsConfiguratorWSODelegate.hxx
Module: Cfg0configurator
@BMIDE autogenerated
==================================================================================================*/
#ifndef TEAMCENTER__CFG0CONFIGURATOR__CFG0ABSCONFIGURATORWSODELEGATE_HXX
#define TEAMCENTER__CFG0CONFIGURATOR__CFG0ABSCONFIGURATORWSODELEGATE_HXX
#include <common/tc_deprecation_macros.h>
#include <Cfg0configurator/Cfg0AbsConfiguratorWSO.hxx>
#include <Cfg0configurator/libcfg0configurator_exports.h>
namespace Teamcenter
{
namespace Cfg0configurator
{
class Cfg0AbsConfiguratorWSODelegate;
}
}
namespace Teamcenter
{
namespace Cfg0configurator
{
class Cfg0AbsConfiguratorWSOImpl;
}
}
namespace Teamcenter
{
namespace Cfg0configurator
{
class Cfg0AbsConfiguratorWSO;
}
}
namespace Teamcenter
{
namespace Cfg0configurator
{
class Cfg0AbsConfiguratorWSOGenImpl;
}
}
namespace Teamcenter_alias = ::Teamcenter;
class CFG0CONFIGURATOR_API Teamcenter_alias::Cfg0configurator::Cfg0AbsConfiguratorWSODelegate
{
public:
// Method to initialize this Class
static int initializeClass();
// Method to get the Cfg0AbsConfiguratorWSODelegate instance
static Cfg0AbsConfiguratorWSODelegate& getInstance();
// Method to create the Cfg0AbsConfiguratorWSOImpl pointer
static Cfg0AbsConfiguratorWSOImpl* createImpl( Cfg0AbsConfiguratorWSO& ifObj );
// Method to delete the Cfg0AbsConfiguratorWSOImpl pointer
static void deleteImpl( Cfg0AbsConfiguratorWSOImpl* impl );
///
/// Returns the persisted formula for the effectivity condition of the object in a specific syntax, for example, [Teamcenter::]Date >= 2015-06-01T05:30:00Z. The formula is given in a system friendly parsable format. It is not localized
/// @version Teamcenter 10.1.3
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getCfg0EffectivityBase(const Cfg0AbsConfiguratorWSO &ifObj, std::string &value, bool &isNull ) const;
///
/// Setter for a string Property
/// @version Teamcenter 10.1.3
/// @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 setCfg0EffectivityBase(Cfg0AbsConfiguratorWSO &ifObj, const std::string &value, bool isNull );
///
/// Setter for cfg0Intents Property of configurator object
/// @version Teamcenter 11.2.2
/// @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 setCfg0IntentsBase(Cfg0AbsConfiguratorWSO &ifObj, const std::vector< std::string > &values, const std::vector< int > *isNull );
///
/// Finalize Revise Input Descriptor
/// @version Teamcenter 10.1.2
/// @param pReviseInput - Revise input
/// @param vecDeepCopyData - Deep Copy Data Vector
/// @return - Failure Code
///
int finalizeReviseInputBase(const Cfg0AbsConfiguratorWSO &ifObj, ::Teamcenter::ReviseInput *pReviseInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData );
///
/// This operation is not supported now, there will be no support for issues stemming from uses of this operation.
/// @version Teamcenter 11.2.3
/// @param inputs - A vector of data that contains reference information to the objects to be revised
/// @param bd - A data structure to store objects and other information relevant for set-based operation
/// @return -
///
int fnd0FinalizeReviseInputBase( 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.3
/// @param inputs - A vector of data that contains reference information to the objects to be revised
/// @param bd - A data structure to store objects and other information relevant for set-based operation
/// @return -
///
int fnd0ReviseBase( 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.3
/// @param inputs - A vector of data that contains reference information to the objects to be revised
/// @param bd - A data structure to store objects and other information relevant for set-based operation
/// @return -
///
int fnd0RevisePostBase( 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.3
/// @param inputs - A vector of data that contains reference information to the objects to be revised
/// @param bd - A data structure to store objects and other information relevant for set-based operation
/// @return -
///
int fnd0SetPropertiesFromReviseInputBase( 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.3
/// @param inputs - A vector of data that contains reference information to the objects to be revised
/// @param bd - A data structure to store objects and other information relevant for set-based operation
/// @return -
///
int fnd0ValidateReviseInputBase( std::vector< ::Teamcenter::BulkInput* > *inputs, ::Teamcenter::BulkData *bd );
///
/// Cfg0AbsConfiguratorWSO Revise Operation
/// @version Teamcenter 10.1.2
/// @param pReviseInput - Revise Input
/// @param vecDeepCopyData - Deep Copy Data Vactor
/// @param newObject - New Object tag
/// @return - Failure Code
///
int reviseBase(const Cfg0AbsConfiguratorWSO &ifObj, ::Teamcenter::ReviseInput *pReviseInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData, tag_t *newObject );
///
/// Reivse post operation
/// @version Teamcenter 10.1.2
/// @param pReviseInput - Revise Input Descriptor
/// @param vecDeepCopyData - Deep Copy Data Vector
/// @return - Failure Code
///
int revisePostBase(const Cfg0AbsConfiguratorWSO &ifObj, ::Teamcenter::ReviseInput *pReviseInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData );
///
/// Set properties from revise input.
/// @version Teamcenter 10.1.2
/// @param pReviseInput - Revise Input Descriptor
/// @return - Failure code
///
int setPropertiesFromReviseInputBase(const Cfg0AbsConfiguratorWSO &ifObj, ::Teamcenter::ReviseInput *pReviseInput );
///
/// Validate Revise Input Descriptor
/// @version Teamcenter 10.1.2
/// @param pReviseInput - Revise Input Descriptor
/// @param vecDeepCopyData - Deep Copy Data Vector
/// @return - Failure Code
///
int validateReviseInputBase(const Cfg0AbsConfiguratorWSO &ifObj, ::Teamcenter::ReviseInput *pReviseInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData );
///
/// desc for createPost
/// @version Tc 8
/// @param creInput - Description for the Create Input
/// @return - return desc for createPost
///
int createPostBase(const Cfg0AbsConfiguratorWSO &ifObj, ::Teamcenter::CreateInput *creInput );
///
/// Description for the Finalize Create Input
/// @version Tc 8
/// @param creInput - desc for creInput parameter
/// @return - Return desc for Initialize for Create
///
int finalizeCreateInputBase(const Cfg0AbsConfiguratorWSO &ifObj, ::Teamcenter::CreateInput *creInput );
///
/// finalize operation input
/// @version Teamcenter 9
/// @param pSavAsInput - desc
/// @param vecDeepCopyData - desc
/// @return - returns an int
///
int finalizeSaveAsInputBase(const Cfg0AbsConfiguratorWSO &ifObj, ::Teamcenter::SaveAsInput *pSavAsInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData );
///
/// 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 );
///
/// Generic saveAsPost operation.
/// @version Teamcenter 8.1
/// @param pSavAsInput - Input argument as SaveAsInput object.
/// @param vecDeepCopyData - vector deepcopy data
/// @return - Return integer value.
///
int saveAsPostBase(const Cfg0AbsConfiguratorWSO &ifObj, ::Teamcenter::SaveAsInput *pSavAsInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData );
///
/// desc for validate for create
/// @version Tc 8
/// @param creInput - desc for creInput parameter
/// @return - ret desc for validate for create
///
int validateCreateInputBase(const Cfg0AbsConfiguratorWSO &ifObj, ::Teamcenter::CreateInput *creInput );
///
/// validate saveas input
/// @version Teamcenter 9
/// @param pSavAsInput - desc
/// @param vecDeepCopyData - desc
/// @return - returns an int
///
int validateSaveAsInputBase(const Cfg0AbsConfiguratorWSO &ifObj, ::Teamcenter::SaveAsInput *pSavAsInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData );
protected:
// Pointer to the instance
static Cfg0AbsConfiguratorWSODelegate* m_pInstance;
Cfg0AbsConfiguratorWSODelegate();
virtual ~Cfg0AbsConfiguratorWSODelegate();
static void setInstance( Cfg0AbsConfiguratorWSODelegate* instance );
private:
friend class ::Teamcenter::Cfg0configurator::Cfg0AbsConfiguratorWSOGenImpl;
};
#include <Cfg0configurator/libcfg0configurator_undef.h>
#endif // TEAMCENTER__CFG0CONFIGURATOR__CFG0ABSCONFIGURATORWSODELEGATE_HXX