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.
ML_ITK/13/include_cpp/ps/Fnd0AbstractOccRevisionDele...

396 lines
16 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, Fnd0AbstractOccRevisionDelegate
Filename: Fnd0AbstractOccRevisionDelegate.hxx
Module: ps
@BMIDE autogenerated
==================================================================================================*/
#ifndef TEAMCENTER__FND0ABSTRACTOCCREVISIONDELEGATE_HXX
#define TEAMCENTER__FND0ABSTRACTOCCREVISIONDELEGATE_HXX
#include <common/tc_deprecation_macros.h>
#include <ps/Fnd0AbstractOccRevision.hxx>
#include <ps/libps_exports.h>
namespace Teamcenter
{
class Fnd0AbstractOccRevisionDelegate;
}
namespace Teamcenter
{
class Fnd0AbstractOccRevisionImpl;
}
namespace Teamcenter
{
class Fnd0AbstractOccRevision;
}
namespace Teamcenter
{
class Fnd0AbstractOccRevisionGenImpl;
}
namespace Teamcenter_alias = ::Teamcenter;
class PS_API Teamcenter_alias::Fnd0AbstractOccRevisionDelegate
{
public:
// Method to initialize this Class
static int initializeClass();
// Method to get the Fnd0AbstractOccRevisionDelegate instance
static Fnd0AbstractOccRevisionDelegate& getInstance();
// Method to create the Fnd0AbstractOccRevisionImpl pointer
static Fnd0AbstractOccRevisionImpl* createImpl( Fnd0AbstractOccRevision& ifObj );
// Method to delete the Fnd0AbstractOccRevisionImpl pointer
static void deleteImpl( Fnd0AbstractOccRevisionImpl* impl );
///
/// Getter for a string Property
/// @version Teamcenter 13.1
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getFnd0EffectivityFormulaBase(const Fnd0AbstractOccRevision &ifObj, std::string &value, bool &isNull ) const;
///
/// Getter for Property Display Value
/// @version Teamcenter 13.1
/// @param values - Parameter value
/// @return - Status. 0 if successful
///
int getFnd0EffectivityFormulaDisplayableValuesBase(Fnd0AbstractOccRevision &ifObj, std::vector< std::string > &values );
///
/// Operation to get PSOccurrence from Fnd0AbstractOccRevision
/// @version Teamcenter 12.2
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getFnd0PsOccBase(const Fnd0AbstractOccRevision &ifObj, tag_t &value, bool &isNull ) const;
///
/// Setter for a string Property
/// @version Teamcenter 13.1
/// @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 setFnd0EffectivityFormulaBase(Fnd0AbstractOccRevision &ifObj, const std::string &value, bool isNull );
///
/// Operation to set PSOccurrence on Fnd0AbstractOccRevision
/// @version Teamcenter 12.2
/// @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 setFnd0PsOccBase(Fnd0AbstractOccRevision &ifObj, const tag_t &value, bool isNull );
///
/// Finalize Revise Input Operation
/// @version Teamcenter 12.2
/// @param pReviseInput - Revise input
/// @param vecDeepCopyData - Deep Copy Data Vector
/// @return - Failure Code
///
int finalizeReviseInputBase(const Fnd0AbstractOccRevision &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 12.2
/// @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 );
///
/// Operation to replace the child item or item revision and child BOMView for Fnd0AbstractOccRevision.
/// @version Teamcenter 12.4
/// @param childItemOrItemRev - The child item or item revision that you want to replace with.
/// @param childBomView - The Child BOM View that you want to replace with.
/// @return -
///
int fnd0ReplaceOccurrenceBase(const Fnd0AbstractOccRevision &ifObj, tag_t childItemOrItemRev, tag_t childBomView );
///
/// This operation is not supported now, there will be no support for issues stemming from uses of this operation.
/// @version Teamcenter 12.2
/// @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 12.2
/// @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 12.2
/// @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 12.2
/// @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 );
///
/// Fnd0AbstractOccRevision Revise Operation
/// @version Teamcenter 12.2
/// @param pReviseInput - Revise Input
/// @param vecDeepCopyData - Deep Copy Data Vactor
/// @param newObjTag - New Object tag
/// @return - Failure Code
///
int reviseBase(const Fnd0AbstractOccRevision &ifObj, ::Teamcenter::ReviseInput *pReviseInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData, tag_t *newObjTag );
///
/// Reivse post operation
/// @version Teamcenter 12.2
/// @param pReviseInput - Revise Input Descriptor
/// @param vecDeepCopyData - Deep Copy Data Vector
/// @return - Failure Code
///
int revisePostBase(const Fnd0AbstractOccRevision &ifObj, ::Teamcenter::ReviseInput *pReviseInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData );
///
/// Set properties from revise input Operation
/// @version Teamcenter 12.2
/// @param pReviseInput - Revise Input Descriptor
/// @return - Failure code
///
int setPropertiesFromReviseInputBase(const Fnd0AbstractOccRevision &ifObj, ::Teamcenter::ReviseInput *pReviseInput );
///
/// Validate Revise Input Operation
/// @version Teamcenter 12.2
/// @param pReviseInput - Revise Input Descriptor
/// @param vecDeepCopyData - Deep Copy Data Vector
/// @return - Failure Code
///
int validateReviseInputBase(const Fnd0AbstractOccRevision &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 Fnd0AbstractOccRevision &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 Fnd0AbstractOccRevision &ifObj, ::Teamcenter::CreateInput *creInput );
///
/// finalize operation input
/// @version Teamcenter 9
/// @param pSavAsInput - desc
/// @param vecDeepCopyData - desc
/// @return - returns an int
///
int finalizeSaveAsInputBase(const Fnd0AbstractOccRevision &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.4
/// @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 fnd0CreatePostBase( 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.4
/// @param inputs - A vector of data that contains reference information to the object to be created
/// @param bd - A data structure to store objects and other information relevant for set-based operation
/// @return -
///
int fnd0FinalizeCreateInputBase( 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.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 fnd0PerformDeepCopyBase( 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 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 );
///
/// This operation is not supported now, there will be no support for issues stemming from uses of this operation.
/// @version Teamcenter 11.4
/// @param inputs - A vector of data that contains reference information to the object to be created
/// @param bd - A data structure to store objects and other information relevant for set-based operation
/// @return -
///
int fnd0ValidateCreateInputBase( 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 fnd0ValidateSaveAsInputBase( std::vector< ::Teamcenter::BulkInput* > *inputs, ::Teamcenter::BulkData *bd );
///
/// perform deep copy
/// @version Teamcenter 9
/// @param pOperationInput - desc
/// @param vecDeepCopyData - deep copy data
/// @return - returns an int
///
int performDeepCopyBase(const Fnd0AbstractOccRevision &ifObj, ::Teamcenter::OperationInput *pOperationInput, 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 Fnd0AbstractOccRevision &ifObj, ::Teamcenter::CreateInput *creInput );
///
/// validate saveas input
/// @version Teamcenter 9
/// @param pSavAsInput - desc
/// @param vecDeepCopyData - desc
/// @return - returns an int
///
int validateSaveAsInputBase(const Fnd0AbstractOccRevision &ifObj, ::Teamcenter::SaveAsInput *pSavAsInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData );
protected:
// Pointer to the instance
static Fnd0AbstractOccRevisionDelegate* m_pInstance;
Fnd0AbstractOccRevisionDelegate();
virtual ~Fnd0AbstractOccRevisionDelegate();
static void setInstance( Fnd0AbstractOccRevisionDelegate* instance );
private:
friend class ::Teamcenter::Fnd0AbstractOccRevisionGenImpl;
};
#include <ps/libps_undef.h>
#endif // TEAMCENTER__FND0ABSTRACTOCCREVISIONDELEGATE_HXX