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.

300 lines
9.0 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, CompanyContact
Filename: CompanyContact.hxx
Module: tc
@BMIDE autogenerated
==================================================================================================*/
#ifndef TEAMCENTER__COMPANYCONTACT__HXX
#define TEAMCENTER__COMPANYCONTACT__HXX
#include <string>
#include <vector>
#include <common/tc_deprecation_macros.h>
#include <tccore/WorkspaceObject.hxx>
#include <tc/libtc_exports.h>
namespace Teamcenter
{
class CompanyContact;
}
namespace Teamcenter
{
class CompanyContactImpl;
}
namespace Teamcenter
{
class CompanyContactDelegate;
}
namespace Teamcenter
{
class CompanyContactDispatch;
}
namespace Teamcenter
{
class CompanyContactGenImpl;
}
namespace Teamcenter
{
class RootObjectImpl;
}
class TC_API Teamcenter::CompanyContact
: public ::Teamcenter::WorkspaceObject
{
public:
/**
* Get the Interface Name
* @return - return desc for getInterfaceName
*/
static const std::string& getInterfaceName();
///
/// 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 getEmail_address( std::string &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 getFax_number( std::string &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 getFirst_name( std::string &value, bool &isNull ) const;
///
/// Getter for a Tag Array Property
/// @version Teamcenter 11.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 getFnd0CompanyLocations( std::vector< tag_t > &values, std::vector< int > &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 getLast_name( std::string &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 getPager_number( std::string &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 getPhone_business( std::string &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 getPhone_home( std::string &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 getPhone_mobile( std::string &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 getSuffix( std::string &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 getTitle( std::string &value, bool &isNull ) const;
///
/// 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 setEmail_address( const std::string &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 setFax_number( const std::string &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 setFirst_name( const std::string &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 setLast_name( const std::string &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 setPager_number( const std::string &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 setPhone_business( const std::string &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 setPhone_home( const std::string &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 setPhone_mobile( const std::string &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 setSuffix( const std::string &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 setTitle( const std::string &value, bool isNull=false );
protected:
// Method to initialize
virtual void initialize( ::Teamcenter::RootObjectImpl* impl );
/**
* Constructor
*/
CompanyContact();
/**
* Destructor
*/
virtual ~CompanyContact();
private:
// Getter method for the Implementation Object
CompanyContactImpl* getCompanyContactImpl() const;
// Setter method for the Implementation Object
::Teamcenter::RootObjectImpl* setCompanyContactImpl( ::Teamcenter::RootObjectImpl* impl );
// Method to set the delete impl boolean
void setDeleteImpl( bool del );
// Pointer to the Implementation object
CompanyContactImpl* m_companycontactImpl;
// 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 CompanyContact - desc for CompanyContact parameter
*/
CompanyContact( const CompanyContact& );
CompanyContact& operator=( const CompanyContact& );
friend class CompanyContactDelegate;
friend class CompanyContactDispatch;
friend class CompanyContactGenImpl;
};
#include <tc/libtc_undef.h>
#endif // TEAMCENTER__COMPANYCONTACT__HXX