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.

267 lines
10 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, Mdl0BaselineRevisionDelegate
Filename: Mdl0BaselineRevisionDelegate.hxx
Module: mdl0model
@BMIDE autogenerated
==================================================================================================*/
#ifndef TEAMCENTER__APPMODEL__MDL0BASELINEREVISIONDELEGATE_HXX
#define TEAMCENTER__APPMODEL__MDL0BASELINEREVISIONDELEGATE_HXX
#include <common/tc_deprecation_macros.h>
#include <mdl0model/Mdl0BaselineRevision.hxx>
#include <mdl0model/libmdl0model_exports.h>
namespace Teamcenter
{
namespace AppModel
{
class Mdl0BaselineRevisionDelegate;
}
}
namespace Teamcenter
{
namespace AppModel
{
class Mdl0BaselineRevisionImpl;
}
}
namespace Teamcenter
{
namespace AppModel
{
class Mdl0BaselineRevision;
}
}
namespace Teamcenter
{
namespace AppModel
{
class Mdl0BaselineRevisionGenImpl;
}
}
namespace Teamcenter_alias = ::Teamcenter;
class MDL0MODEL_API Teamcenter_alias::AppModel::Mdl0BaselineRevisionDelegate
{
public:
// Method to initialize this Class
static int initializeClass();
// Method to get the Mdl0BaselineRevisionDelegate instance
static Mdl0BaselineRevisionDelegate& getInstance();
// Method to create the Mdl0BaselineRevisionImpl pointer
static Mdl0BaselineRevisionImpl* createImpl( Mdl0BaselineRevision& ifObj );
// Method to delete the Mdl0BaselineRevisionImpl pointer
static void deleteImpl( Mdl0BaselineRevisionImpl* impl );
///
/// Getter for a Date 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 getMdl0SnapshotDateBase(const Mdl0BaselineRevision &ifObj, date_t &value, bool &isNull ) const;
///
/// Setter for a string Property
/// @version Teamcenter 11.5
/// @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 setMdl0ClosureBase(Mdl0BaselineRevision &ifObj, const std::string &value, bool isNull );
///
/// Removes the snapshot date from the baseline, returning it to configuration by latest history.
/// @version Teamcenter 11.1
/// @return - ifail error code.
///
int mdl0DeleteSnapshotDateBase(const Mdl0BaselineRevision &ifObj );
///
/// Sets the baseline to configure history at the specified date.
/// @version Teamcenter 11.1
/// @param date - Snapshot date.
/// @return - ifail error code.
///
int mdl0SetSnapshotDateBase(const Mdl0BaselineRevision &ifObj, date_t date );
///
/// desc for createPost
/// @version Tc 8
/// @param creInput - Description for the Create Input
/// @return - return desc for createPost
///
int createPostBase(const Mdl0BaselineRevision &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 Mdl0BaselineRevision &ifObj, ::Teamcenter::CreateInput *creInput );
///
/// Finalize operation input.
/// @version Teamcenter 10.1
/// @param pReviseInput - desc
/// @param vecDeepCopyData - desc
/// @return - returns n int.
///
int finalizeReviseInputBase(const Mdl0BaselineRevision &ifObj, ::Teamcenter::ReviseInput *pReviseInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData );
///
/// finalize operation input
/// @version Teamcenter 9
/// @param pSavAsInput - desc
/// @param vecDeepCopyData - desc
/// @return - returns an int
///
int finalizeSaveAsInputBase(const Mdl0BaselineRevision &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.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 object to be saved
/// @param bd - A data structure to store objects and other information relevant for set-based operation
/// @return -
///
int fnd0FinalizeSaveAsInputBase( 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
/// @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.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.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.3
/// @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 -
///
int fnd0SaveAsPostBase( 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 );
///
/// Generic revisePost operation.
/// @version Teamcenter 10.1
/// @param pReviseInput - Input ReviseInput object.
/// @param vecDeepCopyData - Vector of deep copy data.
/// @return - Returns an integer value.
///
int revisePostBase(const Mdl0BaselineRevision &ifObj, ::Teamcenter::ReviseInput *pReviseInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData );
///
/// 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 Mdl0BaselineRevision &ifObj, ::Teamcenter::SaveAsInput *pSavAsInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData );
protected:
// Pointer to the instance
static Mdl0BaselineRevisionDelegate* m_pInstance;
Mdl0BaselineRevisionDelegate();
virtual ~Mdl0BaselineRevisionDelegate();
static void setInstance( Mdl0BaselineRevisionDelegate* instance );
private:
friend class ::Teamcenter::AppModel::Mdl0BaselineRevisionGenImpl;
};
#include <mdl0model/libmdl0model_undef.h>
#endif // TEAMCENTER__APPMODEL__MDL0BASELINEREVISIONDELEGATE_HXX