ML_ITK/13/include_cpp/docmgt/IRDCNamingDelegate.hxx

//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, IRDCNamingDelegate
    Filename:   IRDCNamingDelegate.hxx
    Module:     docmgt
    @BMIDE autogenerated
==================================================================================================*/

#ifndef TEAMCENTER__IRDCNAMINGDELEGATE_HXX
#define TEAMCENTER__IRDCNAMINGDELEGATE_HXX

#include <common/tc_deprecation_macros.h>
#include <docmgt/IRDCNaming.hxx>

#include <docmgt/libdocmgt_exports.h>

namespace Teamcenter
{
    class IRDCNamingDelegate;
}
namespace Teamcenter
{
    class IRDCNamingImpl;
}
namespace Teamcenter
{
    class IRDCNaming;
}
namespace Teamcenter
{
    class IRDCNamingGenImpl;
}

namespace Teamcenter_alias = ::Teamcenter;


class  DOCMGT_API Teamcenter_alias::IRDCNamingDelegate
{
public:
    //  Method to initialize this Class
    static int initializeClass();

    //  Method to get the IRDCNamingDelegate instance
    static IRDCNamingDelegate&  getInstance();

    //  Method to create the IRDCNamingImpl pointer
    static IRDCNamingImpl*  createImpl( IRDCNaming&  ifObj );

    //  Method to delete the IRDCNamingImpl pointer
    static void deleteImpl( IRDCNamingImpl*  impl );


    ///
    /// 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  getAttr_for_nameBase(const IRDCNaming &ifObj,  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  getDefining_irdcBase(const IRDCNaming &ifObj,  std::string &value, bool &isNull ) const;


    ///
    /// Getter for an Integer Property
    /// @version Tc 8
    /// @param value - Parameter Value
    /// @param isNull - Returns true if the Parameter value is null
    /// @return - Status. 0 if successful
    ///
    int  getNum_charsBase(const IRDCNaming &ifObj,  int &value, bool &isNull ) const;


    ///
    /// Getter for an Integer Property
    /// @version Tc 8
    /// @param value - Parameter Value
    /// @param isNull - Returns true if the Parameter value is null
    /// @return - Status. 0 if successful
    ///
    int  getStarting_charBase(const IRDCNaming &ifObj,  int &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  getText_for_nameBase(const IRDCNaming &ifObj,  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  setAttr_for_nameBase(IRDCNaming &ifObj,  const std::string &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  setDefining_irdcBase(IRDCNaming &ifObj,  const std::string &value, bool isNull );


    ///
    /// Setter for an Integer 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  setNum_charsBase(IRDCNaming &ifObj,  int value, bool isNull );


    ///
    /// Setter for an Integer 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  setStarting_charBase(IRDCNaming &ifObj,  int 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  setText_for_nameBase(IRDCNaming &ifObj,  const std::string &value, bool isNull );



protected:
    //  Pointer to the instance
    static IRDCNamingDelegate*  m_pInstance;

    IRDCNamingDelegate();
    virtual ~IRDCNamingDelegate();
    static void setInstance( IRDCNamingDelegate*  instance );


private:
    friend class  ::Teamcenter::IRDCNamingGenImpl;

};

#include <docmgt/libdocmgt_undef.h>
#endif  //  TEAMCENTER__IRDCNAMINGDELEGATE_HXX