//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, DatasetDelegate Filename: DatasetDelegate.hxx Module: ae @BMIDE autogenerated ==================================================================================================*/ #ifndef TEAMCENTER__DATASETDELEGATE_HXX #define TEAMCENTER__DATASETDELEGATE_HXX #include #include #include namespace Teamcenter { class DatasetDelegate; } namespace Teamcenter { class DatasetImpl; } namespace Teamcenter { class Dataset; } namespace Teamcenter { class DatasetGenImpl; } namespace Teamcenter_alias = ::Teamcenter; class AE_API Teamcenter_alias::DatasetDelegate { public: // Method to initialize this Class static int initializeClass(); // Method to get the DatasetDelegate instance static DatasetDelegate& getInstance(); // Method to create the DatasetImpl pointer static DatasetImpl* createImpl( Dataset& ifObj ); // Method to delete the DatasetImpl pointer static void deleteImpl( DatasetImpl* impl ); /// /// Getter for a Tag Property /// @version Teamcenter 8.0.1 /// @param value - Parameter value /// @param isNull - Returns true if the Parameter value is null /// @return - Status. 0 if successful /// int getDataset_typeBase(const Dataset &ifObj, tag_t &value, bool &isNull ) const; /// /// Getter for a Tag Array Property /// @version Teamcenter 10 /// @param values - Parameter value /// @param isNull - Returns true for an array element if the parameter value at that location is null /// @return - Status. 0 if successful /// int getFnd0FileAccessAuditLogsBase(const Dataset &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const; /// /// Getter for a Boolean 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 getFnd0IsCheckOutForSignBase(const Dataset &ifObj, bool &value, bool &isNull ) const; /// /// Getter for a string Property /// @version Teamcenter 8.0.1 /// @param value - Parameter value /// @param isNull - Returns true if the Parameter value is null /// @return - Status. 0 if successful /// int getFormat_usedBase(const Dataset &ifObj, std::string &value, bool &isNull ) const; /// /// Getter for a Tag Array Property /// @version Teamcenter 8.0.1 /// @param values - Parameter value /// @param isNull - Returns true for an array element if the parameter value at that location is null /// @return - Status. 0 if successful /// int getRef_listBase(const Dataset &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const; /// /// Getter for an String Array Property /// @version Teamcenter 8.0.1 /// @param values - Parameter value /// @param isNull - Returns true for an array element if the parameter value at that location is null /// @return - Status. 0 if successful /// int getRef_namesBase(const Dataset &ifObj, std::vector< std::string > &values, std::vector< int > &isNull ) const; /// /// Getter for an Integer Array Property /// @version Teamcenter 8.0.1 /// @param values - Parameter value /// @param isNull - Returns true for an array element if the parameter value at that location is null /// @return - Status. 0 if successful /// int getRef_typesBase(const Dataset &ifObj, std::vector< int > &values, std::vector< int > &isNull ) const; /// /// Getter for a Tag Property /// @version Teamcenter 8.0.1 /// @param value - Parameter value /// @param isNull - Returns true if the Parameter value is null /// @return - Status. 0 if successful /// int getRev_chain_anchorBase(const Dataset &ifObj, tag_t &value, bool &isNull ) const; /// /// Getter for a Tag Property /// @version Teamcenter 8.0.1 /// @param value - Parameter value /// @param isNull - Returns true if the Parameter value is null /// @return - Status. 0 if successful /// int getTool_usedBase(const Dataset &ifObj, tag_t &value, bool &isNull ) const; /// /// Getter for a string Property /// @version Teamcenter 8.0.1 /// @param value - Parameter value /// @param isNull - Returns true if the Parameter value is null /// @return - Status. 0 if successful /// int getUser_classBase(const Dataset &ifObj, std::string &value, bool &isNull ) const; /// /// Setter for a Tag Property /// @version Teamcenter 8.0.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 setDataset_typeBase(Dataset &ifObj, const tag_t &value, bool isNull ); /// /// Setter for a string Property /// @version Teamcenter 8.0.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 setFormat_usedBase(Dataset &ifObj, const std::string &value, bool isNull ); /// /// Setter for a Tag Array Property /// @version Teamcenter 8.0.1 /// @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 setRef_listBase(Dataset &ifObj, const std::vector< tag_t > &values, const std::vector< int > *isNull ); /// /// Setter for an string Array Property /// @version Teamcenter 8.0.1 /// @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 setRef_namesBase(Dataset &ifObj, const std::vector< std::string > &values, const std::vector< int > *isNull ); /// /// Setter for an Integer Array Property /// @version Teamcenter 8.0.1 /// @param values - Values to be set for the paramter /// @param isNull - If array element is true, set the parameter value at that location as null /// @return - Status. 0 if successful /// int setRef_typesBase(Dataset &ifObj, const std::vector< int > &values, const std::vector< int > *isNull ); /// /// Setter for a Tag Property /// @version Teamcenter 8.0.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 setRev_chain_anchorBase(Dataset &ifObj, const tag_t &value, bool isNull ); /// /// Setter for a Tag Property /// @version Teamcenter 8.0.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 setTool_usedBase(Dataset &ifObj, const tag_t &value, bool isNull ); /// /// Setter for a string Property /// @version Teamcenter 8.0.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 setUser_classBase(Dataset &ifObj, const std::string &value, bool isNull ); /// /// This operation saves the datasets without creating new dataset version. /// @version Teamcenter 13.1 /// @param input - 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 if there is no error; otherwise, any error caught during the operation. /// int fnd0SaveMyselfBase( std::vector< ::Teamcenter::BulkInput* > *input, ::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 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.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.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 ); /// /// 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 Dataset &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 Dataset &ifObj, ::Teamcenter::CreateInput *creInput ); /// /// finalize operation input /// @version Teamcenter 9 /// @param pSavAsInput - desc /// @param vecDeepCopyData - desc /// @return - returns an int /// int finalizeSaveAsInputBase(const Dataset &ifObj, ::Teamcenter::SaveAsInput *pSavAsInput, 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 Dataset &ifObj, ::Teamcenter::SaveAsInput *pSavAsInput, 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 Dataset &ifObj, ::Teamcenter::CreateInput *creInput ); /// /// validate saveas input /// @version Teamcenter 9 /// @param pSavAsInput - desc /// @param vecDeepCopyData - desc /// @return - returns an int /// int validateSaveAsInputBase(const Dataset &ifObj, ::Teamcenter::SaveAsInput *pSavAsInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData ); /// /// Getter for a string Property /// @version Teamcenter 8.1 /// @param value - Parameter value /// @param isNull - Returns true if the Parameter value is null /// @return - Status. 0 if successful /// int getObject_typeBase(const Dataset &ifObj, std::string &value, bool &isNull ) const; /// /// Getter for an Integer Property /// @version Teamcenter 8.1 /// @param value - Parameter Value /// @param isNull - Returns true if the Parameter value is null /// @return - Status. 0 if successful /// int getRevision_limitBase(const Dataset &ifObj, int &value, bool &isNull ) const; /// /// Setter for an Integer Property /// @version Teamcenter 8.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 setRevision_limitBase(Dataset &ifObj, int value, bool isNull ); protected: // Pointer to the instance static DatasetDelegate* m_pInstance; DatasetDelegate(); virtual ~DatasetDelegate(); static void setInstance( DatasetDelegate* instance ); private: friend class ::Teamcenter::DatasetGenImpl; }; #include #endif // TEAMCENTER__DATASETDELEGATE_HXX