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

#ifndef TEAMCENTER__FOLDER__HXX
#define TEAMCENTER__FOLDER__HXX

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

#include <tc/libtc_exports.h>

namespace Teamcenter
{
    class Folder;
}
namespace Teamcenter
{
    class FolderImpl;
}
namespace Teamcenter
{
    class FolderDelegate;
}
namespace Teamcenter
{
    class FolderDispatch;
}
namespace Teamcenter
{
    class FolderGenImpl;
}
namespace Teamcenter
{
    class RootObjectImpl;
}

class  TC_API  Teamcenter::Folder
     : public  ::Teamcenter::WorkspaceObject
{
public:

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


    ///
    /// Getter for a Tag Array Property
    /// @version Teamcenter 10.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  getContents( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
protected:
    //  Method to initialize
    virtual void initialize( ::Teamcenter::RootObjectImpl*  impl );

    /**
     * Constructor
     */
    Folder();

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

private:
    //  Getter method for the Implementation Object
    FolderImpl*  getFolderImpl() const;
    //  Setter method for the Implementation Object
    ::Teamcenter::RootObjectImpl*  setFolderImpl( ::Teamcenter::RootObjectImpl*  impl );

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

    // Pointer to the Implementation object
    FolderImpl*  m_folderImpl;

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

    friend class  FolderDelegate;
    friend class  FolderDispatch;
    friend class  FolderGenImpl;
};

#include <tc/libtc_undef.h>
#endif //   TEAMCENTER__FOLDER__HXX
