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.

453 lines
15 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, ValidationResult
Filename: ValidationResult.hxx
Module: validation
@BMIDE autogenerated
==================================================================================================*/
#ifndef TEAMCENTER__VALIDATIONRESULT__HXX
#define TEAMCENTER__VALIDATIONRESULT__HXX
#include <unidefs.h>
#include <string>
#include <common/tc_deprecation_macros.h>
#include <tccore/POM_object.hxx>
#include <validation/libvalidation_exports.h>
namespace Teamcenter
{
class ValidationResult;
}
namespace Teamcenter
{
class ValidationResultImpl;
}
namespace Teamcenter
{
class ValidationResultDelegate;
}
namespace Teamcenter
{
class ValidationResultDispatch;
}
namespace Teamcenter
{
class ValidationResultGenImpl;
}
namespace Teamcenter
{
class RootObjectImpl;
}
class VALIDATION_API Teamcenter::ValidationResult
: public ::Teamcenter::POM_object
{
public:
/**
* Get the Interface Name
* @return - return desc for getInterfaceName
*/
static const std::string& getInterfaceName();
///
/// 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_result( 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_result( 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_name( 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 getFnd0OwningObject( 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_name( 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_data( 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_category( 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_comments( 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_date( 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_user( 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_reason( 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_detail( 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_date( 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_state( 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_user( 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_state( 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_type( 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_flag( 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_revision( 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_name( const std::string &value, bool isNull=false );
///
/// 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 setFnd0OwningObject( const tag_t &value, bool isNull=false );
///
/// 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_name( const std::string &value, bool isNull=false );
///
/// 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_data( const tag_t &value, bool isNull=false );
///
/// 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_category( const std::string &value, bool isNull=false );
///
/// 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_comments( const std::string &value, bool isNull=false );
///
/// 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_date( const date_t &value, bool isNull=false );
///
/// 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_user( const tag_t &value, bool isNull=false );
///
/// 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( const std::string &value, bool isNull=false );
///
/// 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_detail( const std::string &value, bool isNull=false );
///
/// 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_date( const date_t &value, bool isNull=false );
///
/// 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_state( const std::string &value, bool isNull=false );
///
/// 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_user( const tag_t &value, bool isNull=false );
///
/// 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_state( const std::string &value, bool isNull=false );
///
/// 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_type( const std::string &value, bool isNull=false );
///
/// 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_flag( int value, bool isNull=false );
///
/// 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_rev( const tag_t &value, bool isNull=false );
///
/// 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_revision( const tag_t &value, bool isNull=false );
///
/// 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_name( const std::string &value, bool isNull=false );
protected:
// Method to initialize
virtual void initialize( ::Teamcenter::RootObjectImpl* impl );
/**
* Constructor
*/
ValidationResult();
/**
* Destructor
*/
virtual ~ValidationResult();
private:
// Getter method for the Implementation Object
ValidationResultImpl* getValidationResultImpl() const;
// Setter method for the Implementation Object
::Teamcenter::RootObjectImpl* setValidationResultImpl( ::Teamcenter::RootObjectImpl* impl );
// Method to set the delete impl boolean
void setDeleteImpl( bool del );
// Pointer to the Implementation object
ValidationResultImpl* m_validationresultImpl;
// Flag to indicate if Implementation object needs to be deleted
bool m_deleteImpl;
/**
* Name of the Business Object
*/
static std::string name;
/**
* Private default constructor. We do not want this class instantiated without the business object passed in.
* @param ValidationResult - desc for ValidationResult parameter
*/
ValidationResult( const ValidationResult& );
ValidationResult& operator=( const ValidationResult& );
friend class ValidationResultDelegate;
friend class ValidationResultDispatch;
friend class ValidationResultGenImpl;
};
#include <validation/libvalidation_undef.h>
#endif // TEAMCENTER__VALIDATIONRESULT__HXX