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.

248 lines
9.0 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, Cfg0AbsConfiguratorWSO
Filename: Cfg0AbsConfiguratorWSO.hxx
Module: Cfg0configurator
@BMIDE autogenerated
==================================================================================================*/
#ifndef TEAMCENTER__CFG0CONFIGURATOR__CFG0ABSCONFIGURATORWSO__HXX
#define TEAMCENTER__CFG0CONFIGURATOR__CFG0ABSCONFIGURATORWSO__HXX
#include <metaframework/ReviseInput.hxx>
#include <metaframework/DeepCopyData.hxx>
#include <metaframework/BulkInput.hxx>
#include <metaframework/BulkData.hxx>
#include <unidefs.h>
#include <string>
#include <vector>
#include <common/tc_deprecation_macros.h>
#include <tccore/WorkspaceObject.hxx>
#include <Cfg0configurator/libcfg0configurator_exports.h>
namespace Teamcenter
{
namespace Cfg0configurator
{
class Cfg0AbsConfiguratorWSO;
}
}
namespace Teamcenter
{
namespace Cfg0configurator
{
class Cfg0AbsConfiguratorWSOImpl;
}
}
namespace Teamcenter
{
namespace Cfg0configurator
{
class Cfg0AbsConfiguratorWSODelegate;
}
}
namespace Teamcenter
{
namespace Cfg0configurator
{
class Cfg0AbsConfiguratorWSODispatch;
}
}
namespace Teamcenter
{
namespace Cfg0configurator
{
class Cfg0AbsConfiguratorWSOGenImpl;
}
}
namespace Teamcenter
{
class RootObjectImpl;
}
class CFG0CONFIGURATOR_API Teamcenter::Cfg0configurator::Cfg0AbsConfiguratorWSO
: public ::Teamcenter::WorkspaceObject
{
public:
/**
* Get the Interface Name
* @return - return desc for getInterfaceName
*/
static const std::string& getInterfaceName();
///
/// 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 getCfg0Effectivity( 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 setCfg0Effectivity( const std::string &value, bool isNull=false );
///
/// 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 setCfg0Intents( const std::vector< std::string > &values, const std::vector< int > *isNull=0 );
///
/// Finalize Revise Input Descriptor
/// @version Teamcenter 10.1.2
/// @param pReviseInput - Revise input
/// @param vecDeepCopyData - Deep Copy Data Vector
/// @return - Failure Code
///
int finalizeReviseInput( ::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 -
///
static int fnd0FinalizeReviseInput( 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 -
///
static int fnd0Revise( 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 -
///
static int fnd0RevisePost( 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 -
///
static int fnd0SetPropertiesFromReviseInput( 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 -
///
static int fnd0ValidateReviseInput( 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 revise( ::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 revisePost( ::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 setPropertiesFromReviseInput( ::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 validateReviseInput( ::Teamcenter::ReviseInput *pReviseInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData );
protected:
// Method to initialize
virtual void initialize( ::Teamcenter::RootObjectImpl* impl );
/**
* Constructor
*/
Cfg0AbsConfiguratorWSO();
/**
* Destructor
*/
virtual ~Cfg0AbsConfiguratorWSO();
private:
// Getter method for the Implementation Object
Cfg0AbsConfiguratorWSOImpl* getCfg0AbsConfiguratorWSOImpl() const;
// Setter method for the Implementation Object
::Teamcenter::RootObjectImpl* setCfg0AbsConfiguratorWSOImpl( ::Teamcenter::RootObjectImpl* impl );
// Method to set the delete impl boolean
void setDeleteImpl( bool del );
// Pointer to the Implementation object
Cfg0AbsConfiguratorWSOImpl* m_cfg0absconfiguratorwsoImpl;
// Flag to indicate if Implementation object needs to be deleted
bool m_deleteImpl;
/**
* Name of the Business Object
*/
static std::string name;
/**
* Private default constructor. We do not want this class instantiated without the business object passed in.
* @param Cfg0AbsConfiguratorWSO - desc for Cfg0AbsConfiguratorWSO parameter
*/
Cfg0AbsConfiguratorWSO( const Cfg0AbsConfiguratorWSO& );
Cfg0AbsConfiguratorWSO& operator=( const Cfg0AbsConfiguratorWSO& );
friend class Cfg0AbsConfiguratorWSODelegate;
friend class Cfg0AbsConfiguratorWSODispatch;
friend class Cfg0AbsConfiguratorWSOGenImpl;
};
#include <Cfg0configurator/libcfg0configurator_undef.h>
#endif // TEAMCENTER__CFG0CONFIGURATOR__CFG0ABSCONFIGURATORWSO__HXX