/////////////////////////////////////////////////////////////////////////////// 
// 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 _DAI_INTERFACEDITEM_H_
#define _DAI_INTERFACEDITEM_H_

#include "daiNamedType.h"

#include "TD_PackPush.h"

/** \details 
Implements the Data Access Interface (DAI) that provides functionality for manipulating data that is defined within the EXPRESS SCHEMA format.
*/
namespace OdDAI {

  /** \details
  An abstract class that provides an interfaced entity definition within a schema.
  */
  class DAI_EXPORT InterfacedItem : public DictionaryInstance
  {
    //DOM-IGNORE-BEGIN
    ODRX_DECLARE_MEMBERS(InterfacedItem);
    //DOM-IGNORE-END

  public:

    /** \details
    Gets a foreign schema.
    \returns String containing name of a foreign schema.
    */
    const OdAnsiString& foreignSchema() const;

    /** \details
    Sets a foreign schema.
    \param foreignSchema   [in] Foreign schema to set.
    */
    void setForeignSchema(const OdAnsiString& foreignSchema);

  protected:

    OdAnsiString m_foreignSchema;
  };
  
  /** \details 
  A data type that represents a smart pointer to an <link OdDAI::InterfacedItem, Interfaced Item> object.
  */
  typedef OdSmartPtr<InterfacedItem> InterfacedItemPtr;



  /** \details
  An abstract class that provides an explicit interfaced entity definition within a schema.
  */
  class DAI_EXPORT ExplicitItemId : public InterfacedItem
  {
    //DOM-IGNORE-BEGIN
    ODRX_DECLARE_MEMBERS(ExplicitItemId);
    //DOM-IGNORE-END

  public:

    const NamedTypePtr localDefinition() const;

    void setLocalDefinition(NamedTypePtr localDefinition);

    const OdAnsiString& originalId() const;

    void setOriginalId(const OdAnsiString& originalId);

  protected:


    NamedTypePtr m_localDefinition;

    OdAnsiString m_originalId;
  };
  
  /** \details 
  A data type that represents a smart pointer to an <link OdDAI::ExplicitItemId, Explicit Item> object.
  */
  typedef OdSmartPtr<ExplicitItemId> ExplicitItemIdPtr;



  /** \details
  A class that provides an used interfaced entity definition within a schema.
  */
  class DAI_EXPORT UsedItem : public ExplicitItemId
  {
    //DOM-IGNORE-BEGIN
    ODRX_DECLARE_MEMBERS(UsedItem);
    //DOM-IGNORE-END
  };

  /** \details
  A data type that represents a smart pointer to an <link OdDAI::UsedItem, Used Item> object.
  */
  typedef OdSmartPtr<UsedItem> UsedItemPtr;



  /** \details
  A class that provides an referenced interfaced entity definition within a schema.
  */
  class DAI_EXPORT ReferencedItem : public ExplicitItemId
  {
    //DOM-IGNORE-BEGIN
    ODRX_DECLARE_MEMBERS(ReferencedItem);
    //DOM-IGNORE-END
  };

  /** \details
  A data type that represents a smart pointer to an <link OdDAI::ReferencedItem, Referenced Item> object.
  */
  typedef OdSmartPtr<ReferencedItem> ReferencedItemPtr;



  /** \details
  A class that provides an implicit interfaced entity definition within a schema.
  */
  class DAI_EXPORT ImplicitItemId : public InterfacedItem
  {
    //DOM-IGNORE-BEGIN
    ODRX_DECLARE_MEMBERS(ImplicitItemId);
    //DOM-IGNORE-END
  };

  /** \details
  A data type that represents a smart pointer to an <link OdDAI::ImplicitItemId, Implicit Item> object.
  */
  typedef OdSmartPtr<ImplicitItemId> ImplicitItemIdPtr;

}

#include "TD_PackPop.h"

#endif // _DAI_INTERFACEDITEM_H_