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

#ifndef TEAMCENTER__FND0LOGICALOBJECTTYPE__HXX
#define TEAMCENTER__FND0LOGICALOBJECTTYPE__HXX

#include <string>
#include <vector>
#include <common/tc_deprecation_macros.h>
#include <tccore/ImanType.hxx>

#include <tccore/libtccore_exports.h>

namespace Teamcenter
{
    class Fnd0LogicalObjectType;
}
namespace Teamcenter
{
    class Fnd0LogicalObjectTypeImpl;
}
namespace Teamcenter
{
    class Fnd0LogicalObjectTypeDelegate;
}
namespace Teamcenter
{
    class Fnd0LogicalObjectTypeDispatch;
}
namespace Teamcenter
{
    class Fnd0LogicalObjectTypeGenImpl;
}
namespace Teamcenter
{
    class RootObjectImpl;
}

class  TCCORE_API  Teamcenter::Fnd0LogicalObjectType
     : public  ::Teamcenter::ImanType
{
public:

    /**
     * Get the Interface Name
     * @return - return desc for getInterfaceName
     */
    static const std::string&  getInterfaceName();


    ///
    /// Getter for a string Property
    /// @version Teamcenter 11.5
    /// @param value - Parameter value
    /// @param isNull - Returns true if the Parameter value is null
    /// @return - Status. 0 if successful
    ///
    int  getFnd0DisplayName( std::string &value, bool &isNull ) const;

    ///
    /// Getter for a Tag Array Property
    /// @version Teamcenter 11.6
    /// @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  getFnd0IncludedLogicalObjects( std::vector< tag_t > &values, std::vector< int > &isNull ) const;

    ///
    /// Getter for a Tag Array Property
    /// @version Teamcenter 11.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  getFnd0Members( std::vector< tag_t > &values, std::vector< int > &isNull ) const;

    ///
    /// Getter for a string Property
    /// @version Teamcenter 11.5
    /// @param value - Parameter value
    /// @param isNull - Returns true if the Parameter value is null
    /// @return - Status. 0 if successful
    ///
    int  getFnd0ObjectStringExpression( std::string &value, bool &isNull ) const;

    ///
    /// Getter for a Tag Array Property
    /// @version Teamcenter 11.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  getFnd0PresentedProperties( std::vector< tag_t > &values, std::vector< int > &isNull ) const;

    ///
    /// Getter for a string Property
    /// @version Teamcenter 11.4
    /// @param value - Parameter value
    /// @param isNull - Returns true if the Parameter value is null
    /// @return - Status. 0 if successful
    ///
    int  getFnd0RootTypeName( std::string &value, bool &isNull ) const;

    ///
    /// Getter for Property Display Value
    /// @version Teamcenter 11.6
    /// @param values - Parameter value
    /// @return - Status. 0 if successful
    ///
    int  getFnd0RootTypeNameDisplayableValues( std::vector< std::string > &values );

    ///
    /// Getter for a Boolean Property
    /// @version Teamcenter 11.5
    /// @param value - Parameter Value
    /// @param isNull - Returns true if the Parameter value is null
    /// @return - Status. 0 if successful
    ///
    int  getIs_modifiable( bool &value, bool &isNull ) const;

    ///
    /// Setter for a string Property
    /// @version Teamcenter 11.5
    /// @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  setFnd0DisplayName( const std::string &value, bool isNull=false );
protected:
    //  Method to initialize
    virtual void initialize( ::Teamcenter::RootObjectImpl*  impl );

    /**
     * Constructor
     */
    Fnd0LogicalObjectType();

    /**
     * Destructor
     */
    virtual ~Fnd0LogicalObjectType();

private:
    //  Getter method for the Implementation Object
    Fnd0LogicalObjectTypeImpl*  getFnd0LogicalObjectTypeImpl() const;
    //  Setter method for the Implementation Object
    ::Teamcenter::RootObjectImpl*  setFnd0LogicalObjectTypeImpl( ::Teamcenter::RootObjectImpl*  impl );

    //  Method to set the delete impl boolean
    void setDeleteImpl( bool  del );

    // Pointer to the Implementation object
    Fnd0LogicalObjectTypeImpl*  m_fnd0logicalobjecttypeImpl;

    //  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 Fnd0LogicalObjectType - desc for Fnd0LogicalObjectType parameter
     */
    Fnd0LogicalObjectType( const Fnd0LogicalObjectType& );
    Fnd0LogicalObjectType& operator=( const Fnd0LogicalObjectType& );

    friend class  Fnd0LogicalObjectTypeDelegate;
    friend class  Fnd0LogicalObjectTypeDispatch;
    friend class  Fnd0LogicalObjectTypeGenImpl;
};

#include <tccore/libtccore_undef.h>
#endif //   TEAMCENTER__FND0LOGICALOBJECTTYPE__HXX
