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.

283 lines
9.2 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, Cdm0CorspondenceRevision
Filename: Cdm0CorspondenceRevision.hxx
Module: cdm0contractmanagement
@BMIDE autogenerated
==================================================================================================*/
#ifndef CDM0CONTRACTMANAGEMENT__CDM0CORSPONDENCEREVISION__HXX
#define CDM0CONTRACTMANAGEMENT__CDM0CORSPONDENCEREVISION__HXX
#include <string>
#include <vector>
#include <unidefs.h>
#include <common/tc_deprecation_macros.h>
#include <tccore/DocumentRevision.hxx>
#include <cdm0contractmanagement/libcdm0contractmanagement_exports.h>
namespace cdm0contractmanagement
{
class Cdm0CorspondenceRevision;
}
namespace cdm0contractmanagement
{
class Cdm0CorspondenceRevisionImpl;
}
namespace cdm0contractmanagement
{
class Cdm0CorspondenceRevisionDelegate;
}
namespace cdm0contractmanagement
{
class Cdm0CorspondenceRevisionDispatch;
}
namespace cdm0contractmanagement
{
class Cdm0CorspondenceRevisionGenImpl;
}
namespace Teamcenter
{
class RootObjectImpl;
}
class CDM0CONTRACTMANAGEMENT_API cdm0contractmanagement::Cdm0CorspondenceRevision
: public ::Teamcenter::DocumentRevision
{
public:
/**
* Get the Interface Name
* @return - return desc for getInterfaceName
*/
static const std::string& getInterfaceName();
///
/// Getter for a string 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 getCdm0Category( std::string &value, bool &isNull ) const;
///
/// Getter for a string 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 getCdm0CorrespondenceDirection( std::string &value, bool &isNull ) const;
///
/// Getter for a Tag Array Property
/// @version Teamcenter 8.3
/// @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 getCdm0CorrespondHasSubmittal( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
///
/// Getter for a string 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 getCdm0Priority( std::string &value, bool &isNull ) const;
///
/// Getter for a string 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 getCdm0ReceivedOrgName( std::string &value, bool &isNull ) const;
///
/// Getter for a Date 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 getCdm0ReceivedorSentDate( date_t &value, bool &isNull ) const;
///
/// Getter for a string 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 getCdm0References( std::string &value, bool &isNull ) const;
///
/// Getter for a Date 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 getCdm0ReplyRequestedDate( date_t &value, bool &isNull ) const;
///
/// 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 getCdm0ReplyRequired( bool &value, bool &isNull ) const;
///
/// Getter for a string 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 getCdm0ResponsibleParty( std::string &value, bool &isNull ) const;
///
/// Setter for a string Property
/// @version Teamcenter 8.3
/// @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 setCdm0Category( const std::string &value, bool isNull=false );
///
/// Setter for a string Property
/// @version Teamcenter 8.3
/// @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 setCdm0CorrespondenceDirection( const std::string &value, bool isNull=false );
///
/// Setter for a string Property
/// @version Teamcenter 8.3
/// @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 setCdm0Priority( const std::string &value, bool isNull=false );
///
/// Setter for a string Property
/// @version Teamcenter 8.3
/// @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 setCdm0ReceivedOrgName( const std::string &value, bool isNull=false );
///
/// Setter for a Date Property
/// @version Teamcenter 8.3
/// @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 setCdm0ReceivedorSentDate( const date_t &value, bool isNull=false );
///
/// Setter for a string Property
/// @version Teamcenter 8.3
/// @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 setCdm0References( const std::string &value, bool isNull=false );
///
/// Setter for a Date Property
/// @version Teamcenter 8.3
/// @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 setCdm0ReplyRequestedDate( const date_t &value, bool isNull=false );
///
/// Setter for a Boolean Property
/// @version Teamcenter 8.3
/// @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 setCdm0ReplyRequired( bool value, bool isNull=false );
///
/// Setter for a string Property
/// @version Teamcenter 8.3
/// @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 setCdm0ResponsibleParty( const std::string &value, bool isNull=false );
protected:
// Method to initialize
virtual void initialize( ::Teamcenter::RootObjectImpl* impl );
/**
* Constructor
*/
Cdm0CorspondenceRevision();
/**
* Destructor
*/
virtual ~Cdm0CorspondenceRevision();
private:
// Getter method for the Implementation Object
Cdm0CorspondenceRevisionImpl* getCdm0CorspondenceRevisionImpl() const;
// Setter method for the Implementation Object
::Teamcenter::RootObjectImpl* setCdm0CorspondenceRevisionImpl( ::Teamcenter::RootObjectImpl* impl );
// Method to set the delete impl boolean
void setDeleteImpl( bool del );
// Pointer to the Implementation object
Cdm0CorspondenceRevisionImpl* m_cdm0corspondencerevisionImpl;
// 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 Cdm0CorspondenceRevision - desc for Cdm0CorspondenceRevision parameter
*/
Cdm0CorspondenceRevision( const Cdm0CorspondenceRevision& );
Cdm0CorspondenceRevision& operator=( const Cdm0CorspondenceRevision& );
friend class Cdm0CorspondenceRevisionDelegate;
friend class Cdm0CorspondenceRevisionDispatch;
friend class Cdm0CorspondenceRevisionGenImpl;
};
#include <cdm0contractmanagement/libcdm0contractmanagement_undef.h>
#endif // CDM0CONTRACTMANAGEMENT__CDM0CORSPONDENCEREVISION__HXX