//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, ValidationDataDelegate Filename: ValidationDataDelegate.hxx Module: validation @BMIDE autogenerated ==================================================================================================*/ #ifndef TEAMCENTER__VALIDATIONDATADELEGATE_HXX #define TEAMCENTER__VALIDATIONDATADELEGATE_HXX #include #include #include namespace Teamcenter { class ValidationDataDelegate; } namespace Teamcenter { class ValidationDataImpl; } namespace Teamcenter { class ValidationData; } namespace Teamcenter { class ValidationDataGenImpl; } namespace Teamcenter_alias = ::Teamcenter; class VALIDATION_API Teamcenter_alias::ValidationDataDelegate { public: // Method to initialize this Class static int initializeClass(); // Method to get the ValidationDataDelegate instance static ValidationDataDelegate& getInstance(); // Method to create the ValidationDataImpl pointer static ValidationDataImpl* createImpl( ValidationData& ifObj ); // Method to delete the ValidationDataImpl pointer static void deleteImpl( ValidationDataImpl* impl ); /// /// Getter for a Boolean 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 getKeep_overridden_resultBase(const ValidationData &ifObj, bool &value, bool &isNull ) const; /// /// Getter for a Boolean 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 getOverride_reason_mandatoryBase(const ValidationData &ifObj, bool &value, bool &isNull ) const; /// /// Getter for a string Property /// @version Teamcenter 8.2 /// @param value - Parameter value /// @param isNull - Returns true if the Parameter value is null /// @return - Status. 0 if successful /// int getValidation_applicationBase(const ValidationData &ifObj, std::string &value, bool &isNull ) const; /// /// Getter for an String Array Property /// @version Teamcenter 8.2 /// @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 getValidation_argumentsBase(const ValidationData &ifObj, std::vector< std::string > &values, std::vector< int > &isNull ) const; /// /// Getter for a Boolean Property /// @version Teamcenter 8.2 /// @param value - Parameter Value /// @param isNull - Returns true if the Parameter value is null /// @return - Status. 0 if successful /// int getValidation_can_groupBase(const ValidationData &ifObj, bool &value, bool &isNull ) const; /// /// Getter for a string Property /// @version Teamcenter 8.2 /// @param value - Parameter value /// @param isNull - Returns true if the Parameter value is null /// @return - Status. 0 if successful /// int getValidation_categoryBase(const ValidationData &ifObj, std::string &value, bool &isNull ) const; /// /// Getter for a Tag Property /// @version Teamcenter 8.2 /// @param value - Parameter value /// @param isNull - Returns true if the Parameter value is null /// @return - Status. 0 if successful /// int getValidation_closure_ruleBase(const ValidationData &ifObj, tag_t &value, bool &isNull ) const; /// /// Getter for a string Property /// @version Teamcenter 8.2 /// @param value - Parameter value /// @param isNull - Returns true if the Parameter value is null /// @return - Status. 0 if successful /// int getValidation_descriptionBase(const ValidationData &ifObj, std::string &value, bool &isNull ) const; /// /// Getter for a Tag Property /// @version Teamcenter 8.2 /// @param value - Parameter value /// @param isNull - Returns true if the Parameter value is null /// @return - Status. 0 if successful /// int getValidation_ext_ruleBase(const ValidationData &ifObj, tag_t &value, bool &isNull ) const; /// /// Getter for a string Property /// @version Teamcenter 8.2 /// @param value - Parameter value /// @param isNull - Returns true if the Parameter value is null /// @return - Status. 0 if successful /// int getValidation_nameBase(const ValidationData &ifObj, std::string &value, bool &isNull ) const; /// /// Getter for a Tag Property /// @version Teamcenter 8.2 /// @param value - Parameter value /// @param isNull - Returns true if the Parameter value is null /// @return - Status. 0 if successful /// int getValidation_parametersBase(const ValidationData &ifObj, tag_t &value, bool &isNull ) const; /// /// Getter for a Tag Property /// @version Teamcenter 8.2 /// @param value - Parameter value /// @param isNull - Returns true if the Parameter value is null /// @return - Status. 0 if successful /// int getValidation_requirementBase(const ValidationData &ifObj, tag_t &value, bool &isNull ) const; /// /// Getter for a string Property /// @version Teamcenter 8.2 /// @param value - Parameter value /// @param isNull - Returns true if the Parameter value is null /// @return - Status. 0 if successful /// int getValidation_utility_commandBase(const ValidationData &ifObj, std::string &value, bool &isNull ) const; /// /// Setter for a Boolean 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 setKeep_overridden_resultBase(ValidationData &ifObj, bool value, bool isNull ); /// /// Setter for a Boolean 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 setOverride_reason_mandatoryBase(ValidationData &ifObj, bool value, bool isNull ); /// /// Setter for a string Property /// @version Teamcenter 8.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 setValidation_applicationBase(ValidationData &ifObj, const std::string &value, bool isNull ); /// /// Setter for an string Array Property /// @version Teamcenter 8.2 /// @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 setValidation_argumentsBase(ValidationData &ifObj, const std::vector< std::string > &values, const std::vector< int > *isNull ); /// /// Setter for a Boolean Property /// @version Teamcenter 8.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 setValidation_can_groupBase(ValidationData &ifObj, bool value, bool isNull ); /// /// Setter for a string Property /// @version Teamcenter 8.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 setValidation_categoryBase(ValidationData &ifObj, const std::string &value, bool isNull ); /// /// Setter for a Tag Property /// @version Teamcenter 8.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 setValidation_closure_ruleBase(ValidationData &ifObj, const tag_t &value, bool isNull ); /// /// Setter for a string Property /// @version Teamcenter 8.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 setValidation_descriptionBase(ValidationData &ifObj, const std::string &value, bool isNull ); /// /// Setter for a Tag Property /// @version Teamcenter 8.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 setValidation_ext_ruleBase(ValidationData &ifObj, const tag_t &value, bool isNull ); /// /// Setter for a string Property /// @version Teamcenter 8.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 setValidation_nameBase(ValidationData &ifObj, const std::string &value, bool isNull ); /// /// Setter for a Tag Property /// @version Teamcenter 8.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 setValidation_parametersBase(ValidationData &ifObj, const tag_t &value, bool isNull ); /// /// Setter for a Tag Property /// @version Teamcenter 8.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 setValidation_requirementBase(ValidationData &ifObj, const tag_t &value, bool isNull ); /// /// Setter for a string Property /// @version Teamcenter 8.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 setValidation_utility_commandBase(ValidationData &ifObj, const std::string &value, bool isNull ); /// /// 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 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 validate for create /// @version Tc 8 /// @param creInput - desc for creInput parameter /// @return - ret desc for validate for create /// int validateCreateInputBase(const ValidationData &ifObj, ::Teamcenter::CreateInput *creInput ); protected: // Pointer to the instance static ValidationDataDelegate* m_pInstance; ValidationDataDelegate(); virtual ~ValidationDataDelegate(); static void setInstance( ValidationDataDelegate* instance ); private: friend class ::Teamcenter::ValidationDataGenImpl; }; #include #endif // TEAMCENTER__VALIDATIONDATADELEGATE_HXX