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
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, IdentifierDelegate
|
|
Filename: IdentifierDelegate.hxx
|
|
Module: tccore
|
|
@BMIDE autogenerated
|
|
==================================================================================================*/
|
|
|
|
#ifndef TEAMCENTER__IDENTIFIERDELEGATE_HXX
|
|
#define TEAMCENTER__IDENTIFIERDELEGATE_HXX
|
|
|
|
#include <common/tc_deprecation_macros.h>
|
|
#include <tccore/Identifier.hxx>
|
|
|
|
#include <tccore/libtccore_exports.h>
|
|
|
|
namespace Teamcenter
|
|
{
|
|
class IdentifierDelegate;
|
|
}
|
|
namespace Teamcenter
|
|
{
|
|
class IdentifierImpl;
|
|
}
|
|
namespace Teamcenter
|
|
{
|
|
class Identifier;
|
|
}
|
|
namespace Teamcenter
|
|
{
|
|
class IdentifierGenImpl;
|
|
}
|
|
|
|
namespace Teamcenter_alias = ::Teamcenter;
|
|
|
|
|
|
class TCCORE_API Teamcenter_alias::IdentifierDelegate
|
|
{
|
|
public:
|
|
// Method to initialize this Class
|
|
static int initializeClass();
|
|
|
|
// Method to get the IdentifierDelegate instance
|
|
static IdentifierDelegate& getInstance();
|
|
|
|
// Method to create the IdentifierImpl pointer
|
|
static IdentifierImpl* createImpl( Identifier& ifObj );
|
|
|
|
// Method to delete the IdentifierImpl pointer
|
|
static void deleteImpl( IdentifierImpl* impl );
|
|
|
|
|
|
///
|
|
/// Finalize operation input.
|
|
/// @version Teamcenter 10.1
|
|
/// @param pReviseInput - desc
|
|
/// @param vecDeepCopyData - desc
|
|
/// @return - returns n int.
|
|
///
|
|
int finalizeReviseInputBase(const Identifier &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 );
|
|
|
|
|
|
///
|
|
/// operation for creating/setting values to shadow object during revise
|
|
/// @version Teamcenter 11.1
|
|
/// @param pReviseInput - Revise Input
|
|
/// @param newShObjTag - new shadow object created during revise
|
|
/// @return - returns status as int
|
|
///
|
|
int fnd0ReviseShadowObjectBase(const Identifier &ifObj, ::Teamcenter::ReviseInput *pReviseInput, tag_t *newShObjTag );
|
|
|
|
|
|
///
|
|
/// 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 );
|
|
|
|
|
|
///
|
|
/// Revise operation.
|
|
/// @version Teamcenter 10.1
|
|
/// @param pReviseInput - Revise input.
|
|
/// @param vecDeepCopyData - Vector of deep copy data.
|
|
/// @param newObjTag - Tag of the revised object.
|
|
/// @return - Returns an int.
|
|
///
|
|
int reviseBase(const Identifier &ifObj, ::Teamcenter::ReviseInput *pReviseInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData, tag_t *newObjTag );
|
|
|
|
|
|
///
|
|
/// 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 Identifier &ifObj, ::Teamcenter::ReviseInput *pReviseInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData );
|
|
|
|
|
|
///
|
|
/// Set properties from revise input.
|
|
/// @version Teamcenter 10.1
|
|
/// @param pReviseInput - desc
|
|
/// @return - Returns an int.
|
|
///
|
|
int setPropertiesFromReviseInputBase(const Identifier &ifObj, ::Teamcenter::ReviseInput *pReviseInput );
|
|
|
|
|
|
///
|
|
/// Validate revise input.
|
|
/// @version Teamcenter 10.1
|
|
/// @param pReviseInput - desc
|
|
/// @param vecDeepCopyData - desc
|
|
/// @return - Returns an int.
|
|
///
|
|
int validateReviseInputBase(const Identifier &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 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.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 fnd0SetPropertiesFromSaveAsInputBase( std::vector< ::Teamcenter::BulkInput* > *inputs, ::Teamcenter::BulkData *bd );
|
|
|
|
|
|
///
|
|
/// This operation deletes inputs objects in bulk. It either deletes none of the input objects or deletes all the input objects. It doesn't support partial deletion.
|
|
/// @version Teamcenter 11.6
|
|
/// @param inputs - A vector of data that contains reference to the object to be deleted.
|
|
/// @param bd - A data structure to store objects and other information relevant for set-based operation.
|
|
/// @return - Returns ITK_ok on Success. Otherwise, returns the specific error code.
|
|
///
|
|
int fnd0BulkDeleteBase( 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.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.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 );
|
|
|
|
|
|
///
|
|
/// desc for createPost
|
|
/// @version Tc 8
|
|
/// @param creInput - Description for the Create Input
|
|
/// @return - return desc for createPost
|
|
///
|
|
int createPostBase(const Identifier &ifObj, ::Teamcenter::CreateInput *creInput );
|
|
|
|
|
|
///
|
|
/// 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 Identifier &ifObj, ::Teamcenter::SaveAsInput *pSavAsInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData );
|
|
|
|
|
|
///
|
|
/// setproperties from saveas input
|
|
/// @version Teamcenter 9
|
|
/// @param pSavAsInput - desc
|
|
/// @return - returns an int
|
|
///
|
|
int setPropertiesFromSaveAsInputBase(const Identifier &ifObj, ::Teamcenter::SaveAsInput *pSavAsInput );
|
|
|
|
|
|
///
|
|
/// desc for validate for create
|
|
/// @version Tc 8
|
|
/// @param creInput - desc for creInput parameter
|
|
/// @return - ret desc for validate for create
|
|
///
|
|
int validateCreateInputBase(const Identifier &ifObj, ::Teamcenter::CreateInput *creInput );
|
|
|
|
|
|
|
|
protected:
|
|
// Pointer to the instance
|
|
static IdentifierDelegate* m_pInstance;
|
|
|
|
IdentifierDelegate();
|
|
virtual ~IdentifierDelegate();
|
|
static void setInstance( IdentifierDelegate* instance );
|
|
|
|
|
|
private:
|
|
friend class ::Teamcenter::IdentifierGenImpl;
|
|
|
|
};
|
|
|
|
#include <tccore/libtccore_undef.h>
|
|
#endif // TEAMCENTER__IDENTIFIERDELEGATE_HXX
|