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.

544 lines
18 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, ValidationResultDelegate
Filename: ValidationResultDelegate.hxx
Module: validation
@BMIDE autogenerated
==================================================================================================*/
#ifndef TEAMCENTER__VALIDATIONRESULTDELEGATE_HXX
#define TEAMCENTER__VALIDATIONRESULTDELEGATE_HXX
#include <common/tc_deprecation_macros.h>
#include <validation/ValidationResult.hxx>
#include <validation/libvalidation_exports.h>
namespace Teamcenter
{
class ValidationResultDelegate;
}
namespace Teamcenter
{
class ValidationResultImpl;
}
namespace Teamcenter
{
class ValidationResult;
}
namespace Teamcenter
{
class ValidationResultGenImpl;
}
namespace Teamcenter_alias = ::Teamcenter;
class VALIDATION_API Teamcenter_alias::ValidationResultDelegate
{
public:
// Method to initialize this Class
static int initializeClass();
// Method to get the ValidationResultDelegate instance
static ValidationResultDelegate& getInstance();
// Method to create the ValidationResultImpl pointer
static ValidationResultImpl* createImpl( ValidationResult& ifObj );
// Method to delete the ValidationResultImpl pointer
static void deleteImpl( ValidationResultImpl* impl );
///
/// Getter for a Boolean Property
/// @version Teamcenter 8.3
/// @param value - Parameter Value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getFnd0_final_val_resultBase(const ValidationResult &ifObj, bool &value, bool &isNull ) const;
///
/// Getter for a Tag Property
/// @version Teamcenter 9.1
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getFnd0_owning_obj_of_resultBase(const ValidationResult &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 getFnd0_valdata_checker_nameBase(const ValidationResult &ifObj, std::string &value, bool &isNull ) const;
///
/// Getter for a Tag Property
/// @version Teamcenter 11.2
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getFnd0OwningObjectBase(const ValidationResult &ifObj, tag_t &value, bool &isNull ) const;
///
/// Getter for a string Property
/// @version Tc 8
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getObject_nameBase(const ValidationResult &ifObj, std::string &value, bool &isNull ) const;
///
/// Getter for a Tag 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_approval_dataBase(const ValidationResult &ifObj, tag_t &value, bool &isNull ) const;
///
/// 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 getOverride_categoryBase(const ValidationResult &ifObj, std::string &value, bool &isNull ) const;
///
/// 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 getOverride_decision_commentsBase(const ValidationResult &ifObj, std::string &value, bool &isNull ) const;
///
/// Getter for a Date 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_decision_dateBase(const ValidationResult &ifObj, date_t &value, bool &isNull ) const;
///
/// Getter for a Tag 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_decision_userBase(const ValidationResult &ifObj, tag_t &value, bool &isNull ) const;
///
/// 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 getOverride_reasonBase(const ValidationResult &ifObj, std::string &value, bool &isNull ) const;
///
/// 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 getOverride_reason_detailBase(const ValidationResult &ifObj, std::string &value, bool &isNull ) const;
///
/// Getter for a Date 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_request_dateBase(const ValidationResult &ifObj, date_t &value, bool &isNull ) const;
///
/// 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 getOverride_request_stateBase(const ValidationResult &ifObj, std::string &value, bool &isNull ) const;
///
/// Getter for a Tag 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_request_userBase(const ValidationResult &ifObj, tag_t &value, bool &isNull ) const;
///
/// 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 getOverride_to_stateBase(const ValidationResult &ifObj, std::string &value, bool &isNull ) const;
///
/// 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 getOverride_typeBase(const ValidationResult &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 getResult_state_flagBase(const ValidationResult &ifObj, int &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 getValdata_revisionBase(const ValidationResult &ifObj, tag_t &value, bool &isNull ) const;
///
/// Setter for a string Property
/// @version Teamcenter 10.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 setFnd0_valdata_checker_nameBase(ValidationResult &ifObj, const std::string &value, bool isNull );
///
/// Setter for a Tag Property
/// @version Teamcenter 11.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 setFnd0OwningObjectBase(ValidationResult &ifObj, const tag_t &value, bool isNull );
///
/// Setter for a string Property
/// @version Tc 8
/// @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 setObject_nameBase(ValidationResult &ifObj, const std::string &value, bool isNull );
///
/// Setter for a Tag 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_approval_dataBase(ValidationResult &ifObj, const tag_t &value, bool isNull );
///
/// Setter for a string 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_categoryBase(ValidationResult &ifObj, const std::string &value, bool isNull );
///
/// Setter for a string 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_decision_commentsBase(ValidationResult &ifObj, const std::string &value, bool isNull );
///
/// Setter for a Date 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_decision_dateBase(ValidationResult &ifObj, const date_t &value, bool isNull );
///
/// Setter for a Tag 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_decision_userBase(ValidationResult &ifObj, const tag_t &value, bool isNull );
///
/// Setter for a string 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_reasonBase(ValidationResult &ifObj, const std::string &value, bool isNull );
///
/// Setter for a string 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_detailBase(ValidationResult &ifObj, const std::string &value, bool isNull );
///
/// Setter for a Date 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_request_dateBase(ValidationResult &ifObj, const date_t &value, bool isNull );
///
/// Setter for a string 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_request_stateBase(ValidationResult &ifObj, const std::string &value, bool isNull );
///
/// Setter for a Tag 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_request_userBase(ValidationResult &ifObj, const tag_t &value, bool isNull );
///
/// Setter for a string 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_to_stateBase(ValidationResult &ifObj, const std::string &value, bool isNull );
///
/// Setter for a string 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_typeBase(ValidationResult &ifObj, const std::string &value, bool isNull );
///
/// 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 setResult_state_flagBase(ValidationResult &ifObj, int value, bool isNull );
///
/// Setter for a Tag Property
/// @version Tc 8
/// @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 setTarget_item_revBase(ValidationResult &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 setValdata_revisionBase(ValidationResult &ifObj, const tag_t &value, bool isNull );
///
/// Setter for a string Property
/// @version Teamcenter 10.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 setValidation_nameBase(ValidationResult &ifObj, const std::string &value, bool isNull );
///
/// perform deep copy
/// @version Teamcenter 9
/// @param pOperationInput - desc
/// @param vecDeepCopyData - deep copy data
/// @return - returns an int
///
int performDeepCopyBase(const ValidationResult &ifObj, ::Teamcenter::OperationInput *pOperationInput, 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.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 );
///
/// desc for createPost
/// @version Tc 8
/// @param creInput - Description for the Create Input
/// @return - return desc for createPost
///
int createPostBase(const ValidationResult &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 ValidationResult &ifObj, ::Teamcenter::SaveAsInput *pSavAsInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData );
///
/// desc for setPropertiesFromCreateInpu
/// @version Tc 8
/// @param creInput - Description for CreateInput
/// @return - return desc for setPropertiesFromCreateInput
///
int setPropertiesFromCreateInputBase(const ValidationResult &ifObj, ::Teamcenter::CreateInput *creInput );
///
/// setproperties from saveas input
/// @version Teamcenter 9
/// @param pSavAsInput - desc
/// @return - returns an int
///
int setPropertiesFromSaveAsInputBase(const ValidationResult &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 ValidationResult &ifObj, ::Teamcenter::CreateInput *creInput );
///
/// validate saveas input
/// @version Teamcenter 9
/// @param pSavAsInput - desc
/// @param vecDeepCopyData - desc
/// @return - returns an int
///
int validateSaveAsInputBase(const ValidationResult &ifObj, ::Teamcenter::SaveAsInput *pSavAsInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData );
protected:
// Pointer to the instance
static ValidationResultDelegate* m_pInstance;
ValidationResultDelegate();
virtual ~ValidationResultDelegate();
static void setInstance( ValidationResultDelegate* instance );
private:
friend class ::Teamcenter::ValidationResultGenImpl;
};
#include <validation/libvalidation_undef.h>
#endif // TEAMCENTER__VALIDATIONRESULTDELEGATE_HXX