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.

125 lines
4.1 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, Fnd0ChangeContextDelegate
Filename: Fnd0ChangeContextDelegate.hxx
Module: tccore
@BMIDE autogenerated
==================================================================================================*/
#ifndef TEAMCENTER__FND0CHANGECONTEXTDELEGATE_HXX
#define TEAMCENTER__FND0CHANGECONTEXTDELEGATE_HXX
#include <common/tc_deprecation_macros.h>
#include <tccore/Fnd0ChangeContext.hxx>
#include <tccore/libtccore_exports.h>
namespace Teamcenter
{
class Fnd0ChangeContextDelegate;
}
namespace Teamcenter
{
class Fnd0ChangeContextImpl;
}
namespace Teamcenter
{
class Fnd0ChangeContext;
}
namespace Teamcenter
{
class Fnd0ChangeContextGenImpl;
}
namespace Teamcenter_alias = ::Teamcenter;
class TCCORE_API Teamcenter_alias::Fnd0ChangeContextDelegate
{
public:
// Method to initialize this Class
static int initializeClass();
// Method to get the Fnd0ChangeContextDelegate instance
static Fnd0ChangeContextDelegate& getInstance();
// Method to create the Fnd0ChangeContextImpl pointer
static Fnd0ChangeContextImpl* createImpl( Fnd0ChangeContext& ifObj );
// Method to delete the Fnd0ChangeContextImpl pointer
static void deleteImpl( Fnd0ChangeContextImpl* impl );
///
/// This is the getter for retrieving the recipe/permanent ID if its been created (and cached on the instance). Every Business Object should implement this operation.
/// @version Teamcenter 11.1
/// @param uid - Recipe/permanent ID
/// @param isFirstTime - If Session Recovery Uid is yet to be set or does the object need to be serialized again?
/// @return - Failure code
///
int fnd0AskSRUidBase(const Fnd0ChangeContext &ifObj, std::string *uid, bool *isFirstTime ) const;
///
/// Generates permanent ID/recipe. Every Business Object should implement this operation.
/// @version Teamcenter 11.1
/// @param recipe - Permanent ID/recipe
/// @return - Failure code.
///
int fnd0GenerateRecipeBase(const Fnd0ChangeContext &ifObj, std::string *recipe );
///
/// If Business Object supports recoverable ID. Every Business Object should implement this operation.
/// @version Teamcenter 11.1
/// @param isPersistedRecipe - isPersistedRecipe param should be set to true if the recipe is limited to the user session and should be serialized to the database
/// @param isRecoverableIDSupported - Returning true indicates support for recoverability/permanent IDs
/// @return - Failure code.
///
int fnd0IsRecoverableBase(const Fnd0ChangeContext &ifObj, bool *isPersistedRecipe, bool *isRecoverableIDSupported ) const;
///
/// This is the setter for the recipe/permanent ID when it is created (to be cached on the instance). Every Business Object should implement this operation.
/// @version Teamcenter 11.1
/// @param uid - Rrecipe/permanent ID
/// @return - Failure code.
///
int fnd0SetSRUidBase(const Fnd0ChangeContext &ifObj, const std::string *uid );
///
/// desc for setPropertiesFromCreateInpu
/// @version Tc 8
/// @param creInput - Description for CreateInput
/// @return - return desc for setPropertiesFromCreateInput
///
int setPropertiesFromCreateInputBase(const Fnd0ChangeContext &ifObj, ::Teamcenter::CreateInput *creInput );
protected:
// Pointer to the instance
static Fnd0ChangeContextDelegate* m_pInstance;
Fnd0ChangeContextDelegate();
virtual ~Fnd0ChangeContextDelegate();
static void setInstance( Fnd0ChangeContextDelegate* instance );
private:
friend class ::Teamcenter::Fnd0ChangeContextGenImpl;
};
#include <tccore/libtccore_undef.h>
#endif // TEAMCENTER__FND0CHANGECONTEXTDELEGATE_HXX