/////////////////////////////////////////////////////////////////////////////// 
// Copyright (C) 2002-2025, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2025 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
///////////////////////////////////////////////////////////////////////////////

#ifndef __TNW_DB_LINK_H__
#define __TNW_DB_LINK_H__

#include "NwObject.h"
#include "RxSystemServices.h"
#include "NwExport.h"
#include "NwDBLinkField.h"

/** Forward declaration of the OdNwName class. */
class OdNwName;

/** \details
  This template class is a specialization of the OdSmartPtr class for
  OdNwName object pointers.
*/
typedef OdSmartPtr<OdNwName> OdNwNamePtr;

/** \details
  This class represents a database link.

  <group OdNw_Classes>
*/
class NWDBEXPORT OdNwDBLink : public OdNwObject
{
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdNwDBLink);
  //DOM-IGNORE-END

public:
  /** \details
    Default constructor. Creates a new object of the OdNwDBLink
    class.
  */
  OdNwDBLink();

public:

  /** \details
    Virtual destructor. Frees allocated resources.
  */
  virtual ~OdNwDBLink();

public:

  /** \details
    Returns the name of an object.

    \returns OdNwNamePtr object with name description.
  */
  OdNwNamePtr getName() const;

  /** \details
    Returns SQL string for this link.

    \returns OdString object with SQL string.
  */
  OdString getSQLString() const;

  /** \details
    Returns connection string for this link.

    \returns OdString object with connection string.
  */
  OdString getConnectionString() const;

  /** \details
    Indicates whether the hold open status.

    \returns The true value if hold open status, or false otherwise.
  */
  bool getHoldOpenStatus() const;

  /** \details
    Indicates whether the link is active.

    \returns The true value if link is active, or false otherwise.
  */
  bool isActive() const;

  /** \details
    Returns an array of fields for this link.

    \returns Array of fields as an OdNwDBLinkFieldArray object.
  */
  OdNwDBLinkFieldArray getFields() const;
};

/** \details
  This template class is a specialization of the OdSmartPtr class for
  OdNwDBLink object pointers.
*/
typedef OdSmartPtr<OdNwDBLink> OdNwDBLinkPtr;

#endif //__TNW_DB_LINK_H__