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.

238 lines
7.7 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, Lis0ProviderCatalog
Filename: Lis0ProviderCatalog.hxx
Module: Lis0lisfmwrk
@BMIDE autogenerated
==================================================================================================*/
#ifndef LIS0LISFMWRK__LIS0PROVIDERCATALOG__HXX
#define LIS0LISFMWRK__LIS0PROVIDERCATALOG__HXX
#include <string>
#include <vector>
#include <unidefs.h>
#include <common/tc_deprecation_macros.h>
#include <Lis0lisfmwrk/Lis0Resource.hxx>
#include <Lis0lisfmwrk/liblis0lisfmwrk_exports.h>
namespace lis0lisfmwrk
{
class Lis0ProviderCatalog;
}
namespace lis0lisfmwrk
{
class Lis0ProviderCatalogImpl;
}
namespace lis0lisfmwrk
{
class Lis0ProviderCatalogDelegate;
}
namespace lis0lisfmwrk
{
class Lis0ProviderCatalogDispatch;
}
namespace lis0lisfmwrk
{
class Lis0ProviderCatalogGenImpl;
}
namespace Teamcenter
{
class RootObjectImpl;
}
class LIS0LISFMWRK_API lis0lisfmwrk::Lis0ProviderCatalog
: public ::lis0lisfmwrk::Lis0Resource
{
public:
/**
* Get the Interface Name
* @return - return desc for getInterfaceName
*/
static const std::string& getInterfaceName();
///
/// Getter for a string Property
/// @version Teamcenter 10.1.4
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getLis0catalogSpecVersion( std::string &value, bool &isNull ) const;
///
/// Getter for a string Property
/// @version Teamcenter 10.1.4
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getLis0domainNamespace( std::string &value, bool &isNull ) const;
///
/// Getter for a string Property
/// @version Teamcenter 10.1.4
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getLis0domainNamespacePrefix( std::string &value, bool &isNull ) const;
///
/// Getter for a Tag Array Property
/// @version Teamcenter 10.1.4
/// @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 getLis0excludedTypes( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
///
/// Getter for a Tag Array Property
/// @version Teamcenter 10.1.4
/// @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 getLis0includedTypes( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
///
/// Getter for a Tag Property
/// @version Teamcenter 10.1.4
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getLis0protocol( tag_t &value, bool &isNull ) const;
///
/// Getter for a string Property
/// @version Teamcenter 10.1.4
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getLis0publisher( std::string &value, bool &isNull ) const;
///
/// Setter for a string Property
/// @version Teamcenter 10.1.4
/// @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 setLis0catalogSpecVersion( const std::string &value, bool isNull=false );
///
/// Setter for a string Property
/// @version Teamcenter 10.1.4
/// @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 setLis0domainNamespace( const std::string &value, bool isNull=false );
///
/// Setter for a string Property
/// @version Teamcenter 10.1.4
/// @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 setLis0domainNamespacePrefix( const std::string &value, bool isNull=false );
///
/// Setter for a Tag Array Property
/// @version Teamcenter 10.1.4
/// @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 setLis0excludedTypes( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
///
/// Setter for a Tag Array Property
/// @version Teamcenter 10.1.4
/// @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 setLis0includedTypes( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
///
/// Setter for a Tag Property
/// @version Teamcenter 10.1.4
/// @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 setLis0protocol( const tag_t &value, bool isNull=false );
///
/// Setter for a string Property
/// @version Teamcenter 10.1.4
/// @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 setLis0publisher( const std::string &value, bool isNull=false );
protected:
// Method to initialize
virtual void initialize( ::Teamcenter::RootObjectImpl* impl );
/**
* Constructor
*/
Lis0ProviderCatalog();
/**
* Destructor
*/
virtual ~Lis0ProviderCatalog();
private:
// Getter method for the Implementation Object
Lis0ProviderCatalogImpl* getLis0ProviderCatalogImpl() const;
// Setter method for the Implementation Object
::Teamcenter::RootObjectImpl* setLis0ProviderCatalogImpl( ::Teamcenter::RootObjectImpl* impl );
// Method to set the delete impl boolean
void setDeleteImpl( bool del );
// Pointer to the Implementation object
Lis0ProviderCatalogImpl* m_lis0providercatalogImpl;
// 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 Lis0ProviderCatalog - desc for Lis0ProviderCatalog parameter
*/
Lis0ProviderCatalog( const Lis0ProviderCatalog& );
Lis0ProviderCatalog& operator=( const Lis0ProviderCatalog& );
friend class Lis0ProviderCatalogDelegate;
friend class Lis0ProviderCatalogDispatch;
friend class Lis0ProviderCatalogGenImpl;
};
#include <Lis0lisfmwrk/liblis0lisfmwrk_undef.h>
#endif // LIS0LISFMWRK__LIS0PROVIDERCATALOG__HXX